|
AnimatLab
2
Test
|
This class is derived from the ActivatedItemMgr and it handles all of the external stimuli. More...
#include <ExternalStimuliMgr.h>
Inheritance diagram for AnimatSim::ExternalStimuli::ExternalStimuliMgr:
Collaboration diagram for AnimatSim::ExternalStimuli::ExternalStimuliMgr:Public Member Functions | |
| ExternalStimuliMgr () | |
| Default constructor. More... | |
| virtual | ~ExternalStimuliMgr () |
| Destructor. More... | |
| virtual bool | AddStimulus (std::string strXml) |
| Creates a new stimulus from an xml definition and adds it to the manager. More... | |
| virtual void | Load (CStdXml &oXml) |
| virtual bool | RemoveStimulus (std::string strID) |
| Removes the stimulus described by strID. More... | |
Public Member Functions inherited from AnimatSim::ActivatedItemMgr | |
| 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 ExternalStimuliMgr * | CastToDerived (AnimatBase *lpBase) |
Static Public Member Functions inherited from AnimatSim::ActivatedItemMgr | |
| static ActivatedItemMgr * | CastToDerived (AnimatBase *lpBase) |
Protected Member Functions | |
| ExternalStimulus * | LoadExternalStimuli (CStdXml &oXml) |
| Loads an external stimuli. More... | |
Additional Inherited Members | |
Protected Attributes inherited from AnimatSim::ActivatedItemMgr | |
| 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.. | |
This class is derived from the ActivatedItemMgr and it handles all of the external stimuli.
Definition at line 19 of file ExternalStimuliMgr.h.
| AnimatSim::ExternalStimuli::ExternalStimuliMgr::ExternalStimuliMgr | ( | ) |
|
virtual |
|
virtual |
Creates a new stimulus from an xml definition and adds it to the manager.
This is primarily used by the GUI to add new stimuli.
| strXml | The xml data for loading in the new stimuli. |
Definition at line 80 of file ExternalStimuliMgr.cpp.
References StdUtils::CStdXml::Deserialize(), StdUtils::CStdXml::FindChildElement(), StdUtils::CStdXml::FindElement(), AnimatSim::ActivatedItem::Initialize(), and LoadExternalStimuli().
Referenced by AnimatSim::Simulator::AddItem().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Loads an external stimuli.
| [in,out] | oXml | The stimulus xml to load. |
| Exception | is thrown if there is a problem loading the stimulus. |
Definition at line 157 of file ExternalStimuliMgr.cpp.
References AnimatSim::ActivatedItemMgr::Add(), AnimatSim::Simulator::CreateObject(), StdUtils::CStdXml::GetChildString(), StdUtils::CStdXml::IntoElem(), AnimatSim::AnimatBase::m_lpSim, StdUtils::CStdXml::OutOfElem(), and AnimatSim::AnimatBase::SetSystemPointers().
Referenced by AddStimulus().
Here is the call graph for this function:
Here is the caller graph for this function:
|
virtual |
Removes the stimulus described by strID.
| strID | GUID ID for the stimulus to remove. |
Definition at line 102 of file ExternalStimuliMgr.cpp.
References AnimatSim::ActivatedItemMgr::Remove().
Referenced by AnimatSim::Simulator::RemoveItem().
Here is the call graph for this function:
Here is the caller graph for this function: