|
AnimatLab
2
Test
|
|
AnimatLab
2
Test
|
Handles processing of a single module within a thread of the simulation. More...
#include <ModuleThreadProcessor.h>
Inheritance diagram for AnimatSim::ModuleThreadProcessor: Collaboration diagram for AnimatSim::ModuleThreadProcessor:Public Member Functions | |
| ModuleThreadProcessor (std::string strModuleName) | |
| Default constructor. More... | |
| virtual | ~ModuleThreadProcessor () |
| Destructor. More... | |
| virtual void | StepAdapters () |
| virtual void | StepSimulation () |
| Step the simulation for this object. More... | |
| Public Member Functions inherited from AnimatSim::AnimatBase | |
| AnimatBase () | |
| Constructs an AnimatBase object. More... | |
| virtual | ~AnimatBase () |
| Destroys the AnimatBase object.. More... | |
| virtual bool | AddItem (const std::string &strItemType, const std::string &strXml, bool bThrowError=true, bool bDoNotInit=false) |
| Adds a new object to this parent. More... | |
| virtual void | AfterResetSimulation () |
| Called after a simulation reset for some objects. More... | |
| virtual long | CalculateSnapshotByteSize () |
| Calculates the snapshot byte size. More... | |
| virtual void | Copy (CStdSerialize *lpSource) |
| virtual void | Enabled (bool bVal) |
| Tells whether this item is enabled or not. This is not actually used for all objects, only specific ones. I am putting it in the base class though to prevent numerous duplications. More... | |
| virtual bool | Enabled () |
| Tells whether this item is enabled or not. This is not actually used for all objects, only specific ones. I am putting it in the base class though to prevent numerous duplications. More... | |
| virtual float * | GetDataPointer (const std::string &strDataType) |
| Returns a float pointer to a data item of interest in this object. More... | |
| virtual NeuralModule * | GetNeuralModule () |
| Gets the neural module. More... | |
| virtual Node * | GetNode () |
| Gets the node. More... | |
| virtual Simulator * | GetSimulator () |
| Gets the simulator pointer. More... | |
| virtual Structure * | GetStructure () |
| Gets the structure for this node. More... | |
| virtual bool | HasProperty (const std::string &strName) |
| Queries this object if it has a property with the given name. More... | |
| virtual std::string | ID () |
| Gets the unique GUID ID of this object. More... | |
| virtual void | ID (std::string strValue) |
| Sets the unique GUID ID of the object. More... | |
| virtual void | Initialize () |
| Initializes this object. More... | |
| virtual void | Kill (bool bState=true) |
| Kills. More... | |
| virtual void | Load (StdUtils::CStdXml &oXml) |
| Loads the item using an XML data packet. More... | |
| virtual void | LoadKeyFrameSnapshot (byte *aryBytes, long &lIndex) |
| Loads a key frame snapshot. More... | |
| virtual std::string | Name () |
| Gets the name of this object. More... | |
| virtual void | Name (std::string strValue) |
| Sets the name of the object. Blank is acceptable. More... | |
| virtual AnimatPropertyType | PropertyType (const std::string &strName) |
| virtual void | QueryProperties (CStdPtrArray< TypeProperty > &aryProperties) |
| Queries this object for a list of properties that can be changed using SetData. More... | |
| virtual void | ReInitialize () |
| Re-initialize this object. More... | |
| virtual bool | RemoveItem (const std::string &strItemType, const std::string &strID, bool bThrowError=true) |
| Removes a child item from this parent. More... | |
| virtual void | Reset () |
| Resets this object. More... | |
| virtual void | ResetSimulation () |
| Resets the simulation back to time 0. More... | |
| virtual void | RigidBodyAdded (std::string strID) |
| virtual void | RigidBodyRemoved (std::string strID) |
| virtual void | SaveKeyFrameSnapshot (byte *aryBytes, long &lIndex) |
| Saves a key frame snapshot. More... | |
| virtual bool | Selected () |
| Tells if this items is selected or not. More... | |
| virtual void | Selected (bool bValue, bool bSelectMultiple) |
| Selects this object. More... | |
| virtual bool | SetData (const std::string &strDataType, const std::string &strValue, bool bThrowError=true) |
| Set a variable based on a string data type name. More... | |
| virtual bool | SetData (const std::string &strDataType, const float fltValue, bool bThrowError=true) |
| Set a variable based on a string data type name. More... | |
| virtual bool | SetData (const std::string &strDataType, const long lValue, bool bThrowError=true) |
| Set a variable based on a string data type name. More... | |
| virtual void | SetSystemPointers (Simulator *lpSim, Structure *lpStructure, NeuralModule *lpModule, Node *lpNode, bool bVerify) |
| Sets the system pointers. More... | |
| virtual void | SimPausing () |
| Called just before the simulation pauses. More... | |
| virtual void | SimStarting () |
| Called just before the simulation starts. More... | |
| virtual void | SimStopping () |
| Called just before the simulation stops. More... | |
| virtual void | TimeStepModified () |
| Notification method that the time step modified has been modified. Objects should recalculate any slice times as needed. More... | |
| virtual std::string | Type () |
| returns the string type name of this object. More... | |
| virtual void | Type (std::string strValue) |
| Sets the class type for this object. More... | |
| virtual void | VerifySystemPointers () |
| Verify that system pointers have been set correctly. More... | |
| virtual void | VisualSelectionModeChanged (int iNewMode) |
| Visual selection mode changed. More... | |
Static Public Member Functions | |
| static ModuleThreadProcessor * | CastToDerived (AnimatBase *lpBase) |
Additional Inherited Members | |
| Protected Attributes inherited from AnimatSim::AnimatBase | |
| bool | m_bEnabled |
| Tells if this item is enabled or not. If it is not enabled then it is not run. | |
| bool | m_bSelected |
| Tells whether the object is selected or not. | |
| AnimatSim::Behavior::NeuralModule * | m_lpModule |
| The pointer to this items parentNeuralModule. If this is not relevant for this object then this is NULL. | |
| Node * | m_lpNode |
| The pointer to this items parent Node. If this is not relevant for this object then this is NULL. | |
| Simulator * | m_lpSim |
| The pointer to a Simulation. | |
| AnimatSim::Environment::Structure * | m_lpStructure |
| The pointer to this items parent Structure. If this is not relevant for this object then this is NULL. | |
| std::string | m_strID |
| The unique Id for this object. | |
| std::string | m_strName |
| The name for this object. | |
| std::string | m_strType |
| The type for this object. Examples are Box, Plane, Neuron, etc.. | |
Handles processing of a single module within a thread of the simulation.
The simulation is split up among several threads. All neural modules are processed in one thread, physics in another, and IO communications in another if needed. Each thread has a ThreadProcessor that controls the flow of execution within that thread. Each ThreadProcessor has one or more ModuleThreadProcessors that it uses to do this. The ModuleThreadProcessor does the actual work.
\author dcofer \date 4/14/2014
Definition at line 23 of file ModuleThreadProcessor.h.
| AnimatSim::ModuleThreadProcessor::ModuleThreadProcessor | ( | std::string | strModuleName | ) |
Default constructor.
Definition at line 51 of file ModuleThreadProcessor.cpp.
References AnimatSim::AnimatBase::m_strName.
|
virtual |
Destructor.
Definition at line 64 of file ModuleThreadProcessor.cpp.
References StdUtils::Std_TraceMsg().
Here is the call graph for this function:
|
virtual |
Step the simulation for this object.
This is called on an object each time it is stepped in the simulation. this is where its simulation code is processed. However, StepSimulation is not necessarily called every single time that the simulation as a whole is stepped. A good example of this is that neural modules can have different integration time steps. So a firing rate module may have a DT of 0.5 ms, while an integrate and fire model may have one of 0.1 ms. So the firing rate module would only get its StepSimulation method called every 5th time that the other module was called. This is all handed in the StepSimulation method of the Simulator and NervousSystem.
Reimplemented from AnimatSim::AnimatBase.
Definition at line 74 of file ModuleThreadProcessor.cpp.
1.8.10 
