FGXMLAutopilot::DigitalFilter Class Reference

brief@ DigitalFilter - a selection of digital filters More...

#include <digitalfilter.hxx>

Inherits FGXMLAutopilot::AnalogComponent.

Public Member Functions
	DigitalFilter ()
	~DigitalFilter ()
virtual bool	configure (SGPropertyNode &prop_root, SGPropertyNode &cfg)
	configure this component from a property node.
Public Member Functions inherited from FGXMLAutopilot::AnalogComponent
const simgear::PeriodicalValue_ptr	getPeriodicalValue () const
void	collectDependentProperties (std::set< const SGPropertyNode * > &props) const
	Add to <props> all properties that are used by this component.
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
bool	isPropertyEnabled ()
	check if this component is enabled as configured in the <enable> section

Static Public Member Functions
static const char *	staticSubsystemClassId ()

Protected Member Functions
bool	configure (SGPropertyNode &cfg_node, const std::string &cfg_name, SGPropertyNode &prop_root) override
	This method configures this analog component from a property node.
void	update (bool firstTime, double dt) override
	pure virtual function to be implemented by the derived classes.
Protected Member Functions inherited from FGXMLAutopilot::AnalogComponent
	AnalogComponent ()
	A constructor for an analog component.
double	clamp (double value) const
	clamp the given value if <min> and/or <max> inputs were given
void	disabled (double dt) override
	overideable method being called from the update() method if this component is disabled.
double	get_output_value () const
	return the current double value of the output property
void	set_output_value (double value)

Protected Attributes
InitializeTo	_initializeTo = INITIALIZE_INPUT
Protected Attributes inherited from FGXMLAutopilot::AnalogComponent
simgear::ValueList	_valueInput
	the value input
simgear::ValueList	_referenceInput
	the reference input
simgear::ValueList	_minInput
	the minimum output clamp input
simgear::ValueList	_maxInput
	the maximum output clamp input
simgear::PeriodicalValue_ptr	_periodical
	the configuration for periodical outputs
simgear::PropertyList	_output_list
SGPropertyNode_ptr	_passive_mode
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

brief@ DigitalFilter - a selection of digital filters

Definition at line 33 of file digitalfilter.hxx.

Constructor & Destructor Documentation

DigitalFilter()

DigitalFilter::DigitalFilter

(

)

Definition at line 851 of file digitalfilter.cxx.

~DigitalFilter()

DigitalFilter::~DigitalFilter

(

)

Definition at line 857 of file digitalfilter.cxx.

Member Function Documentation

configure() [1/2]

bool DigitalFilter::configure ( SGPropertyNode & cfg_node, const std::string & cfg_name, SGPropertyNode & prop_root )

overrideprotectedvirtual

This method configures this analog component from a property node.

Gets called multiple times from the base class configure method for every configuration node.

Parameters

cfg_name	Name of the configuration node provided in cfg_node
cfg_node	Configuration node itself
prop_root	Property root for all relative paths

Returns

true if the node was handled, false otherwise.

Reimplemented from FGXMLAutopilot::AnalogComponent.

Definition at line 945 of file digitalfilter.cxx.

configure() [2/2]

bool DigitalFilter::configure ( SGPropertyNode & prop_root, SGPropertyNode & cfg )

virtual

configure this component from a property node.

Iterates through all nodes found as children under configNode and calls configure of the derived class for each child.

Parameters

prop_root	Property root for all relative paths
cfg	Property node containing the configuration

Reimplemented from FGXMLAutopilot::Component.

Definition at line 873 of file digitalfilter.cxx.

staticSubsystemClassId()

static const char * FGXMLAutopilot::DigitalFilter::staticSubsystemClassId ( )

inlinestatic

Definition at line 57 of file digitalfilter.hxx.

update()

void DigitalFilter::update ( bool firstTime, double dt )

overrideprotectedvirtual

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

firstTime	set to true if this is the first update call since this component has been enabled. Set to false for every subsequent call.
dt	the elapsed time since the last call

Implements FGXMLAutopilot::Component.

Definition at line 972 of file digitalfilter.cxx.

Member Data Documentation

_initializeTo

InitializeTo FGXMLAutopilot::DigitalFilter::_initializeTo = INITIALIZE_INPUT

protected

Definition at line 50 of file digitalfilter.hxx.

---

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

• digitalfilter.hxx
• digitalfilter.cxx