Tpyo fixed ... ;-)
[core.git] / inc / classes / main / tasks / idle / class_IdleLoopTask.php
1 <?php
2 /**
3  * A IdleLoop task
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
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.
15  *
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.
20  *
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/>.
23  */
24 class IdleLoopTask extends BaseTask implements Taskable, Visitable {
25         /**
26          * Idle loop time
27          */
28         private $idleTime = 0;
29
30         /**
31          * Protected constructor
32          *
33          * @return      void
34          */
35         protected function __construct () {
36                 // Call parent constructor
37                 parent::__construct(__CLASS__);
38
39                 // Init idle loop time from config ("cache" it here)
40                 $this->idleLoopTime = $this->getConfigInstance()->getConfigEntry('idle_loop_time');
41         }
42
43         /**
44          * Creates an instance of this class
45          *
46          * @return      $taskInstance   An instance of a Taskable/Visitable class
47          */
48         public static final function createIdleLoopTask () {
49                 // Get new instance
50                 $taskInstance = new IdleLoopTask();
51
52                 // Return the prepared instance
53                 return $taskInstance;
54         }
55
56         /**
57          * Accepts the visitor to process the visitor
58          *
59          * @param       $visitorInstance        An instance of a Visitor class
60          * @return      void
61          */
62         public function accept (Visitor $visitorInstance) {
63                 // Visit this task
64                 $visitorInstance->visitTask($this);
65         }
66
67         /**
68          * Executes the task
69          *
70          * @return      void
71          */
72         public function executeTask () {
73                 // Idle here a little
74                 $this->idle($this->idleLoopTime);
75         }
76
77         /**
78          * Shutdown this task, this does nothing here, just supply the method.
79          *
80          * @return      void
81          */
82         public function doShutdown () {
83                 // Debug message
84                 self::createDebugInstance(__CLASS__)->debugOutput('TASK[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down...');
85         }
86 }
87
88 // [EOF]
89 ?>