analogcomponent.hxx

Go to the documentation of this file.

// analogcomponent.hxx - Base class for analog autopilot components
//
// Written by Torsten Dreyer
// Based heavily on work created by Curtis Olson, started January 2004.
//
// Copyright (C) 2004  Curtis L. Olson  - http://www.flightgear.org/~curt
// Copyright (C) 2010  Torsten Dreyer - Torsten (at) t3r (dot) de
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
#ifndef __ANALOGCOMPONENT_HXX
#define __ANALOGCOMPONENT_HXX 1
 
#include <simgear/misc/inputvalue.hxx>
#include "component.hxx"
 
namespace FGXMLAutopilot {

class AnalogComponent : public Component
{
private:
    bool _feedback_if_disabled;
 
protected:
    simgear::ValueList _valueInput;

    simgear::ValueList _referenceInput;

    simgear::ValueList _minInput;

    simgear::ValueList _maxInput;

    simgear::PeriodicalValue_ptr _periodical;

    AnalogComponent();

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

    double clamp( double value ) const;

     void disabled( double dt ) override;

    inline double get_output_value() const {
        return _output_list.empty() ? 0.0 : clamp(_output_list[0]->getDoubleValue());
    }
 
    simgear::PropertyList _output_list;
    SGPropertyNode_ptr _passive_mode;
 
    inline void set_output_value( double value ) {
        // passive_ignore == true means that we go through all the
        // motions, but drive the outputs.  This is analogous to
        // running the autopilot with the "servos" off.  This is
        // helpful for things like flight directors which position
        // their vbars from the autopilot computations.
        if ( _honor_passive && _passive_mode->getBoolValue() ) return;
        value = clamp( value );
        for( simgear::PropertyList::iterator it = _output_list.begin();
             it != _output_list.end(); ++it)
            (*it)->setDoubleValue( value );
    }
 
public:
    const simgear::PeriodicalValue_ptr getPeriodicalValue() const { return _periodical; }

    void collectDependentProperties(std::set<const SGPropertyNode*>& props) const;
};
 
inline void AnalogComponent::disabled( double dt )
{
    if( _feedback_if_disabled && ! _output_list.empty() ) {
        auto activeInput = _valueInput.get_active();
        if (activeInput) {
            activeInput->set_value(_output_list[0]->getDoubleValue());
        }
    }
}
 
}
#endif // ANALOGCOMPONENT_HXX