3 namespace Org\Mxchange\City\Generic;
5 // Import application-specific stuff
6 use Org\Mxchange\City\Helper\CityHelper;
8 // Import framework stuff
9 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
12 * A general city (simulation) system class
14 * @author Roland Haeder <webmaster@shipsimu.org>
16 * @copyright Copyright (c) 2015 - 2023 City Developer Team
17 * @license GNU GPL 3.0 or any newer version
18 * @link http://www.shipsimu.org
20 * This program is free software: you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation, either version 3 of the License, or
23 * (at your option) any later version.
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
30 * You should have received a copy of the GNU General Public License
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 abstract class BaseCitySystem extends BaseFrameworkSystem {
35 const EXCEPTION_UNSUPPORTED_ERROR_HANDLER = 0x900;
36 const EXCEPTION_BASE64_ENCODING_NOT_MODULO_4 = 0x901;
38 // Message status codes
39 const MESSAGE_STATUS_CODE_OKAY = 'OKAY';
42 * An instance of a city
44 private $cityInstance = NULL;
47 * Protected constructor
49 * @param $className Name of the class
52 protected function __construct (string $className) {
53 // Call parent constructor
54 parent::__construct($className);
58 * Getter for city instance
60 * @return $cityInstance An instance of a city city
62 public final function getCityInstance () {
63 return $this->cityInstance;
67 * Setter for city instance
69 * @param $cityInstance An instance of a city city
72 protected final function setCityInstance (CityHelper $cityInstance) {
73 $this->cityInstance = $cityInstance;