AnimatLab  2
Test
AnimatSim::ExternalStimuli::PropertyControlStimulus Class Reference

This stimulus enables or disables a joint or body part for a specified period of time. More...

#include <PropertyControlStimulus.h>

+ Inheritance diagram for AnimatSim::ExternalStimuli::PropertyControlStimulus:
+ Collaboration diagram for AnimatSim::ExternalStimuli::PropertyControlStimulus:

Public Member Functions

 PropertyControlStimulus ()
 Default constructor. More...
 
virtual ~PropertyControlStimulus ()
 Destructor. More...
 
virtual void Activate ()
 Activates this item. More...
 
virtual void Deactivate ()
 Deactivates this item. More...
 
std::string Equation ()
 
void Equation (std::string strVal)
 Sets the velocity equation used to control the motor speed over time. More...
 
virtual void FinalValue (float fltVal)
 Sets the final value used to set this property when the simulation ends. More...
 
virtual float FinalValue ()
 Gets the final value used to set this property when the simulation ends. More...
 
virtual void Initialize ()
 Initializes this object. More...
 
virtual void InitialValue (float fltVal)
 Sets the initial value used to set this property when the simulation starts. More...
 
virtual float InitialValue ()
 Gets vthe initial value used to set this property when the simulation starts. More...
 
virtual void Load (CStdXml &oXml)
 
virtual void PropertyName (std::string strPropName)
 Sets the name of the property that this adapter will be setting. More...
 
virtual std::string PropertyName ()
 Gets the name of the property that this adapter will be setting. More...
 
virtual void QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
 Queries this object for a list of properties that can be changed using SetData. 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 void SetThreshold (float fltThreshold)
 Sets the threshold used for setting the value on the target object. More...
 
virtual float SetThreshold ()
 Gets the threshold value used for determining when to set the value on the target object. More...
 
virtual void StepSimulation ()
 Step the simulation for this object. More...
 
virtual std::string TargetID ()
 Gets the GUID ID of the target node that will be enabled. More...
 
virtual void TargetID (std::string strID)
 Sets the GUID ID of the target node to enable. More...
 
virtual AnimatBaseTargetObject ()
 Gets the target object. More...
 
virtual std::string Type ()
 returns the string type name of this object. More...
 
- Public Member Functions inherited from AnimatSim::ExternalStimuli::ExternalStimulus
 ExternalStimulus ()
 Default constructor. More...
 
virtual ~ExternalStimulus ()
 Destructor. More...
 
virtual bool operator< (ActivatedItem *lpItem)
 Less-than comparison operator. More...
 
- Public Member Functions inherited from AnimatSim::ActivatedItem
 ActivatedItem ()
 Default constructor. More...
 
virtual ~ActivatedItem ()
 Destructor. More...
 
virtual bool AlwaysActive ()
 Gets whether this item is always active. More...
 
virtual void AlwaysActive (bool bVal)
 Sets whether this item is always active. More...
 
virtual bool Enabled ()
 Gets whether the item is enabled or not. More...
 
virtual void Enabled (bool bVal)
 Enables the item. More...
 
virtual long EndSlice ()
 Gets the end time slice for deactivation. More...
 
virtual void EndSlice (long lVal, bool bReInit=true)
 
virtual float EndTime ()
 Gets the end simulation time for deactivation. More...
 
virtual void EndTime (float fltVal, bool bReInit=true)
 
bool IsActivated ()
 Query if this object is activated. More...
 
bool IsInitialized ()
 Query if this object is initialized. More...
 
virtual bool LoadedTime ()
 Gets whether time was loaded or time slices. More...
 
virtual void LoadedTime (bool bVal)
 Sets whether time was loaded. More...
 
bool NeedToActivate ()
 Determines if this item needs to be activated. More...
 
bool NeedToDeactivate ()
 Determines if this item needs to be deactivated. More...
 
virtual bool NeedToStep ()
 Tells if this item needs to call StepSimulation or not. More...
 
virtual bool Overlaps (ActivatedItem *lpItem)
 Query if this object overlaps the time period for another ActivatedItem. More...
 
virtual void ReInitialize ()
 Re-initialize this object. More...
 
virtual void ResetSimulation ()
 Resets the simulation back to time 0. More...
 
virtual long StartSlice ()
 Returns the starts slice for activation. More...
 
virtual void StartSlice (long lVal, bool bReInit=true)
 
virtual float StartTime ()
 Gets the simulation start time for activation. More...
 
virtual void StartTime (float fltVal, bool bReInit=true)
 
virtual int StepInterval ()
 Gets the step interval. More...
 
virtual void StepInterval (int iVal)
 Sets the step interval. More...
 
virtual int StepIntervalCount ()
 Gets the step interval count. More...
 
virtual void StepIntervalCount (int iVal)
 Step interval count. More...
 
virtual void TimeStepModified ()
 Notification method that the time step modified has been modified. Objects should recalculate any slice times as needed. 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 float * GetDataPointer (const std::string &strDataType)
 Returns a float pointer to a data item of interest in this object. More...
 
virtual NeuralModuleGetNeuralModule ()
 Gets the neural module. More...
 
virtual NodeGetNode ()
 Gets the node. More...
 
virtual SimulatorGetSimulator ()
 Gets the simulator pointer. More...
 
virtual StructureGetStructure ()
 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 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 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 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 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 PropertyControlStimulusCastToDerived (AnimatBase *lpBase)
 
- Static Public Member Functions inherited from AnimatSim::ExternalStimuli::ExternalStimulus
static ExternalStimulusCastToDerived (AnimatBase *lpBase)
 
- Static Public Member Functions inherited from AnimatSim::ActivatedItem
static ActivatedItemCastToDerived (AnimatBase *lpBase)
 

Protected Member Functions

virtual void SetPropertyValue (float fltVal)
 
- Protected Member Functions inherited from AnimatSim::ActivatedItem
virtual void SetSliceData ()
 

Protected Attributes

AnimatPropertyType m_ePropertyType
 
float m_fltFinalValue
 
float m_fltInitialValue
 
float m_fltPreviousSetVal
 
float m_fltSetThreshold
 
CStdPostFixEval * m_lpEval
 
AnimatBasem_lpTargetObject
 Pointer to the target node.
 
std::string m_strEquation
 
std::string m_strPropertyName
 
std::string m_strTargetID
 GUID ID of the target node to enable.
 
- Protected Attributes inherited from AnimatSim::ActivatedItem
bool m_bAlwaysActive
 Determines whether this item is always active during simulation.
 
bool m_bInitialized
 true if item has been initialized
 
bool m_bIsActivated
 true if item has been activated
 
bool m_bLoadedTime
 
float m_fltEndTime
 
float m_fltStartTime
 
int m_iStepInterval
 
int m_iStepIntervalCount
 Keeps track of how many time steps have occured since it was zeroed again.
 
long m_lEndSlice
 The time slice where this item is deactived.
 
long m_lStartSlice
 The time slice where this item becomes active.
 
- 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::NeuralModulem_lpModule
 The pointer to this items parentNeuralModule. If this is not relevant for this object then this is NULL.
 
Nodem_lpNode
 The pointer to this items parent Node. If this is not relevant for this object then this is NULL.
 
Simulatorm_lpSim
 The pointer to a Simulation.
 
AnimatSim::Environment::Structurem_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..
 

Detailed Description

This stimulus enables or disables a joint or body part for a specified period of time.

Author
dcofer
Date
3/17/2011

Definition at line 19 of file PropertyControlStimulus.h.

Constructor & Destructor Documentation

AnimatSim::ExternalStimuli::PropertyControlStimulus::PropertyControlStimulus ( )

Default constructor.

Author
dcofer
Date
3/17/2011

Definition at line 54 of file PropertyControlStimulus.cpp.

References m_lpTargetObject.

AnimatSim::ExternalStimuli::PropertyControlStimulus::~PropertyControlStimulus ( )
virtual

Destructor.

Author
dcofer
Date
3/17/2011

Definition at line 70 of file PropertyControlStimulus.cpp.

References m_lpTargetObject, and StdUtils::Std_TraceMsg().

+ Here is the call graph for this function:

Member Function Documentation

void AnimatSim::ExternalStimuli::PropertyControlStimulus::Activate ( )
virtual

Activates this item.

Author
dcofer
Date
3/1/2011

Reimplemented from AnimatSim::ActivatedItem.

Definition at line 286 of file PropertyControlStimulus.cpp.

References AnimatSim::ActivatedItem::Activate(), AnimatSim::AnimatBase::m_bEnabled, m_lpTargetObject, and AnimatSim::AnimatBase::SetData().

+ Here is the call graph for this function:

void AnimatSim::ExternalStimuli::PropertyControlStimulus::Deactivate ( )
virtual

Deactivates this item.

Author
dcofer
Date
3/1/2011

Reimplemented from AnimatSim::ActivatedItem.

Definition at line 353 of file PropertyControlStimulus.cpp.

References AnimatSim::ActivatedItem::Deactivate(), AnimatSim::AnimatBase::m_bEnabled, m_lpTargetObject, and AnimatSim::AnimatBase::SetData().

+ Here is the call graph for this function:

void AnimatSim::ExternalStimuli::PropertyControlStimulus::Equation ( std::string  strVal)

Sets the velocity equation used to control the motor speed over time.

Author
dcofer
Date
4/3/2011
Parameters
strValThe post-fix velocity equation string.

Definition at line 126 of file PropertyControlStimulus.cpp.

References StdUtils::CStdPostFixEval::AddVariable(), and StdUtils::CStdPostFixEval::Equation().

+ Here is the call graph for this function:

void AnimatSim::ExternalStimuli::PropertyControlStimulus::FinalValue ( float  fltVal)
virtual

Sets the final value used to set this property when the simulation ends.

Author
dcofer
Date
2/6/2013
Returns
Nothing.

Definition at line 247 of file PropertyControlStimulus.cpp.

float AnimatSim::ExternalStimuli::PropertyControlStimulus::FinalValue ( )
virtual

Gets the final value used to set this property when the simulation ends.

Author
dcofer
Date
2/6/2013
Returns
final value.

Definition at line 260 of file PropertyControlStimulus.cpp.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::PropertyControlStimulus::Initialize ( )
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.

Author
dcofer
Date
3/1/2011

Reimplemented from AnimatSim::ActivatedItem.

Definition at line 273 of file PropertyControlStimulus.cpp.

References AnimatSim::Simulator::FindByID(), AnimatSim::ActivatedItem::Initialize(), AnimatSim::AnimatBase::m_lpSim, m_lpTargetObject, m_strTargetID, and PropertyName().

Referenced by TargetID().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::PropertyControlStimulus::InitialValue ( float  fltVal)
virtual

Sets the initial value used to set this property when the simulation starts.

Author
dcofer
Date
2/6/2013
Returns
Nothing.

Definition at line 222 of file PropertyControlStimulus.cpp.

float AnimatSim::ExternalStimuli::PropertyControlStimulus::InitialValue ( )
virtual

Gets vthe initial value used to set this property when the simulation starts.

Author
dcofer
Date
2/6/2013
Returns
Initial value.

Definition at line 236 of file PropertyControlStimulus.cpp.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::PropertyControlStimulus::PropertyName ( std::string  strPropName)
virtual

Sets the name of the property that this adapter will be setting.

Author
dcofer
Date
2/6/2013
Returns
nothing.

Definition at line 148 of file PropertyControlStimulus.cpp.

References AnimatSim::AnimatBase::HasProperty(), m_lpTargetObject, AnimatSim::AnimatBase::m_strID, StdUtils::Std_IsBlank(), and StdUtils::Std_Trim().

+ Here is the call graph for this function:

std::string AnimatSim::ExternalStimuli::PropertyControlStimulus::PropertyName ( )
virtual

Gets the name of the property that this adapter will be setting.

Author
dcofer
Date
2/6/2013
Returns
Name of property that will be set.

Definition at line 181 of file PropertyControlStimulus.cpp.

Referenced by Initialize(), and SetData().

+ Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::PropertyControlStimulus::QueryProperties ( CStdPtrArray< TypeProperty > &  aryProperties)
virtual

Queries this object for a list of properties that can be changed using SetData.

The method provides a list of the properties that can be set using the SetData method. It gives the property name and the type of data that should be passed to it. Valid date types are Boolean, Float, Integer, and Xml.

Author
dcofer
Date
2/22/2011
Parameters
aryNamesArray list of the property names.
strTypesArray list of the type that is associated with the cooresponding name in the list.
Returns
Nothing.

Reimplemented from AnimatSim::ExternalStimuli::ExternalStimulus.

Definition at line 415 of file PropertyControlStimulus.cpp.

References AnimatSim::ExternalStimuli::ExternalStimulus::QueryProperties().

+ Here is the call graph for this function:

bool AnimatSim::ExternalStimuli::PropertyControlStimulus::SetData ( const std::string &  strDataType,
const std::string &  strValue,
bool  bThrowError = true 
)
virtual

Set a variable based on a string data type name.

This is a generic method that can be used to set any variable in an AnimatBase object by specifying the name of the variable and a string representation of that data. The GUI uses this method to set data into variables in the simulation when the user changes them in the UI. The value string can be as simple as a float or int, or as complex as an xml packet. It is the developers responsibilty to know what type of data is needed and to process it accordingly.

Author
dcofer
Date
2/22/2011
Parameters
strDataTypestring name of the data type to set.
strValueThe string value of the data. It is up to the developer to determine what this should be. For example, in most cases it is simply a float and you just have to convert it to a float and make the appropriate mutator method call. However, it can be any type of string, including an entire xml packet. It is the developers responsibility to know how to set and process the data as required.
bThrowErrortrue to throw error if there is a problem. If false then it will not return an error, just return false.
Returns
true if it succeeds, false if it fails.

Reimplemented from AnimatSim::ExternalStimuli::ExternalStimulus.

Definition at line 365 of file PropertyControlStimulus.cpp.

References FinalValue(), InitialValue(), PropertyName(), AnimatSim::ExternalStimuli::ExternalStimulus::SetData(), SetThreshold(), StdUtils::Std_CheckString(), and TargetID().

+ Here is the call graph for this function:

void AnimatSim::ExternalStimuli::PropertyControlStimulus::SetThreshold ( float  fltThreshold)
virtual

Sets the threshold used for setting the value on the target object.

If the absolute value of the current value - the last value when set is exceeded then this will trigger the adapter to set the value again.

Author
dcofer
Date
2/6/2013
Returns
Pointer to the target object.

Definition at line 195 of file PropertyControlStimulus.cpp.

float AnimatSim::ExternalStimuli::PropertyControlStimulus::SetThreshold ( )
virtual

Gets the threshold value used for determining when to set the value on the target object.

Author
dcofer
Date
2/6/2013
Returns
threshold value.

Definition at line 211 of file PropertyControlStimulus.cpp.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::PropertyControlStimulus::StepSimulation ( )
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.

Author
dcofer
Date
3/1/2011

Reimplemented from AnimatSim::AnimatBase.

Definition at line 326 of file PropertyControlStimulus.cpp.

References AnimatSim::AnimatBase::m_bEnabled, AnimatSim::ActivatedItem::m_fltStartTime, AnimatSim::AnimatBase::m_lpSim, AnimatSim::Simulator::PhysicsStepCount(), AnimatSim::Simulator::PhysicsStepInterval(), StdUtils::CStdPostFixEval::SetVariable(), StdUtils::CStdPostFixEval::Solve(), and AnimatSim::Simulator::Time().

+ Here is the call graph for this function:

std::string AnimatSim::ExternalStimuli::PropertyControlStimulus::TargetID ( )
virtual

Gets the GUID ID of the target node that will be enabled.

Author
dcofer
Date
3/17/2011
Returns
GUID ID of the node.

Definition at line 93 of file PropertyControlStimulus.cpp.

References m_strTargetID.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::ExternalStimuli::PropertyControlStimulus::TargetID ( std::string  strID)
virtual

Sets the GUID ID of the target node to enable.

Author
dcofer
Date
3/17/2011
Parameters
strIDGUID ID.

Definition at line 103 of file PropertyControlStimulus.cpp.

References Initialize(), AnimatSim::ActivatedItem::m_bInitialized, m_strTargetID, and StdUtils::Std_IsBlank().

+ Here is the call graph for this function:

AnimatBase * AnimatSim::ExternalStimuli::PropertyControlStimulus::TargetObject ( )
virtual

Gets the target object.

Author
dcofer
Date
2/6/2013
Returns
Pointer to the target object.

Definition at line 271 of file PropertyControlStimulus.cpp.

References m_lpTargetObject.

std::string AnimatSim::ExternalStimuli::PropertyControlStimulus::Type ( )
virtual

returns the string type name of this object.

Gets the string type description of this object. This is basically just another type of tag that can be applied by the developer of a class to differentiate it. An example of where this is used is in the synaptic types class. I use it to specify the synapse type as gated, modulatory, etc.. They still have different classes, but this gives a string description of that type. It is not mandatory and can be used how the class developer requires.

Author
dcofer
Date
2/22/2011
Returns
string of assigned class type.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 83 of file PropertyControlStimulus.cpp.


The documentation for this class was generated from the following files: