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
  24 #include <boost/call_traits.hpp>
  25 #include <boost/shared_ptr.hpp>
  26 #include <boost/weak_ptr.hpp>
  27
  28
  29 namespace simgear
  30 {
  31
  32   class PropertyBasedElement;
  33   typedef boost::shared_ptr<PropertyBasedElement> PropertyBasedElementPtr;
  34   typedef boost::weak_ptr<PropertyBasedElement> PropertyBasedElementWeakPtr;
  35
  36   /**
  37    * Base class for a property controlled element
  38    */
  39   class PropertyBasedElement:
  40     public SGPropertyChangeListener
  41   {
  42     public:
  43       PropertyBasedElement(SGPropertyNode* node);
  44       virtual ~PropertyBasedElement();
  45
  46       /**
  47        * Remove the property listener of the element.
  48        *
  49        * You will need to call the appropriate methods (#childAdded,
  50        * #childRemoved, #valueChanged) yourself to ensure the element still
  51        * receives the needed events.
  52        */
  53       void removeListener();
  54
  55       /**
  56        * Destroys this element (removes node from property tree)
  57        */
  58       void destroy();
  59
  60       virtual void update(double delta_time_sec) = 0;
  61
  62       SGConstPropertyNode_ptr getProps() const;
  63       SGPropertyNode_ptr getProps();
  64
  65       template<class T>
  66       void set( const std::string& name,
  67                 typename boost::call_traits<T>::param_type val )
  68       {
  69         setValue(_node->getNode(name, true), val);
  70       }
  71
  72       template<class T>
  73       T get( const std::string& name,
  74              typename boost::call_traits<T>::param_type def = T() )
  75       {
  76         SGPropertyNode const* child = _node->getNode(name);
  77         if( !child )
  78           return def;
  79
  80         return getValue<T>(child);
  81       }
  82
  83       virtual void setSelf(const PropertyBasedElementPtr& self);
  84       virtual void onDestroy() {};
  85
  86     protected:
  87
  88       SGPropertyNode_ptr _node;
  89       PropertyBasedElementWeakPtr _self;
  90   };
  91
  92 } // namespace simgear
  93
  94 #endif /* SG_PROPERTY_BASED_ELEMENT_HXX_ */