fly/flightgear
1
0
Fork 0
Code Activity

Some code documentation added to the A/P flip flop implementation

Browse source
This commit is contained in:
Torsten Dreyer 2010-06-25 11:06:00 +02:00
parent d558b52cb6
commit 47c956b516
3 changed files with 117 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/Autopilot/component.hxx
View file

@ -58,7 +58,7 @@ protected:
/**
* @brief pure virtual function to be implemented by the derived classes. Gets called from
* the update method if it's not disabled with the firstTime parameter set to true it this
* the update method if it's not disabled with the firstTime parameter set to true if this
* is the first call after being enabled
* @param firstTime set to true if this is the first update call since this component has
been enabled. Set to false for every subsequent call.

82
src/Autopilot/flipflop.cxx
View file

@ -26,6 +26,30 @@
using namespace FGXMLAutopilot;
/**
* @brief Flip flop implementation for a RS flip flop with dominant RESET
*
* <table>
* <tr>
* <td colspan="3">Logictable</td>
* </tr>
* <tr>
* <td>S</td><td>R</td><td>Q</td>
* </tr>
* <tr>
* <td>false</td><td>false</td><td>unchanged</td>
* </tr>
* <tr>
* <td>false</td><td>true</td><td>false</td>
* </tr>
* <tr>
* <td>true</td><td>false</td><td>true</td>
* </tr>
* <tr>
* <td>true</td><td>true</td><td>false</td>
* </tr>
* </table>
*/
class RSFlipFlopImplementation : public FlipFlopImplementation {
protected:
bool _rIsDominant;
@ -34,17 +58,73 @@ public:
virtual bool getState( double dt, DigitalComponent::InputMap input, bool & q );
};
/**
* @brief Flip flop implementation for a RS flip flop with dominant SET
*
* <table>
* <tr>
* <td colspan="3">Logictable</td>
* </tr>
* <tr>
* <td>S</td><td>R</td><td>Q</td>
* </tr>
* <tr>
* <td>false</td><td>false</td><td>unchanged</td>
* </tr>
* <tr>
* <td>false</td><td>true</td><td>false</td>
* </tr>
* <tr>
* <td>true</td><td>false</td><td>true</td>
* </tr>
* <tr>
* <td>true</td><td>true</td><td>true</td>
* </tr>
* </table>
*/
class SRFlipFlopImplementation : public RSFlipFlopImplementation {
public:
SRFlipFlopImplementation() : RSFlipFlopImplementation( false ) {}
};
/**
* @brief Base class for clocked flip flop implementation
*
* A clocked flip flop computes it's output on the raising edge (false/true transition)
* of the clock input. If such a transition is detected, the onRaisingEdge method is called
* by this implementation
*/
class ClockedFlipFlopImplementation : public RSFlipFlopImplementation {
protected:
private:
/**
* @brief the previous state of the clock input
*/
bool _clock;
protected:
/**
* @brief pure virtual function to be implemented from the implementing class, gets called
* from the update method if the raising edge of the clock input was detected.
* @param input a map of named input lines
* @param q a reference to a boolean variable to receive the output state
* @return true if the state has changed, false otherwise
*/
virtual bool onRaisingEdge( DigitalComponent::InputMap input, bool & q ) = 0;
public:
/**
* @brief constructor for a ClockedFlipFlopImplementation
* @param rIsDominant boolean flag to signal if RESET shall be dominant (true) or SET shall be dominant (false)
*/
ClockedFlipFlopImplementation( bool rIsDominant = true ) : RSFlipFlopImplementation( rIsDominant ), _clock(false) {}
/**
* @brief evaluates the output state from the input lines, basically waits for a raising edge and calls onRaisingEdge
* @param dt the elapsed time in seconds from since the last call
* @param input a map of named input lines
* @param q a reference to a boolean variable to receive the output state
* @return true if the state has changed, false otherwise
*/
virtual bool getState( double dt, DigitalComponent::InputMap input, bool & q );
};

36
src/Autopilot/flipflop.hxx
View file

@ -25,11 +25,33 @@
namespace FGXMLAutopilot {
/**
* @brief Interface for a flip flop implementation. Can be configured from a property node and
* returns a state depending on input lines.
*/
class FlipFlopImplementation : public SGReferenced {
protected:
virtual bool configure( const std::string & nodeName, SGPropertyNode_ptr configNode ) { return false; }
/**
* @brief configure this component from a property node. Iterates through all nodes found
* as childs under configNode and calls configure of the derived class for each child.
* @param configNode the property node containing the configuration
*/
virtual bool configure( const std::string & nodeName, SGPropertyNode_ptr configNode ) { return false; }
public:
/**
* @brief evaluates the output state from the input lines
* @param dt the elapsed time in seconds from since the last call
* @param input a map of named input lines
* @param q a reference to a boolean variable to receive the output state
* @return true if the state has changed, false otherwise
*/
virtual bool getState( double dt, DigitalComponent::InputMap input, bool & q ) { return false; }
/**
* @brief configure this component from a property node. Iterates through all nodes found
* as childs under configNode and calls configure of the derived class for each child.
* @param configNode the property node containing the configuration
*/
bool configure( SGPropertyNode_ptr configNode );
};
@ -47,9 +69,21 @@ protected:
* @return true if the node was handled, false otherwise.
*/
virtual bool configure( const std::string & nodeName, SGPropertyNode_ptr configNode );
/**
* @brief Implementation of the pure virtual function of the Component class. Gets called from
* the update method if it's not disabled with the firstTime parameter set to true if this
* is the first call after being enabled
* @param firstTime set to true if this is the first update call since this component has
been enabled. Set to false for every subsequent call.
* @param dt the elapsed time since the last call
*/
void update( bool firstTime, double dt );
private:
/**
* @brief Pointer to the actual flip flop implementation
*/
SGSharedPtr<FlipFlopImplementation> _implementation;
};