CsFiringRateStimulus.h

Go to the documentation of this file.

#pragma once


namespace AnimatCarlSim
{
                class ANIMAT_CARL_SIM_PORT CsFiringRateStimulus  : public ExternalStimulus
                {
                protected:
                        std::string m_strTargetNodeID;

                        CsSpikeGeneratorGroup *m_lpSpikeGen;

                        std::string m_strEquation;

                        CStdPostFixEval *m_lpEval;

                        float m_fltActiveRate;

                        float m_fltPrevAppliedRate;

                        float m_fltConstantRate;

                        bool m_bStimWholePopulation;

                        CStdMap<int, int> m_aryCellsToStim;

                        virtual float CalculateFiringRate();
                        virtual void LoadCellsToStim(CStdXml &oXml);
                        virtual void ApplyRateChange();

                public:
                        CsFiringRateStimulus();
                        virtual ~CsFiringRateStimulus();
                        
                        static CsFiringRateStimulus *CastToDerived(AnimatBase *lpBase) {return static_cast<CsFiringRateStimulus*>(lpBase);}
                        
                        virtual std::string TargetNodeID();
                        virtual void TargetNodeID(std::string strID);

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

                        virtual float ConstantRate();
                        virtual void ConstantRate(float fltVal);

                        virtual float ActiveRate();
                        virtual float PrevAppliedRate();

                        virtual bool RateChanged();

                        virtual void Coverage(std::string strType);

                        virtual bool StimWholePopulation();
                        virtual void StimWholePopulation(bool bVal);

                        virtual void CellsToStim(std::string strXml);

                        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);
                };

}                               //VortexAnimatSim