code comments including license information added, type hints added, minor rewrites...
[shipsimu.git] / application / ship-simu / main / drives / class_BaseDrive.php
1 <?php
2 /**
3  * A general drive class for all kind of "drives".
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.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 BaseDrive extends BaseSimulator {
25         // Price of this drive
26         private $price      = 0.00;
27         // PS-Zahl
28         private $horsePower = 0;
29         // Anzahl Nocken
30         private $numCams    = 0;
31
32         // Konstruktor
33         private function __construct ($class) {
34                 // Call parent constructor
35                 parent::constructor($class);
36
37                 // Debug message
38                 if (((defined('DEBUG_DRIVE')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) {
39                         $this->getDebugInstance()->output(sprintf("[%s:%d] Konstruktor erreicht.<br />\n",
40                                 __CLASS__,
41                                 __LINE__
42                         ));
43                 }
44
45                 // Set description
46                 $this->setPartDescr("Namenloser Antrieb");
47
48                 // Clean up a little
49                 $this->removeNumberFormaters();
50                 $this->removePartInstance();
51         }
52
53         /**
54          * Calls the private constructor
55          *
56          * @param       $class  The class' name
57          * @return      void
58          */
59         public function constructor ($class) {
60                 $this->__construct($class);
61         }
62
63         // Setter-Methode fuert PS-Zahl
64         public final function setHorsePower ($hp) {
65                 if ((defined('DEBUG_DRIVE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Antriebsleistung wird auf <strong>%d</strong> PS gesetzt.<br />\n",
66                         __CLASS__,
67                         __LINE__,
68                         $hp
69                 ));
70                 $this->horsePower = (int) $hp;
71         }
72
73         // Setter-Methode fuer Nockenanzahl
74         public final function setNumCams ($cams) {
75                 if ((defined('DEBUG_DRIVE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Nockenanzahl wird auf <strong>%d</strong> Nocken gesetzt.<br />\n",
76                         __CLASS__,
77                         __LINE__,
78                         $cams
79                 ));
80                 $this->numCams = (int) $cams;
81         }
82
83         // Setter for price
84         public final function setPrice ($price) {
85                 $this->price = (float) $price;
86         }
87
88         // Getter for price
89         public final function getPrice () {
90                 return $this->price;
91         }
92
93         public function removePrice () {
94                 unset($this->price);
95         }
96 }
97
98 // [EOF]
99 ?>