1 // flipflop.hxx - implementation of multiple flip flop types
3 // Written by Torsten Dreyer
5 // Copyright (C) 2010 Torsten Dreyer - Torsten (at) t3r (dot) de
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 #ifndef __FLIPFLOPCOMPONENT_HXX
22 #define __FLIPFLOPCOMPONENT_HXX 1
26 namespace FGXMLAutopilot {
29 * @brief Interface for a flip flop implementation. Can be configured from a property node and
30 * returns a state depending on input lines.
32 class FlipFlopImplementation : public SGReferenced {
35 * @brief configure this component from a property node. Iterates through all nodes found
36 * as childs under configNode and calls configure of the derived class for each child.
37 * @param configNode the property node containing the configuration
39 virtual bool configure( const std::string & nodeName, SGPropertyNode_ptr configNode ) { return false; }
41 virtual ~FlipFlopImplementation() {}
43 * @brief evaluates the output state from the input lines
44 * @param dt the elapsed time in seconds from since the last call
45 * @param input a map of named input lines
46 * @param q a reference to a boolean variable to receive the output state
47 * @return true if the state has changed, false otherwise
49 virtual bool getState( double dt, DigitalComponent::InputMap input, bool & q ) { return false; }
52 * @brief configure this component from a property node. Iterates through all nodes found
53 * as childs under configNode and calls configure of the derived class for each child.
54 * @param configNode the property node containing the configuration
56 bool configure( SGPropertyNode_ptr configNode );
60 * @brief A simple flipflop implementation
62 class FlipFlop : public Logic {
66 * @brief Over-rideable hook method to allow derived classes to refine top-level
70 * @return true if the node was handled, false otherwise.
72 virtual bool configure( const std::string & nodeName, SGPropertyNode_ptr configNode );
75 * @brief Implementation of the pure virtual function of the Component class. Gets called from
76 * the update method if it's not disabled with the firstTime parameter set to true if this
77 * is the first call after being enabled
78 * @param firstTime set to true if this is the first update call since this component has
79 been enabled. Set to false for every subsequent call.
80 * @param dt the elapsed time since the last call
82 void update( bool firstTime, double dt );
86 * @brief Pointer to the actual flip flop implementation
88 SGSharedPtr<FlipFlopImplementation> _implementation;
93 #endif // FLIPFLOPCOMPONENT_HXX