<?php
// Own namespace
namespace Org\Mxchange\City\Daemon\Simulation;

// Import application-specific stuff
use Org\Mxchange\City\Daemon\BaseCityDaemon;
use Org\Mxchange\City\Helper\CityHelper;

// Import framework stuff
use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
use Org\Mxchange\CoreFramework\Handler\Task\HandleableTask;
use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
use Org\Mxchange\CoreFramework\Registry\Registerable;
use Org\Mxchange\CoreFramework\Request\Requestable;

/**
 * The default city daemon
 *
 * @author		Roland Haeder <webmaster@shipsimu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2015, 2016 City Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.shipsimu.org
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
class SimulationDefaultCityDaemon extends BaseCityDaemon implements CityHelper, Registerable {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Creates an instance of this hub-node class
	 *
	 * @return	$nodeInstance		An instance of this hub-node class
	 */
	public static final function createSimulationDefaultCityDaemon () {
		// Get a new instance
		$nodeInstance = new SimulationDefaultCityDaemon();

		// Return the instance
		return $nodeInstance;
	}

	/**
	 * Method to "bootstrap" the city simulation. This step does also apply
	 * provided command-line arguments stored in the request instance.
	 *
	 * @return	void
	 * @todo	Implement this method
	 */
	public function doBootstrapping () {
		$this->partialStub();
	}

	/**
	 * Add some node-specific filters
	 *
	 * @return	void
	 */
	public function addExtraCityFilters () {
		// Get the application instance from registry
		$applicationInstance = GenericRegistry::getRegistry()->getInstance('application');

		// Get the controller from the application
		$controllerInstance = $applicationInstance->getControllerInstance();

		// Foo task
		// @TODO $controllerInstance->addActivationFilter(ObjectFactory::createObjectByConfiguredName('city_foo_task_filter'));

		// @TODO Add some filters here
		$this->partialStub('Add some filters here.');
	}

	/**
	 * Adds extra tasks to the given handler for this node
	 *
	 * @param	$handlerInstance	An instance of a HandleableTask class
	 * @return	void
	 * @todo	0% done
	 */
	public function addExtraTasks (HandleableTask $handlerInstance) {
		$this->partialStub('Please add some tasks or empty this method.');
	}
}