More renamed

[shipsimu.git] / application / ship-simu / main / structures / extended / class_BaseUpperStructure.php

diff --git a/application/ship-simu/main/structures/extended/class_BaseUpperStructure.php b/application/ship-simu/main/structures/extended/class_BaseUpperStructure.php
index 06bdf308ce6d55c09e3e3aed1bd28ba8b1f07b02..dd6934cf8bc78aed50eed0e993c6e9384840d74b 100644 (file)
--- a/application/ship-simu/main/structures/extended/class_BaseUpperStructure.php
+++ b/application/ship-simu/main/structures/extended/class_BaseUpperStructure.php
@@ -1,74 +1,35 @@
 <?php
-// Super structures (renamed to UpperStructure to avoid mixing it with super classes
+/**
+ * A general upper structure class.
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.shipsimu.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 BaseUpperStructure extends BaseStructure {
        /**
         * Constructor for all super structures on a ship
+        *
+        * @return      void
         */
-       private function __construct ($class) {
-               // Eltern-Konstruktor aufrufen
-               parent::constructor($class);
-
-               // Debug message
-               if (((defined('DEBUG_STRUCTURE')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) {
-                       $this->getDebugInstance()->output(sprintf("[%s:%d] Konstruktor erreicht.<br />\n",
-                               __CLASS__,
-                               __LINE__
-                       ));
-               }
-
-               // Beschreibung setzen
-               $this->setPartDescr("Aufbauten");
-
-               // Shall we clean up?
-               if ($class == __CLASS__) {
-                       $this->removeSystemArray();
-               }
-       }
-
-       /**
-        * Call new constructor
-        */
-       function constructor ($class) {
-               $this->__construct($class);
-       }
-
-       /**
-        * Creates an upper(=super) structure
-        */
-       public static function createBaseUpperStructure () {
-               // Instanz holen
-               $upperInstance = new BaseUpperStructure (__CLASS__);
-
-               // Debug message
-               if ((defined('DEBUG_STRUCTURE')) || (defined('DEBUG_ALL'))) {
-                       $upperInstance->getDebugInstance()->output(sprintf("[%s:%d] Aufbauten wird konstruiert.<br />\n",
-                               __CLASS__,
-                               __LINE__
-                       ));
-               }
-
-               // Unique-ID setzen
-               $upperInstance->createUniqueID();
-
-               // Return instance
-               return $upperInstance;
-       }
-
-       /**
-        * Stub!
-        */
-       public function saveObjectToDatabase () {
-               $this->getDebugInstance()->output(sprintf("[%s:] Stub <strong>%s</strong> erreicht.",
-                       $this->__toString(),
-                       __FUNCTION__
-               ));
-       }
-
-       /**
-        * Limits this object with an ObjectLimits instance
-        */
-       public function limitObject (ObjectLimits $limitInstance) {
-               ApplicationEntryPoint::app_die("".__METHOD__." reached! Stub!");
+       protected function __construct ($className) {
+               // Call parent constructor
+               parent::__construct($className);
        }
 }