3 * A general state class
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub 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 BaseState extends BaseHubSystem implements Stateable {
25 // Exception code constants
26 const EXCEPTION_INVALID_STATE = 0xc00;
29 * State name for printing out (except debug output where you want to use
30 * $stateInstance->__toString() instead of this).
32 private $stateName = '';
35 * Protected constructor
37 * @param $className Name of the class
40 protected function __construct ($className) {
41 // Call parent constructor
42 parent::__construct($className);
46 * Getter for state name
48 * @return $stateName Name of this state in a printable maner
50 public final function getStateName () {
51 return $this->stateName;
55 * Setter for state name
57 * @param $stateName Name of this state in a printable maner
60 protected final function setStateName ($stateName) {
61 $this->stateName = $stateName;
65 * Executes the state with given Executor instance
67 * @param $executorInstance An instance of a Executor class
69 * @throws UnsupportedOperationException This method should be overwritten
71 public function executeState (Executor $executorInstance) {
72 throw new UnsupportedOperationException(array($this, __FUNCTION__, $executorInstance), self::EXCEPTION_UNSPPORTED_OPERATION);