3 * A general cruncher state class
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2011 - 2014 Cruncher Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class BaseCruncherState extends BaseState {
26 * Protected constructor
28 * @param $className Name of the class
31 protected function __construct ($className) {
32 // Call parent constructor
33 parent::__construct($className);
37 * Validates whether the state is 'active' or throws an exception if
38 * it is every other state.
41 * @throws InvalidStateException If the state is not 'active'
43 public function validateCruncherStateIsActive () {
45 if (!$this instanceof CruncherActiveState) {
46 // Throw the exception
47 throw new InvalidStateException($this, self::EXCEPTION_INVALID_STATE);
52 * Checks if this state is 'virgin'
54 * @return $isVirgin Whether this state is 'virgin'
56 public function isCruncherStateVirgin () {
58 return ($this instanceof CruncherVirginState);