final added, code clean-ups

[shipsimu.git] / application / ship-simu / main / drives / class_BaseDrive.php

diff --git a/application/ship-simu/main/drives/class_BaseDrive.php b/application/ship-simu/main/drives/class_BaseDrive.php
index bda42a41f6f2cb31bdd7c5b4b67a1db101fdcb8c..a8ed3381a7ed24108c2dade300bd3b1ec54ee567 100644 (file)
--- a/application/ship-simu/main/drives/class_BaseDrive.php
+++ b/application/ship-simu/main/drives/class_BaseDrive.php
@@ -1,6 +1,26 @@
 <?php
-
-// Die abstrakte Antrieb-Klasse
+/**
+ * A general drive class for all kind of "drives".
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.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 BaseDrive extends BaseSimulator {
        // Price of this drive
        private $price      = 0.00;
@@ -25,18 +45,23 @@ class BaseDrive extends BaseSimulator {
                // Set description
                $this->setPartDescr("Namenloser Antrieb");
 
-               // Etwas aufraeumen
+               // Clean up a little
                $this->removeNumberFormaters();
                $this->removePartInstance();
        }
 
-       // Konstruktor aufrufen
+       /**
+        * Calls the private constructor
+        *
+        * @param       $class  The class' name
+        * @return      void
+        */
        public function constructor ($class) {
                $this->__construct($class);
        }
 
        // Setter-Methode fuert PS-Zahl
-       public function setHorsePower ($hp) {
+       public final function setHorsePower ($hp) {
                if ((defined('DEBUG_DRIVE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Antriebsleistung wird auf <strong>%d</strong> PS gesetzt.<br />\n",
                        __CLASS__,
                        __LINE__,
@@ -46,7 +71,7 @@ class BaseDrive extends BaseSimulator {
        }
 
        // Setter-Methode fuer Nockenanzahl
-       public function setNumCams ($cams) {
+       public final function setNumCams ($cams) {
                if ((defined('DEBUG_DRIVE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Nockenanzahl wird auf <strong>%d</strong> Nocken gesetzt.<br />\n",
                        __CLASS__,
                        __LINE__,
@@ -56,16 +81,16 @@ class BaseDrive extends BaseSimulator {
        }
 
        // Setter for price
-       public function setPrice ($price) {
+       public final function setPrice ($price) {
                $this->price = (float) $price;
        }
 
        // Getter for price
-       public function getPrice () {
+       public final function getPrice () {
                return $this->price;
        }
 
-       public function removePrice () {
+       public final function removePrice () {
                unset($this->price);
        }
 }