src/Autopilot/digitalcomponent.hxx

   1 // digitalcomponent.hxx - Base class for digital autopilot components
   2 //
   3 // Written by Torsten Dreyer
   4 // Based heavily on work created by Curtis Olson, started January 2004.
   5 //
   6 // Copyright (C) 2004  Curtis L. Olson  - http://www.flightgear.org/~curt
   7 // Copyright (C) 2010  Torsten Dreyer - Torsten (at) t3r (dot) de
   8 //
   9 // This program is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU General Public License as
  11 // published by the Free Software Foundation; either version 2 of the
  12 // License, or (at your option) any later version.
  13 //
  14 // This program is distributed in the hope that it will be useful, but
  15 // WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 // General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU General Public License
  20 // along with this program; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  22 //
  23 #ifndef __DIGITALCOMPONENT_HXX
  24 #define __DIGITALCOMPONENT_HXX 1
  25
  26 #include "component.hxx"
  27
  28 #include <simgear/props/props.hxx>
  29 #include <simgear/props/condition.hxx>
  30
  31 namespace FGXMLAutopilot {
  32
  33 /**
  34  * @brief Models a digital output bound to a property. May be an inverted output.
  35  */
  36 class DigitalOutput : public SGReferenced {
  37
  38 private:
  39   bool _inverted;
  40   SGPropertyNode_ptr _node;
  41
  42 protected:
  43
  44 public:
  45   /**
  46    * @brief Constructs an empty, noninverting output
  47    */
  48   DigitalOutput();
  49
  50   inline void setProperty( SGPropertyNode_ptr node );
  51
  52   inline void setInverted( bool value ) { _inverted = value; }
  53   inline bool isInverted() const { return _inverted; }
  54
  55   bool getValue() const;
  56   void setValue( bool value );
  57 };
  58
  59 inline DigitalOutput::DigitalOutput() : _inverted(false)
  60 {
  61 }
  62
  63 inline void DigitalOutput::setProperty( SGPropertyNode_ptr node )
  64 {
  65   _node = node;
  66   _node->setBoolValue( node->getBoolValue() );
  67 }
  68
  69 inline bool DigitalOutput::getValue() const
  70 {
  71   if( _node == NULL ) return false;
  72   bool nodeState = _node->getBoolValue();
  73   return _inverted ? !nodeState : nodeState;
  74 }
  75
  76 inline void DigitalOutput::setValue( bool value )
  77 {
  78   if( _node == NULL ) return;
  79   _node->setBoolValue( _inverted ? !value : value );
  80 }
  81
  82 typedef SGSharedPtr<DigitalOutput> DigitalOutput_ptr;
  83
  84 /**
  85  * @brief Base class for digital autopilot components
  86  *
  87  * Each digital component has (at least)
  88  * <ul>
  89  *   <li>one value input</li>
  90  *   <li>any number of output properties</li>
  91  * </ul>
  92  */
  93 class DigitalComponent : public Component {
  94 public:
  95     DigitalComponent();
  96
  97     class InputMap : public std::map<const std::string,SGSharedPtr<const SGCondition> > {
  98       public:
  99         bool get_value( const std::string & name ) const;
 100     };
 101
 102
 103 //    typedef std::map<const std::string,SGSharedPtr<const SGCondition> > InputMap;
 104     typedef std::map<const std::string,DigitalOutput_ptr> OutputMap;
 105 protected:
 106
 107     /**
 108      * @brief Named input "pins"
 109      */
 110     InputMap _input;
 111
 112     /**
 113      * @brief Named output "pins"
 114      */
 115     OutputMap _output;
 116
 117     /**
 118      * @brief Global "inverted" flag for the outputs
 119      */
 120     bool _inverted;
 121
 122     /**
 123      * @brief Over-rideable hook method to allow derived classes to refine top-level
 124      * node parsing.
 125      * @param aName
 126      * @param aNode
 127      * @return true if the node was handled, false otherwise.
 128      */
 129     virtual bool configure( const std::string & nodeName, SGPropertyNode_ptr configNode );
 130 };
 131
 132 }
 133 #endif // DIGITALCOMPONENT_HXX
 134