code comments including license information added, type hints added, minor rewrites...
[shipsimu.git] / application / ship-simu / main / constructions / class_BaseConstruction.php
1 <?php
2 /**
3  * A general construction (land) class
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 BaseConstruction extends BaseSimulator {
25         // Tiefgang fuer z.B. Trockdocks
26         private $draught = 0;
27
28         // Konstruktor
29         private function __construct ($class) {
30                 // Eltern-Konstrutor aufrufen
31                 parent::constructor($class);
32
33                 // Debug message
34                 if ((defined('DEBUG_CORE')) && (defined('DEBUG_CONSTRUCT'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruktor erreicht.<br />\n",
35                         $this->__toString()
36                 ));
37
38                 // Set description
39                 $this->setPartDescr("Namenlose Landkonstruktion");
40
41                 // Clean up a little
42                 $this->removeNumberFormaters();
43         }
44
45         /**
46          * Calls the private constructor
47          *
48          * @param       $class  The class' name
49          * @return      void
50          */
51         public function constructor ($class) {
52                 $this->__construct($class);
53         }
54
55         // Tiefgang entfernen
56         public function removeDraught () {
57                 if (defined('DEBUG_CORE')) $this->getDebugInstance()->output(sprintf("[%s:] Tiefgang wird entfernt.<br />\n",
58                         $this->__toString()
59                 ));
60                 unset($this->draught);
61         }
62 }
63
64 // [EOF]
65 ?>