1
0
Fork 0

Refactor the XMLAuto parsing code to no longer warn about every node handled by the base class (FGXMLAutoComponent). As a side effect, issue better warnings when an unrecognised node is encountered.

This commit is contained in:
jmt 2009-09-23 17:25:42 +00:00 committed by Tim Moore
parent 13ff5da4be
commit 739196c912
2 changed files with 264 additions and 224 deletions

View file

@ -40,6 +40,20 @@
using std::cout;
using std::endl;
FGXMLAutoInput::FGXMLAutoInput( SGPropertyNode_ptr node, double value, double offset, double scale) :
value(0.0),
abs(false),
property(NULL),
offset(NULL),
scale(NULL),
min(NULL),
max(NULL),
_condition(NULL)
{
parse( node, value, offset, scale );
}
void FGXMLAutoInput::parse( SGPropertyNode_ptr node, double aValue, double aOffset, double aScale )
{
value = aValue;
@ -151,7 +165,7 @@ double FGXMLAutoInput::get_value()
return abs ? fabs(value) : value;
}
FGXMLAutoComponent::FGXMLAutoComponent( SGPropertyNode * node ) :
FGXMLAutoComponent::FGXMLAutoComponent() :
_condition( NULL ),
enable_prop( NULL ),
enable_value( NULL ),
@ -162,89 +176,6 @@ FGXMLAutoComponent::FGXMLAutoComponent( SGPropertyNode * node ) :
debug(false),
enabled( false )
{
int i;
SGPropertyNode *prop;
for ( i = 0; i < node->nChildren(); ++i ) {
SGPropertyNode *child = node->getChild(i);
string cname = child->getName();
string cval = child->getStringValue();
if ( cname == "name" ) {
name = cval;
} else if ( cname == "feedback-if-disabled" ) {
feedback_if_disabled = child->getBoolValue();
} else if ( cname == "debug" ) {
debug = child->getBoolValue();
} else if ( cname == "enable" ) {
if( (prop = child->getChild("condition")) != NULL ) {
_condition = sgReadCondition(child, prop);
} else {
if ( (prop = child->getChild( "prop" )) != NULL ) {
enable_prop = fgGetNode( prop->getStringValue(), true );
}
if ( (prop = child->getChild( "value" )) != NULL ) {
delete enable_value;
enable_value = new string(prop->getStringValue());
}
}
if ( (prop = child->getChild( "honor-passive" )) != NULL ) {
honor_passive = prop->getBoolValue();
}
} else if ( cname == "input" ) {
valueInput.push_back( new FGXMLAutoInput( child ) );
} else if ( cname == "reference" ) {
referenceInput.push_back( new FGXMLAutoInput( child ) );
} else if ( cname == "output" ) {
// grab all <prop> and <property> childs
int found = 0;
// backwards compatibility: allow <prop> elements
for( int i = 0; (prop = child->getChild("prop", i)) != NULL; i++ ) {
SGPropertyNode *tmp = fgGetNode( prop->getStringValue(), true );
output_list.push_back( tmp );
found++;
}
for( int i = 0; (prop = child->getChild("property", i)) != NULL; i++ ) {
SGPropertyNode *tmp = fgGetNode( prop->getStringValue(), true );
output_list.push_back( tmp );
found++;
}
// no <prop> elements, text node of <output> is property name
if( found == 0 )
output_list.push_back( fgGetNode(child->getStringValue(), true ) );
} else if ( cname == "config" ) {
if( (prop = child->getChild("min")) != NULL ) {
uminInput.push_back( new FGXMLAutoInput( prop ) );
}
if( (prop = child->getChild("u_min")) != NULL ) {
uminInput.push_back( new FGXMLAutoInput( prop ) );
}
if( (prop = child->getChild("max")) != NULL ) {
umaxInput.push_back( new FGXMLAutoInput( prop ) );
}
if( (prop = child->getChild("u_max")) != NULL ) {
umaxInput.push_back( new FGXMLAutoInput( prop ) );
}
} else if ( cname == "min" ) {
uminInput.push_back( new FGXMLAutoInput( child ) );
} else if ( cname == "u_min" ) {
uminInput.push_back( new FGXMLAutoInput( child ) );
} else if ( cname == "max" ) {
umaxInput.push_back( new FGXMLAutoInput( child ) );
} else if ( cname == "u_max" ) {
umaxInput.push_back( new FGXMLAutoInput( child ) );
}
}
}
FGXMLAutoComponent::~FGXMLAutoComponent()
@ -252,6 +183,111 @@ FGXMLAutoComponent::~FGXMLAutoComponent()
delete enable_value;
}
void FGXMLAutoComponent::parseNode(SGPropertyNode* aNode)
{
SGPropertyNode *prop;
for (int i = 0; i < aNode->nChildren(); ++i ) {
SGPropertyNode *child = aNode->getChild(i);
string cname(child->getName());
if (parseNodeHook(cname, child)) {
// derived class handled it, fine
} else if ( cname == "name" ) {
name = child->getStringValue();
} else if ( cname == "feedback-if-disabled" ) {
feedback_if_disabled = child->getBoolValue();
} else if ( cname == "debug" ) {
debug = child->getBoolValue();
} else if ( cname == "enable" ) {
if( (prop = child->getChild("condition")) != NULL ) {
_condition = sgReadCondition(child, prop);
} else {
if ( (prop = child->getChild( "prop" )) != NULL ) {
enable_prop = fgGetNode( prop->getStringValue(), true );
}
if ( (prop = child->getChild( "value" )) != NULL ) {
delete enable_value;
enable_value = new string(prop->getStringValue());
}
}
if ( (prop = child->getChild( "honor-passive" )) != NULL ) {
honor_passive = prop->getBoolValue();
}
} else if ( cname == "input" ) {
valueInput.push_back( new FGXMLAutoInput( child ) );
} else if ( cname == "reference" ) {
referenceInput.push_back( new FGXMLAutoInput( child ) );
} else if ( cname == "output" ) {
// grab all <prop> and <property> childs
int found = 0;
// backwards compatibility: allow <prop> elements
for( int i = 0; (prop = child->getChild("prop", i)) != NULL; i++ ) {
SGPropertyNode *tmp = fgGetNode( prop->getStringValue(), true );
output_list.push_back( tmp );
found++;
}
for( int i = 0; (prop = child->getChild("property", i)) != NULL; i++ ) {
SGPropertyNode *tmp = fgGetNode( prop->getStringValue(), true );
output_list.push_back( tmp );
found++;
}
// no <prop> elements, text node of <output> is property name
if( found == 0 )
output_list.push_back( fgGetNode(child->getStringValue(), true ) );
} else if ( cname == "config" ) {
parseConfig(child);
} else if ( cname == "min" ) {
uminInput.push_back( new FGXMLAutoInput( child ) );
} else if ( cname == "u_min" ) {
uminInput.push_back( new FGXMLAutoInput( child ) );
} else if ( cname == "max" ) {
umaxInput.push_back( new FGXMLAutoInput( child ) );
} else if ( cname == "u_max" ) {
umaxInput.push_back( new FGXMLAutoInput( child ) );
} else {
SG_LOG(SG_AUTOPILOT, SG_ALERT, "malformed autopilot definition - unrecognized node:"
<< cname << " in section " << name);
throw sg_io_exception("XMLAuto: unrecognized component node:" + cname, "Section=" + name);
}
} // of top-level iteration
}
void FGXMLAutoComponent::parseConfig(SGPropertyNode* aConfig)
{
for (int i = 0; i < aConfig->nChildren(); ++i ) {
SGPropertyNode *child = aConfig->getChild(i);
string cname(child->getName());
if (parseConfigHook(cname, child)) {
// derived class handled it, fine
} else if ( cname == "min" ) {
uminInput.push_back( new FGXMLAutoInput( child ) );
} else if ( cname == "u_min" ) {
uminInput.push_back( new FGXMLAutoInput( child ) );
} else if ( cname == "max" ) {
umaxInput.push_back( new FGXMLAutoInput( child ) );
} else if ( cname == "u_max" ) {
umaxInput.push_back( new FGXMLAutoInput( child ) );
} else {
SG_LOG(SG_AUTOPILOT, SG_ALERT, "malformed autopilot definition - unrecognized config node:"
<< cname << " in section " << name);
throw sg_io_exception("XMLAuto: unrecognized config node:" + cname, "Section=" + name);
}
} // of config iteration
}
bool FGXMLAutoComponent::parseNodeHook(const string& aName, SGPropertyNode* aNode)
{
return false;
}
bool FGXMLAutoComponent::parseConfigHook(const string& aName, SGPropertyNode* aNode)
{
return false;
}
bool FGXMLAutoComponent::isPropertyEnabled()
{
if( _condition )
@ -289,7 +325,7 @@ double FGXMLAutoComponent::clamp( double value )
}
FGPIDController::FGPIDController( SGPropertyNode *node ):
FGXMLAutoComponent( node ),
FGXMLAutoComponent(),
alpha( 0.1 ),
beta( 1.0 ),
gamma( 0.0 ),
@ -300,46 +336,32 @@ FGPIDController::FGPIDController( SGPropertyNode *node ):
desiredTs( 0.0 ),
elapsedTime( 0.0 )
{
int i;
for ( i = 0; i < node->nChildren(); ++i ) {
SGPropertyNode *child = node->getChild(i);
string cname = child->getName();
string cval = child->getStringValue();
if ( cname == "config" ) {
SGPropertyNode *config;
if ( (config = child->getChild( "Ts" )) != NULL ) {
desiredTs = config->getDoubleValue();
}
Kp.push_back( new FGXMLAutoInput( child->getChild( "Kp" ) ) );
Ti.push_back( new FGXMLAutoInput( child->getChild( "Ti" ) ) );
Td.push_back( new FGXMLAutoInput( child->getChild( "Td" ) ) );
config = child->getChild( "beta" );
if ( config != NULL ) {
beta = config->getDoubleValue();
}
config = child->getChild( "alpha" );
if ( config != NULL ) {
alpha = config->getDoubleValue();
}
config = child->getChild( "gamma" );
if ( config != NULL ) {
gamma = config->getDoubleValue();
}
} else {
SG_LOG( SG_AUTOPILOT, SG_WARN, "Error in autopilot config logic" );
if ( get_name().length() ) {
SG_LOG( SG_AUTOPILOT, SG_WARN, "Section = " << get_name() );
}
}
}
parseNode(node);
}
bool FGPIDController::parseConfigHook(const string& aName, SGPropertyNode* aNode)
{
if (aName == "Ts") {
desiredTs = aNode->getDoubleValue();
} else if (aName == "Kp") {
Kp.push_back( new FGXMLAutoInput(aNode) );
} else if (aName == "Ti") {
Ti.push_back( new FGXMLAutoInput(aNode) );
} else if (aName == "Td") {
Td.push_back( new FGXMLAutoInput(aNode) );
} else if (aName == "beta") {
beta = aNode->getDoubleValue();
} else if (aName == "alpha") {
alpha = aNode->getDoubleValue();
} else if (aName == "gamma") {
gamma = aNode->getDoubleValue();
} else {
// unhandled by us, let the base class try it
return false;
}
return true;
}
/*
* Roy Vegard Ovesen:
@ -512,26 +534,25 @@ void FGPIDController::update( double dt ) {
FGPISimpleController::FGPISimpleController( SGPropertyNode *node ):
FGXMLAutoComponent( node ),
FGXMLAutoComponent(),
int_sum( 0.0 )
{
int i;
for ( i = 0; i < node->nChildren(); ++i ) {
SGPropertyNode *child = node->getChild(i);
string cname = child->getName();
string cval = child->getStringValue();
if ( cname == "config" ) {
Kp.push_back( new FGXMLAutoInput( child->getChild( "Kp" ) ) );
Ki.push_back( new FGXMLAutoInput( child->getChild( "Ki" ) ) );
} else {
SG_LOG( SG_AUTOPILOT, SG_WARN, "Error in autopilot config logic" );
if ( get_name().length() ) {
SG_LOG( SG_AUTOPILOT, SG_WARN, "Section = " << get_name() );
}
}
}
parseNode(node);
}
bool FGPISimpleController::parseConfigHook(const string& aName, SGPropertyNode* aNode)
{
if (aName == "Kp") {
Kp.push_back( new FGXMLAutoInput(aNode) );
} else if (aName == "Ki") {
Ki.push_back( new FGXMLAutoInput(aNode) );
} else {
// unhandled by us, let the base class try it
return false;
}
return true;
}
void FGPISimpleController::update( double dt ) {
@ -573,19 +594,23 @@ void FGPISimpleController::update( double dt ) {
FGPredictor::FGPredictor ( SGPropertyNode *node ):
FGXMLAutoComponent( node ),
FGXMLAutoComponent(),
average(0.0)
{
int i;
for ( i = 0; i < node->nChildren(); ++i ) {
SGPropertyNode *child = node->getChild(i);
string cname = child->getName();
if ( cname == "seconds" ) {
seconds.push_back( new FGXMLAutoInput( child, 0 ) );
} else if ( cname == "filter-gain" ) {
filter_gain.push_back( new FGXMLAutoInput( child, 0 ) );
}
}
parseNode(node);
}
bool FGPredictor::parseNodeHook(const string& aName, SGPropertyNode* aNode)
{
if (aName == "seconds") {
seconds.push_back( new FGXMLAutoInput( aNode, 0 ) );
} else if (aName == "filter-gain") {
filter_gain.push_back( new FGXMLAutoInput( aNode, 0 ) );
} else {
return false;
}
return true;
}
void FGPredictor::update( double dt ) {
@ -634,47 +659,52 @@ void FGPredictor::update( double dt ) {
FGDigitalFilter::FGDigitalFilter(SGPropertyNode *node):
FGXMLAutoComponent( node ),
FGXMLAutoComponent(),
filterType(none)
{
int i;
for ( i = 0; i < node->nChildren(); ++i ) {
SGPropertyNode *child = node->getChild(i);
string cname = child->getName();
string cval = child->getStringValue();
if ( cname == "type" ) {
if ( cval == "exponential" ) {
filterType = exponential;
} else if (cval == "double-exponential") {
filterType = doubleExponential;
} else if (cval == "moving-average") {
filterType = movingAverage;
} else if (cval == "noise-spike") {
filterType = noiseSpike;
} else if (cval == "gain") {
filterType = gain;
} else if (cval == "reciprocal") {
filterType = reciprocal;
}
} else if ( cname == "filter-time" ) {
TfInput.push_back( new FGXMLAutoInput( child, 1.0 ) );
if( filterType == none ) filterType = exponential;
} else if ( cname == "samples" ) {
samplesInput.push_back( new FGXMLAutoInput( child, 1 ) );
if( filterType == none ) filterType = movingAverage;
} else if ( cname == "max-rate-of-change" ) {
rateOfChangeInput.push_back( new FGXMLAutoInput( child, 1 ) );
if( filterType == none ) filterType = noiseSpike;
} else if ( cname == "gain" ) {
gainInput.push_back( new FGXMLAutoInput( child, 1 ) );
if( filterType == none ) filterType = gain;
}
}
parseNode(node);
output.resize(2, 0.0);
input.resize(samplesInput.get_value() + 1, 0.0);
}
bool FGDigitalFilter::parseNodeHook(const string& aName, SGPropertyNode* aNode)
{
if (aName == "type" ) {
string val(aNode->getStringValue());
if ( val == "exponential" ) {
filterType = exponential;
} else if (val == "double-exponential") {
filterType = doubleExponential;
} else if (val == "moving-average") {
filterType = movingAverage;
} else if (val == "noise-spike") {
filterType = noiseSpike;
} else if (val == "gain") {
filterType = gain;
} else if (val == "reciprocal") {
filterType = reciprocal;
}
} else if (aName == "filter-time" ) {
TfInput.push_back( new FGXMLAutoInput( aNode, 1.0 ) );
if( filterType == none ) filterType = exponential;
} else if (aName == "samples" ) {
samplesInput.push_back( new FGXMLAutoInput( aNode, 1 ) );
if( filterType == none ) filterType = movingAverage;
} else if (aName == "max-rate-of-change" ) {
rateOfChangeInput.push_back( new FGXMLAutoInput( aNode, 1 ) );
if( filterType == none ) filterType = noiseSpike;
} else if (aName == "gain" ) {
gainInput.push_back( new FGXMLAutoInput( aNode, 1 ) );
if( filterType == none ) filterType = gain;
} else {
return false; // not handled by us, let the base class try
}
return true;
}
void FGDigitalFilter::update(double dt)
{
if ( isPropertyEnabled() ) {
@ -795,9 +825,9 @@ void FGXMLAutopilot::init() {
" details.");
exit(-1);
}
} catch (const sg_exception&) {
} catch (const sg_exception& e) {
SG_LOG( SG_ALL, SG_ALERT, "Failed to load autopilot configuration: "
<< config.str() );
<< config.str() << ":" << e.getMessage() );
}
} else {

View file

@ -24,30 +24,16 @@
#ifndef _XMLAUTO_HXX
#define _XMLAUTO_HXX 1
#ifndef __cplusplus
# error This library requires C++
#endif
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <simgear/compiler.h>
#include <string>
#include <vector>
#include <deque>
using std::string;
using std::vector;
using std::deque;
#include <simgear/props/props.hxx>
#include <simgear/structure/subsystem_mgr.hxx>
#include <simgear/props/condition.hxx>
#include <Main/fg_props.hxx>
class FGXMLAutoInput : public SGReferenced {
private:
@ -61,18 +47,8 @@ private:
SGSharedPtr<const SGCondition> _condition;
public:
FGXMLAutoInput( SGPropertyNode_ptr node = NULL, double value = 0.0, double offset = 0.0, double scale = 1.0 ) :
value(0.0),
abs(false),
property(NULL),
offset(NULL),
scale(NULL),
min(NULL),
max(NULL),
_condition(NULL) {
parse( node, value, offset, scale );
}
FGXMLAutoInput( SGPropertyNode_ptr node = NULL, double value = 0.0, double offset = 0.0, double scale = 1.0 );
void parse( SGPropertyNode_ptr, double value = 0.0, double offset = 0.0, double scale = 1.0 );
/* get the value of this input, apply scale and offset and clipping */
@ -95,7 +71,7 @@ public:
};
class FGXMLAutoInputList : public vector<SGSharedPtr<FGXMLAutoInput> > {
class FGXMLAutoInputList : public std::vector<SGSharedPtr<FGXMLAutoInput> > {
public:
FGXMLAutoInput * get_active() {
for (iterator it = begin(); it != end(); ++it) {
@ -119,16 +95,16 @@ class FGXMLAutoInputList : public vector<SGSharedPtr<FGXMLAutoInput> > {
class FGXMLAutoComponent : public SGReferenced {
private:
vector <SGPropertyNode_ptr> output_list;
std::vector <SGPropertyNode_ptr> output_list;
SGSharedPtr<const SGCondition> _condition;
SGPropertyNode_ptr enable_prop;
string * enable_value;
std::string * enable_value;
SGPropertyNode_ptr passive_mode;
bool honor_passive;
string name;
std::string name;
/* Feed back output property to input property if
this filter is disabled. This is for multi-stage
@ -141,6 +117,31 @@ private:
void do_feedback_if_disabled();
protected:
FGXMLAutoComponent();
/*
* Parse a component specification read from a property-list.
* Calls the hook methods below to allow derived classes to
* specialise parsing bevaiour.
*/
void parseNode(SGPropertyNode* aNode);
/**
* Helper to parse the config section
*/
void parseConfig(SGPropertyNode* aConfig);
/*
* Over-rideable hook method to allow derived classes to refine top-level
* node parsing. Return true if the node was handled, false otherwise.
*/
virtual bool parseNodeHook(const std::string& aName, SGPropertyNode* aNode);
/**
* Over-rideable hook method to allow derived classes to refine config
* node parsing. Return true if the node was handled, false otherwise.
*/
virtual bool parseConfigHook(const std::string& aName, SGPropertyNode* aNode);
FGXMLAutoInputList valueInput;
FGXMLAutoInputList referenceInput;
@ -156,13 +157,12 @@ protected:
}
public:
FGXMLAutoComponent( SGPropertyNode *node);
virtual ~FGXMLAutoComponent();
virtual void update (double dt)=0;
inline const string& get_name() { return name; }
inline const std::string& get_name() { return name; }
double clamp( double value );
@ -173,7 +173,7 @@ public:
// helpful for things like flight directors which position
// their vbars from the autopilot computations.
if ( honor_passive && passive_mode->getBoolValue() ) return;
for( vector <SGPropertyNode_ptr>::iterator it = output_list.begin(); it != output_list.end(); ++it)
for( std::vector <SGPropertyNode_ptr>::iterator it = output_list.begin(); it != output_list.end(); ++it)
(*it)->setDoubleValue( clamp( value ) );
}
@ -252,7 +252,9 @@ private:
double desiredTs; // desired sampling interval (sec)
double elapsedTime; // elapsed time (sec)
protected:
bool parseConfigHook(const std::string& aName, SGPropertyNode* aNode);
public:
@ -279,6 +281,8 @@ private:
FGXMLAutoInputList Ki;
double int_sum;
protected:
bool parseConfigHook(const std::string& aName, SGPropertyNode* aNode);
public:
@ -301,6 +305,9 @@ private:
FGXMLAutoInputList seconds;
FGXMLAutoInputList filter_gain;
protected:
bool parseNodeHook(const std::string& aName, SGPropertyNode* aNode);
public:
FGPredictor( SGPropertyNode *node );
~FGPredictor() {}
@ -329,12 +336,15 @@ private:
FGXMLAutoInputList gainInput; //
FGXMLAutoInputList TfInput; // Filter time [s]
deque <double> output;
deque <double> input;
std::deque <double> output;
std::deque <double> input;
enum filterTypes { exponential, doubleExponential, movingAverage,
noiseSpike, gain, reciprocal, none };
filterTypes filterType;
protected:
bool parseNodeHook(const std::string& aName, SGPropertyNode* aNode);
public:
FGDigitalFilter(SGPropertyNode *node);
~FGDigitalFilter() {}
@ -365,7 +375,7 @@ public:
protected:
typedef vector<SGSharedPtr<FGXMLAutoComponent> > comp_list;
typedef std::vector<SGSharedPtr<FGXMLAutoComponent> > comp_list;
private: