simgear/props/PropertyBasedElement.hxx

   1 // Base class for elements of property controlled subsystems
   2 //
   3 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
   4 //
   5 // This library is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU Library General Public
   7 // License as published by the Free Software Foundation; either
   8 // version 2 of the License, or (at your option) any later version.
   9 //
  10 // This library is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // Library General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU Library General Public
  16 // License along with this library; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  18
  19 #ifndef SG_PROPERTY_BASED_ELEMENT_HXX_
  20 #define SG_PROPERTY_BASED_ELEMENT_HXX_
  21
  22 #include <simgear/props/props.hxx>
  23 #include <simgear/structure/SGWeakReferenced.hxx>
  24
  25 namespace simgear
  26 {
  27
  28   /**
  29    * Base class for a property controlled element
  30    */
  31   class PropertyBasedElement:
  32     public SGPropertyChangeListener,
  33     public SGWeakReferenced
  34   {
  35     public:
  36       PropertyBasedElement(SGPropertyNode* node);
  37       virtual ~PropertyBasedElement();
  38
  39       /**
  40        * Remove the property listener of the element.
  41        *
  42        * You will need to call the appropriate methods (#childAdded,
  43        * #childRemoved, #valueChanged) yourself to ensure the element still
  44        * receives the needed events.
  45        */
  46       void removeListener();
  47
  48       /**
  49        * Destroys this element (removes node from property tree)
  50        */
  51       void destroy();
  52
  53       virtual void update(double delta_time_sec) = 0;
  54
  55       SGConstPropertyNode_ptr getProps() const;
  56       SGPropertyNode_ptr getProps();
  57
  58       template<class T>
  59       void set( const std::string& name,
  60                 const T& val )
  61       {
  62         setValue(_node->getNode(name, true), val);
  63       }
  64
  65       template<class T>
  66       T get( const std::string& name,
  67              const T& def = T() )
  68       {
  69         SGPropertyNode const* child = _node->getNode(name);
  70         if( !child )
  71           return def;
  72
  73         return getValue<T>(child);
  74       }
  75
  76       // Unshadow what we have just hidden...
  77       using SGWeakReferenced::get;
  78
  79       virtual void onDestroy() {};
  80
  81     protected:
  82
  83       SGPropertyNode_ptr _node;
  84
  85   };
  86
  87   typedef SGSharedPtr<PropertyBasedElement> PropertyBasedElementPtr;
  88   typedef SGWeakPtr<PropertyBasedElement> PropertyBasedElementWeakPtr;
  89
  90 } // namespace simgear
  91
  92 #endif /* SG_PROPERTY_BASED_ELEMENT_HXX_ */