|
AnimatLab
2
Test
|
|
AnimatLab
2
Test
|
Base manager class for ActivatedItem's. More...
#include <ActivatedItemMgr.h>
Inheritance diagram for AnimatSim::ActivatedItemMgr: Collaboration diagram for AnimatSim::ActivatedItemMgr:Public Member Functions | |
| ActivatedItemMgr () | |
| Default constructor. More... | |
| virtual | ~ActivatedItemMgr () |
| Destructor. More... | |
| virtual void | Add (ActivatedItem *lpItem) |
| Adds a new ActivatedItem to be managed. More... | |
| virtual ActivatedItem * | Find (std::string strID, int &iIndex, bool bThrowError) |
| Searches for an item with the specified ID and sets its index in the array. More... | |
| virtual ActivatedItem * | Find (std::string strID, bool bThrowError=true) |
| Searches for an item with the specified ID. More... | |
| virtual int | FindListPos (std::string strID, bool bThrowError=true) |
| Searches for the item with the specified ID and returns its position in the m_aryItems array. More... | |
| virtual void | Initialize () |
| Initializes this object. More... | |
| virtual void | ReInitialize () |
| Re-initialize this object. More... | |
| virtual void | Remove (std::string strID, bool bThrowError=true) |
| Removes the item with the specified ID. More... | |
| virtual void | Reset () |
| Resets this manager. More... | |
| virtual void | ResetSimulation () |
| Resets the simulation back to time 0. More... | |
| 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 | 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 bool | RemoveItem (const std::string &strItemType, const std::string &strID, bool bThrowError=true) |
| Removes a child item from this parent. 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 ActivatedItemMgr * | CastToDerived (AnimatBase *lpBase) |
Protected Attributes | |
| CStdArray< ActivatedItem * > | m_aryItems |
| CStdPtrMap< std::string, ActivatedItem > | m_aryItemsMap |
| 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.. | |
Base manager class for ActivatedItem's.
Activated items are types of objects that are activated and deactivated at specific points in time. Examples of these types of objects are DataChart's and ExternalStimulus. This base class is used to manage the loading, initialization, and activation/deactivation of those items. For each specific type of ActivateItem you will need an derived manager class for those types. For example, to manage data charts you will need the DataChartMgr.
This class keeps a list of all activated items that are added to it and at each time step of the simulation it determines which of these items need to be activated or deactivated.
Definition at line 28 of file ActivatedItemMgr.h.
| AnimatSim::ActivatedItemMgr::ActivatedItemMgr | ( | ) |
|
virtual |
Destructor.
Definition at line 60 of file ActivatedItemMgr.cpp.
References Reset(), and StdUtils::Std_TraceMsg().
Here is the call graph for this function:
|
virtual |
Adds a new ActivatedItem to be managed.
| [in,out] | lpItem | The pointer to the item to add. |
Reimplemented in AnimatSim::Recording::SimulationRecorder.
Definition at line 102 of file ActivatedItemMgr.cpp.
References AnimatSim::AnimatBase::ID(), AnimatSim::LessThanActivatedItemCompare(), m_aryItems, m_aryItemsMap, StdUtils::CStdErrorInfo::m_lError, StdUtils::CStdErrorInfo::m_strError, and StdUtils::Std_CheckString().
Referenced by AnimatSim::Recording::SimulationRecorder::Add(), AnimatSim::Charting::DataChartMgr::LoadDataChart(), and AnimatSim::ExternalStimuli::ExternalStimuliMgr::LoadExternalStimuli().
Here is the call graph for this function: Here is the caller graph for this function:
|
virtual |
Searches for an item with the specified ID and sets its index in the array.
| strID | ID of item to find. | |
| [in,out] | iIndex | Zero-based index of the item in m_aryItems. |
| bThrowError | true to throw error if not found. |
| If | bThrowError is true and no item with the specified ID is found then an exception is thrown. |
Definition at line 174 of file ActivatedItemMgr.cpp.
References AnimatSim::AnimatBase::ID(), m_aryItems, and StdUtils::Std_CheckString().
Referenced by AnimatSim::Charting::DataChartMgr::AddDataColumn(), AnimatSim::Simulator::EnableVideoPlayback(), AnimatSim::Charting::DataChartMgr::FindDataColumn(), AnimatSim::Simulator::MoveKeyFrame(), AnimatSim::Simulator::MoveSimulationToKeyFrame(), Remove(), and AnimatSim::Charting::DataChartMgr::RemoveDataColumn().
Here is the call graph for this function: Here is the caller graph for this function:
|
virtual |
Searches for an item with the specified ID.
| strID | ID of item to find. |
| bThrowError | true to throw error if not found. |
| If | bThrowError is true and no item with the specified ID is found then an exception is thrown. |
Definition at line 209 of file ActivatedItemMgr.cpp.
References m_aryItemsMap, and StdUtils::Std_CheckString().
Here is the call graph for this function:
|
virtual |
Searches for the item with the specified ID and returns its position in the m_aryItems array.
| strID | ID of item to find. |
| bThrowError | true to throw error if not found. |
Definition at line 236 of file ActivatedItemMgr.cpp.
References AnimatSim::AnimatBase::ID(), m_aryItems, AnimatSim::AnimatBase::m_strID, StdUtils::Std_ToUpper(), and StdUtils::Std_Trim().
Here is the call graph for this function:
|
virtual |
Initializes this object.
After an object is loaded in it must be initialized before it can be used. This allows the object to retrieve any pointers or setup memory that it will need during execution. Each object is responsible for initializing any of its child objects, so you simply need to call this method on the containing class to init all child objects. It also calls VerifySystemPointers to make sure that the system pointers have been setup correctly.
Reimplemented from AnimatSim::AnimatBase.
Definition at line 252 of file ActivatedItemMgr.cpp.
References AnimatSim::AnimatBase::Initialize(), AnimatSim::LessThanActivatedItemCompare(), and m_aryItems.
Here is the call graph for this function:
|
virtual |
Re-initialize this object.
Some objects like data charts need to be re-initialized some times. An example of when that would be needed is when the simulation is re-started.
Reimplemented from AnimatSim::AnimatBase.
Definition at line 263 of file ActivatedItemMgr.cpp.
References AnimatSim::LessThanActivatedItemCompare(), and m_aryItems.
Referenced by AnimatSim::Charting::DataChartMgr::AddDataChart(), AnimatSim::Charting::DataChartMgr::RemoveDataChart(), and AnimatSim::ExternalStimuli::ExternalStimulus::SetData().
Here is the call graph for this function: Here is the caller graph for this function:
|
virtual |
Removes the item with the specified ID.
| strID | ID of the item to remove. |
| bThrowError | true to throw error if not found. |
Definition at line 138 of file ActivatedItemMgr.cpp.
References AnimatSim::ActivatedItem::Deactivate(), Find(), AnimatSim::ActivatedItem::IsActivated(), AnimatSim::LessThanActivatedItemCompare(), m_aryItems, m_aryItemsMap, and StdUtils::Std_CheckString().
Referenced by AnimatSim::Simulator::MoveKeyFrame(), AnimatSim::Charting::DataChartMgr::RemoveDataChart(), AnimatSim::Simulator::RemoveKeyFrame(), and AnimatSim::ExternalStimuli::ExternalStimuliMgr::RemoveStimulus().
Here is the call graph for this function: Here is the caller graph for this function:
|
virtual |
Resets this manager.
This releases all ActivatedItem's.
Reimplemented from AnimatSim::AnimatBase.
Definition at line 81 of file ActivatedItemMgr.cpp.
References m_aryItems, m_aryItemsMap, and StdUtils::Std_TraceMsg().
Referenced by AnimatSim::Simulator::Reset(), and ~ActivatedItemMgr().
Here is the call graph for this function: Here is the caller graph for this function:
|
virtual |
Resets the simulation back to time 0.
This method calls the ResetSimulation method on all subitems in order to reset the simulation back to the beginning.
Reimplemented from AnimatSim::AnimatBase.
Definition at line 272 of file ActivatedItemMgr.cpp.
References m_aryItems.
Referenced by AnimatSim::Simulator::ResetSimulation().
Here is the caller 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 279 of file ActivatedItemMgr.cpp.
References AnimatSim::ActivatedItem::Activate(), AnimatSim::ActivatedItem::Deactivate(), AnimatSim::ActivatedItem::Enabled(), AnimatSim::ActivatedItem::IsActivated(), m_aryItems, AnimatSim::ActivatedItem::NeedToActivate(), AnimatSim::ActivatedItem::NeedToDeactivate(), AnimatSim::ActivatedItem::NeedToStep(), and AnimatSim::AnimatBase::StepSimulation().
Here is the call graph for this function:
|
protected |
The list of activated items. This is the list of unsorted pointers. Items put into this list will be destroyed when the list is destroyed, so be careful what you place in or remove from this list.
Definition at line 34 of file ActivatedItemMgr.h.
Referenced by AnimatSim::Recording::SimulationRecorder::Add(), Add(), Find(), FindListPos(), Initialize(), ReInitialize(), Remove(), Reset(), ResetSimulation(), and StepSimulation().
|
protected |
This is the sorted mpa of activated items. It is indexed based on the unique ID value. This allows us to easily find any ActivatedItem based on its ID. The pointers in this list are a duplicate of the ones in m_aryItems. They are NOT deleted when the list is destroyed.
Definition at line 40 of file ActivatedItemMgr.h.
1.8.10 
