FlightGear next
StateMachineComponent Class Reference

Inherits FGXMLAutopilot::Component.

Public Member Functions

 StateMachineComponent (SGPropertyNode &props_root, SGPropertyNode &cfg)
 
virtual bool configure (const std::string &nodeName, SGPropertyNode_ptr config)
 
virtual void update (bool firstTime, double dt)
 pure virtual function to be implemented by the derived classes.
 
- Public Member Functions inherited from FGXMLAutopilot::Component
 Component ()
 A constructor for an empty Component.
 
virtual ~Component ()
 virtual destructor to clean up resources
 
void update (double dt) override
 
virtual bool configure (SGPropertyNode &prop_root, SGPropertyNode &cfg)
 configure this component from a property node.
 
bool isPropertyEnabled ()
 check if this component is enabled as configured in the <enable> section
 

Static Public Member Functions

static const char * staticSubsystemClassId ()
 

Additional Inherited Members

- Protected Member Functions inherited from FGXMLAutopilot::Component
virtual bool configure (SGPropertyNode &cfg_node, const std::string &cfg_name, SGPropertyNode &prop_root)
 
virtual void disabled (double dt)
 overideable method being called from the update() method if this component is disabled.
 
- Protected Attributes inherited from FGXMLAutopilot::Component
bool _debug
 debug flag, true if this component should generate some useful output on every iteration
 
bool _honor_passive
 a (historic) flag signalling the derived class that it should compute it's internal state but shall not set the output properties if /autopilot/locks/passive-mode is true.
 

Detailed Description

Definition at line 49 of file autopilot.cxx.

Constructor & Destructor Documentation

◆ StateMachineComponent()

StateMachineComponent::StateMachineComponent ( SGPropertyNode & props_root,
SGPropertyNode & cfg )
inline

Definition at line 52 of file autopilot.cxx.

Member Function Documentation

◆ configure()

virtual bool StateMachineComponent::configure ( const std::string & nodeName,
SGPropertyNode_ptr config )
inlinevirtual

Definition at line 60 of file autopilot.cxx.

◆ staticSubsystemClassId()

static const char * StateMachineComponent::staticSubsystemClassId ( )
inlinestatic

Definition at line 58 of file autopilot.cxx.

◆ update()

virtual void StateMachineComponent::update ( bool firstTime,
double dt )
inlinevirtual

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 if this is the first call after being enabled

Parameters
firstTimeset to true if this is the first update call since this component has been enabled. Set to false for every subsequent call.
dtthe elapsed time since the last call

Implements FGXMLAutopilot::Component.

Definition at line 64 of file autopilot.cxx.


The documentation for this class was generated from the following file: