AnimatLab  2
Test
CsNeuralModule.h
1 
7 #pragma once
8 
9 #include "CsNeuronGroup.h"
10 #include "CsSynapseGroup.h"
11 #include "CsSynapseIndividual.h"
12 #include "CsConnectionGenerator.h"
13 
17 namespace AnimatCarlSim
18 {
35  class ANIMAT_CARL_SIM_PORT CsNeuralModule : public AnimatSim::Behavior::ThreadedModule, StepFeedback
36  {
37  protected:
39  CStdPtrArray<CsNeuronGroup> m_aryNeuronGroups;
40 
42  CStdPtrArray<CsSynapseGroup> m_arySynapses;
43 
46  CStdPtrMap<std::string, CsConnectionGenerator> m_aryGenerators;
47 
49  CpuSNN *m_lpSNN;
50 
52  int m_iSimMode;
53 
55  float m_fltNeuralTime;
56 
58  bool m_bWaitingForPhysicsToCatchUp;
59 
61  bool m_bWaitingForNeuralToCatchUp;
62 
63  CsNeuronGroup *LoadNeuronGroup(CStdXml &oXml);
64  CsSynapseGroup *LoadSynapse(CStdXml &oXml);
65  void LoadNetworkXml(CStdXml &oXml);
66 
67  virtual void StepThread();
68  virtual void CloseThread();
69 
70  virtual void SetCARLSimulation();
71 
72  virtual void WaitForPhysicsToCatchUp();
73  virtual void WaitForNeuralToCatchUp();
74 
75  public:
76  CsNeuralModule();
77  virtual ~CsNeuralModule();
78 
87  virtual std::string ModuleName();
88 
89  virtual CpuSNN *SNN() {return m_lpSNN;};
90 
91  virtual bool stepUpdate(CpuSNN* s, int step);
92  virtual void updateMonitors(CpuSNN* s, int step);
93 
94  virtual void SimMode(int iMode);
95  virtual int SimMode();
96 
97  virtual unsigned int SimulationStepInterval();
98 
99  virtual CsConnectionGenerator *FindConnectionGenerator(std::string strID, bool bThrowError = true);
100  virtual void AddConnectionGenerator(std::string strID, CsConnectionGenerator *lpGen);
101 
102  virtual void Kill(bool bState = true);
103  virtual void Initialize();
104  virtual void SimStarting();
105  virtual void SimStopping();
106  virtual void ResetSimulation();
107  virtual void StepSimulation();
108  virtual void Load(CStdXml &oXml);
109 
110 #pragma region DataAccesMethods
111  virtual bool SetData(const std::string &strDataType, const std::string &strValue, bool bThrowError = true);
112  virtual void QueryProperties(CStdPtrArray<TypeProperty> &aryProperties);
113  virtual bool AddItem(const std::string &strItemType, const std::string &strXml, bool bThrowError = true, bool bDoNotInit = false);
114  virtual bool RemoveItem(const std::string &strItemType, const std::string &strID, bool bThrowError = true);
115 #pragma endregion
116 
117  virtual void AddNeuronGroup(std::string strXml, bool bDoNotInit = false);
118  virtual void RemoveNeuronGroup(std::string strID, bool bThrowError = true);
119  virtual int FindNeuronGroupListPos(std::string strID, bool bThrowError = true);
120 
121  virtual CStdPtrArray<CsSynapseGroup> *GetSynapses();
130  virtual void AddSynapse(CsSynapseGroup *lpSynapse);
131  virtual void AddSynapse(std::string strXml, bool bDoNotInit);
132  virtual void RemoveSynapse(int iIndex);
133  virtual void RemoveSynapse(std::string strID, bool bThrowError = true);
134  virtual CsSynapseGroup *GetSynapse(int iIndex);
135  virtual int TotalSynapses();
136  virtual void ClearSynapses();
137  virtual int FindSynapseListPos(std::string strID, bool bThrowError = true);
138  };
139 
140 } //FiringRateSim
AnimatCarlSim
Contains the classes for a firing rate neural model.
Definition: CsAdapter.cpp:14
StepFeedback
used for fine-grained control over the stepping behavior during a runNetwork execution ...
Definition: snn.h:206
CsNeuronGroup.h
Declares the CsNeuronGroup class.
AnimatSim::Behavior::ThreadedModule
A Threaded neural module base class.
Definition: ThreadedModule.h:21
AnimatCarlSim::CsNeuralModule::m_arySynapses
CStdPtrArray< CsSynapseGroup > m_arySynapses
The array of synapses in this module.
Definition: CsNeuralModule.h:42
AnimatCarlSim::CsNeuralModule::m_bWaitingForNeuralToCatchUp
bool m_bWaitingForNeuralToCatchUp
True if the physics simulation has finished and is waiting on the neural sim to catch up...
Definition: CsNeuralModule.h:61
AnimatCarlSim::CsSynapseGroup
Firing rate synapse model.
Definition: CsSynapseGroup.h:22
AnimatCarlSim::CsNeuralModule
Firing rate neural module.
Definition: CsNeuralModule.h:35
CsSynapseGroup.h
Declares the synapse class.
AnimatCarlSim::CsNeuralModule::m_fltNeuralTime
float m_fltNeuralTime
The current time of the neural simulation.
Definition: CsNeuralModule.h:55
AnimatCarlSim::CsNeuronGroup
Firing Rate Neuron model.
Definition: CsNeuronGroup.h:28
AnimatCarlSim::CsNeuralModule::m_iSimMode
int m_iSimMode
The mode of the simulation. GPU vs CPU.
Definition: CsNeuralModule.h:52
AnimatCarlSim::CsNeuralModule::m_lpSNN
CpuSNN * m_lpSNN
Pointer to the CARLsim simulator.
Definition: CsNeuralModule.h:49
AnimatCarlSim::CsNeuralModule::m_aryGenerators
CStdPtrMap< std::string, CsConnectionGenerator > m_aryGenerators
Definition: CsNeuralModule.h:46
AnimatCarlSim::CsNeuralModule::m_bWaitingForPhysicsToCatchUp
bool m_bWaitingForPhysicsToCatchUp
True if the neural simulation has finished and is waiting on the physics sim to catch up...
Definition: CsNeuralModule.h:58
AnimatCarlSim::CsNeuralModule::m_aryNeuronGroups
CStdPtrArray< CsNeuronGroup > m_aryNeuronGroups
The array of neuron groups in this module.
Definition: CsNeuralModule.h:39
CpuSNN
Contains all of CARLsim's core functionality.
Definition: snn.h:619