Gain.h

Go to the documentation of this file.

#pragma once

namespace AnimatSim
{

        namespace Gains
        {
                class ANIMAT_PORT Gain : public AnimatBase 
                {
                protected:
                        bool m_bUseLimits;

                        float m_fltLowerLimit;

                        float m_fltLowerOutput;

                        float m_fltUpperLimit;

                        float m_fltUpperOutput;

                        bool InLimits(float fltInput)
                        {
                                if( m_bUseLimits && ( (fltInput < m_fltLowerLimit) || (fltInput > m_fltUpperLimit) ) ) 
                                        return false;
                                else
                                        return true;
                        }

                        float CalculateLimitOutput(float fltInput)
                        {
                                if(fltInput < m_fltLowerLimit)
                                        return m_fltLowerOutput;

                                if(fltInput > m_fltUpperLimit)
                                        return m_fltUpperOutput;

                                return 0;
                        }

                public:
                        Gain();
                        virtual ~Gain();
                        
                        static Gain *CastToDerived(AnimatBase *lpBase) {return static_cast<Gain*>(lpBase);}

                        bool UseLimits();
                        void UseLimits(bool bVal);

                        float LowerLimit();
                        void LowerLimit(float fltVal);

                        float UpperLimit();
                        void UpperLimit(float fltVal);

                        float LowerOutput();
                        void LowerOutput(float fltVal);

                        float UpperOutput();
                        void UpperOutput(float fltVal);
                        
                        virtual void Copy(CStdSerialize *lpSource);

                        virtual float CalculateGain(float fltInput) = 0;

                        virtual bool SetData(const std::string &strDataType, const std::string &strValue, bool bThrowError = true);
                        virtual void QueryProperties(CStdPtrArray<TypeProperty> &aryProperties);
                        virtual void Load(CStdXml &oXml);
                };

                Gain ANIMAT_PORT *LoadGain(Simulator *lpSim, std::string strName, CStdXml &oXml);

        }                       //Gains
}                               //AnimatSim