CurrentStimulus.h

Go to the documentation of this file.

#pragma once


namespace AnimatSim
{
        namespace ExternalStimuli
        {
                class ANIMAT_PORT CurrentStimulus  : public ExternalStimulus
                {
                protected:
                        std::string m_strTargetNodeID;

                        float *m_lpExternalCurrent;

                        std::string m_strCurrentEquation;

                        CStdPostFixEval *m_lpCurrentOnEval;

                        int m_iType;  

                        float m_fltActiveCurrent;

                        float m_fltCurrentOn;

                        float m_fltCurrentOff;

                        float m_fltCurrentBurstOff;

                        float m_fltInitialActiveCurrent;

                        //There are the durations in time.
                        float m_fltCycleOnDuration;

                        float m_fltCycleOffDuration;

                        float m_fltBurstOnDuration;

                        float m_fltBurstOffDuration;

                        //The durations are converted to time slice values for easier comparisons.
                        long m_lCycleOnDuration;

                        long m_lCycleOffDuration;

                        long m_lBurstOnDuration;

                        long m_lBurstOffDuration;

                        long m_lCycleStart;

                        long m_lBurstStart;

                        bool m_bCycleOn;

                        bool m_bBurstOn;

                        virtual float GetCurrentOn();
                        virtual void SetSliceData();

                public:
                        CurrentStimulus();
                        virtual ~CurrentStimulus();
                        
                        static CurrentStimulus *CastToDerived(AnimatBase *lpBase) {return static_cast<CurrentStimulus*>(lpBase);}
                        
                        //virtual int Type();
                        virtual std::string Type();
                        virtual void Type(std::string strValue);
                        
                        virtual void AlwaysActive(bool bVal);

                        virtual std::string TargetNodeID();
                        virtual void TargetNodeID(std::string strID);

                        virtual float CurrentOn();
                        virtual void CurrentOn(float fltVal);

                        virtual float CurrentOff();
                        virtual void CurrentOff(float fltVal);

                        virtual float CurrentBurstOff();
                        virtual void CurrentBurstOff(float fltVal);

                        virtual float CycleOnDuration();
                        virtual void CycleOnDuration(float fltVal);

                        virtual float CycleOffDuration();
                        virtual void CycleOffDuration(float fltVal);

                        virtual float BurstOnDuration();
                        virtual void BurstOnDuration(float fltVal);

                        virtual float BurstOffDuration();
                        virtual void BurstOffDuration(float fltVal);

                        virtual std::string CurrentEquation();
                        virtual void CurrentEquation(std::string strEquation);

                        virtual void Load(CStdXml &oXml);

                        //ActiveItem overrides
                        virtual void Initialize();  
                        virtual void ResetSimulation();  
                        virtual void Activate();
                        virtual void StepSimulation();
                        virtual void Deactivate();

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

        }                       //ExternalStimuli
}                               //VortexAnimatSim