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/shared_ptr.hpp>
  25 #include <boost/weak_ptr.hpp>
  26
  27
  28 namespace simgear
  29 {
  30
  31   class PropertyBasedElement;
  32   typedef boost::shared_ptr<PropertyBasedElement> PropertyBasedElementPtr;
  33   typedef boost::weak_ptr<PropertyBasedElement> PropertyBasedElementWeakPtr;
  34
  35   /**
  36    * Base class for a property controlled element
  37    */
  38   class PropertyBasedElement:
  39     public SGPropertyChangeListener
  40   {
  41     public:
  42       PropertyBasedElement(SGPropertyNode* node);
  43       virtual ~PropertyBasedElement();
  44
  45       virtual void update(double delta_time_sec) = 0;
  46
  47       SGConstPropertyNode_ptr getProps() const;
  48       SGPropertyNode_ptr getProps();
  49
  50       virtual void setSelf(const PropertyBasedElementPtr& self);
  51
  52     protected:
  53
  54       SGPropertyNode_ptr _node;
  55       PropertyBasedElementWeakPtr _self;
  56   };
  57
  58 } // namespace simgear
  59
  60 #endif /* SG_PROPERTY_BASED_ELEMENT_HXX_ */