External stimulus base class. More...

#include <ExternalStimulus.h>

Inheritance diagram for AnimatSim::ExternalStimuli::ExternalStimulus:

Collaboration diagram for AnimatSim::ExternalStimuli::ExternalStimulus:

Public Member Functions
	ExternalStimulus ()
	Default constructor. More...

virtual	~ExternalStimulus ()
	Destructor. More...

virtual bool	operator< (ActivatedItem *lpItem)
	Less-than comparison operator. 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...

Public Member Functions inherited from AnimatSim::ActivatedItem
	ActivatedItem ()
	Default constructor. More...

virtual	~ActivatedItem ()
	Destructor. More...

virtual void	Activate ()
	Activates this item. 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 void	Deactivate ()
	Deactivates this item. 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)

virtual void	Initialize ()
	Initializes this object. More...

bool	IsActivated ()
	Query if this object is activated. More...

bool	IsInitialized ()
	Query if this object is initialized. More...

virtual void	Load (CStdXml &oXml)

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 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 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	StepSimulation ()
	Step the simulation for this object. 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 ExternalStimulus *	CastToDerived (AnimatBase *lpBase)

Static Public Member Functions inherited from AnimatSim::ActivatedItem
static ActivatedItem *	CastToDerived (AnimatBase *lpBase)

Additional Inherited Members
Protected Member Functions inherited from AnimatSim::ActivatedItem
virtual void	SetSliceData ()

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::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..

Detailed Description

External stimulus base class.

This is the base class for all stimulus types. If you want to create a new stimulus it needs to be derived from this base class.

Author: dcofer

Date: 3/16/2011

Definition at line 28 of file ExternalStimulus.h.

Constructor & Destructor Documentation

ExternalStimulus::ExternalStimulus ( )

Default constructor.

Author: dcofer

Date: 3/16/2011

Definition at line 54 of file ExternalStimulus.cpp.

ExternalStimulus::~ExternalStimulus ( )

virtual

Destructor.

Author: dcofer

Date: 3/16/2011

Definition at line 64 of file ExternalStimulus.cpp.

Member Function Documentation

bool ExternalStimulus::operator< ( ActivatedItem * lpItem )

virtual

Less-than comparison operator.

This is a pure virtual definition of this method. It must be defined in the derived class.

Author: dcofer

Date: 3/1/2011

Parameters

[in,out] lpItem The pointer to an item to compare with.

Returns: true if the first parameter is less than the second.

Implements AnimatSim::ActivatedItem.

Definition at line 97 of file ExternalStimulus.cpp.

References AnimatSim::ActivatedItem::m_lEndSlice, and AnimatSim::ActivatedItem::m_lStartSlice.

void ExternalStimulus::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

aryNames	Array list of the property names.
strTypes	Array list of the type that is associated with the cooresponding name in the list.

Returns: Nothing.

Reimplemented from AnimatSim::AnimatBase.

Reimplemented in AnimatSim::ExternalStimuli::CurrentStimulus, AnimatSim::ExternalStimuli::ForceStimulus, AnimatSim::ExternalStimuli::PropertyControlStimulus, AnimatSim::ExternalStimuli::InverseMuscleCurrent, AnimatSim::ExternalStimuli::MotorStimulus, AnimatSim::ExternalStimuli::VoltageClamp, AnimatSim::ExternalStimuli::ExternalInputStimulus, and AnimatSim::ExternalStimuli::EnablerStimulus.

Definition at line 90 of file ExternalStimulus.cpp.

References AnimatSim::AnimatBase::QueryProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ExternalStimulus::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

strDataType	string name of the data type to set.
strValue	The 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.
bThrowError	true 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::ActivatedItem.

Definition at line 68 of file ExternalStimulus.cpp.

References AnimatSim::Simulator::GetExternalStimuliMgr(), AnimatSim::AnimatBase::m_lpSim, AnimatSim::ActivatedItemMgr::ReInitialize(), AnimatSim::ActivatedItem::SetData(), and StdUtils::Std_CheckString().

Referenced by AnimatSim::ExternalStimuli::EnablerStimulus::SetData(), AnimatSim::ExternalStimuli::ExternalInputStimulus::SetData(), AnimatSim::ExternalStimuli::VoltageClamp::SetData(), AnimatSim::ExternalStimuli::MotorStimulus::SetData(), AnimatSim::ExternalStimuli::InverseMuscleCurrent::SetData(), AnimatSim::ExternalStimuli::PropertyControlStimulus::SetData(), AnimatSim::ExternalStimuli::ForceStimulus::SetData(), and AnimatSim::ExternalStimuli::CurrentStimulus::SetData().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation