NeuralModule.h

Go to the documentation of this file.

#pragma once

namespace AnimatSim
{
        namespace Behavior
        {
                class ANIMAT_PORT NeuralModule : public AnimatBase 
                {
                protected:
                        Organism *m_lpOrganism; 

                        short m_iTimeStepInterval;  

                        float m_fltTimeStep;

                        // of this module. This is zeroed back out at the next step of this module.
                        short m_iTimeStepCount;

                        std::string m_strProjectPath;

                        std::string m_strNeuralNetworkFile;

                        IStdClassFactory *m_lpClassFactory;

                        CStdArray<Adapter *> m_arySourceAdapters;

                        CStdArray<Adapter *> m_aryTargetAdapters;

                        CStdPtrArray<AnimatSim::Link> m_aryExternalSynapses;

                        short m_iTargetAdapterCount;

                        virtual int FindAdapterListIndex(CStdArray<Adapter *> aryAdapters, std::string strID, bool bThrowError = true);
                        virtual AnimatSim::Link *LoadExternalSynapse(CStdXml &oXml);
                        virtual void LoadExternalSynapses(CStdXml &oXml);

                public:
                        NeuralModule();
                        virtual ~NeuralModule();

                        static NeuralModule *CastToDerived(AnimatBase *lpBase) {return static_cast<NeuralModule*>(lpBase);}

                        virtual std::string ModuleName() = 0;

                        virtual short TimeStepInterval();
                        virtual void TimeStepInterval(short iVal);

                        virtual float TimeStep();
                        virtual void TimeStep(float fltVal);

                        virtual IStdClassFactory *ClassFactory();
                        virtual void ClassFactory(IStdClassFactory *lpFactory);

                        Simulator *GetSimulator();
                        Organism *GetOrganism();

                        virtual void SetSystemPointers(Simulator *lpSim, Structure *lpStructure, NeuralModule *lpModule, Node *lpNode, bool bVerify);
                        virtual void VerifySystemPointers();

                        virtual void AttachSourceAdapter(Adapter *lpAdapter);

                        virtual void RemoveSourceAdapter(Adapter *lpAdapter);

                        virtual void AttachTargetAdapter(Adapter *lpAdapter);

                        virtual void RemoveTargetAdapter(Adapter *lpAdapter);

                        virtual float *GetDataPointer(const std::string &strDataType);

                        virtual void AddExternalSynapse(AnimatSim::Link *lpSynapse);
                        virtual void AddExternalSynapse(std::string strXml, bool bDoNotInit);
                        virtual void RemoveExternalSynapse(std::string strID, bool bThrowError = true);
                        virtual int FindExternalSynapseListPos(std::string strID, bool bThrowError = true);

                        virtual void Initialize();
                        virtual void ResetSimulation();
                        virtual bool NeedToStep(bool bIncrement);
                        virtual void ResetStepCounter();
                        virtual void StepSimulation();

                        virtual void StepAdapters();
                };

        }                       //Behavior
}                       //AnimatSim