Updated 'core'.
[hub.git] / application / hub / main / producer / miner / blocks / class_MinerRealGenesisBlockProducer.php
1 <?php
2 /**
3  * A MinerRealGenesisBlock producer class
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
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
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 MinerRealGenesisBlockProducer extends BaseBlockProducer implements BlockProducer, Registerable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this class
37          *
38          * @return      $producerInstance       An instance of a Producer class
39          */
40         public final static function createMinerRealGenesisBlockProducer () {
41                 // Get new instance
42                 $producerInstance = new MinerRealGenesisBlockProducer();
43
44                 // Get a (minable) hash block instance
45                 $minableInstance = ObjectFactory::createObjectByConfiguredName('miner_real_hash_block_class');
46
47                 // Set it here
48                 $producerInstance->setMinableInstance($minableInstance);
49
50                 // Return the prepared instance
51                 return $producerInstance;
52         }
53
54         /**
55          * Initializes the producer. This method satisfies the abstract BaseProducer
56          * class.
57          *
58          * @return      void
59          * @todo        0% done
60          */
61         protected function initProducer () {
62                 $this->partialStub('Please implement this method.');
63         }
64
65         /**
66          * Initializes the executor, whatever it does.
67          *
68          * @return      void
69          * @todo        0% done
70          */
71         public function initExecutor (Stateable $stateInstance) {
72                 $this->partialStub('Please implement this method.');
73         }
74
75         /**
76          * Prepares the produces of some test units and pushes them onto the queue
77          *
78          * @param       $stateInstance  An instance of a Stateable instance
79          * @return      void
80          * @todo        ~5% done
81          */
82         public function prepareBlockProduction (Stateable $stateInstance) {
83                 // The state must be 'booting'
84                 $stateInstance->validateMinerStateIsBooting();
85
86                 /*
87                  * Now that the miner is booting a genesis block for real mining can be
88                  * created.
89                  */
90         }
91 }
92
93 // [EOF]
94 ?>