Base class for all activated items. More...

#include <ActivatedItem.h>

Inheritance diagram for AnimatSim::ActivatedItem:

Collaboration diagram for AnimatSim::ActivatedItem:

Public Member Functions
	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	operator< (ActivatedItem *lpItem)=0
	Less-than comparison operator. 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 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 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 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	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 ActivatedItem *	CastToDerived (AnimatBase *lpBase)

Protected Member Functions
virtual void	SetSliceData ()

Protected Attributes
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

Base class for all activated items.

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. They have a start time and end time defined for them. When the simulation reaches the start time then it activates the item and when the sim reaches the end time it is deactivated. It is also possible to set it so that it is always active during the entire simulation. This base class and the ActivatedItemMgr take care of most of the details to allow this functionality to work.

Author: dcofer

Date: 3/1/2011

Definition at line 27 of file ActivatedItem.h.

Constructor & Destructor Documentation

AnimatSim::ActivatedItem::ActivatedItem ( )

Default constructor.

Author: dcofer

Date: 3/1/2011

Definition at line 47 of file ActivatedItem.cpp.

References m_bAlwaysActive, AnimatSim::AnimatBase::m_bEnabled, m_bInitialized, m_bIsActivated, m_bLoadedTime, m_fltEndTime, m_fltStartTime, m_iStepInterval, m_iStepIntervalCount, m_lEndSlice, and m_lStartSlice.

AnimatSim::ActivatedItem::~ActivatedItem ( )

virtual

Destructor.

Author: dcofer

Date: 3/1/2011

Definition at line 70 of file ActivatedItem.cpp.

Member Function Documentation

void AnimatSim::ActivatedItem::Activate ( )

virtual

Activates this item.

Author: dcofer

Date: 3/1/2011

Reimplemented in AnimatSim::ExternalStimuli::CurrentStimulus, AnimatSim::Charting::DataChart, AnimatSim::ExternalStimuli::InverseMuscleCurrent, AnimatSim::ExternalStimuli::PropertyControlStimulus, AnimatSim::ExternalStimuli::MotorStimulus, AnimatSim::ExternalStimuli::VoltageClamp, VortexAnimatSim::ExternalStimuli::VsMotorVelocityStimulus, AnimatSim::ExternalStimuli::ExternalInputStimulus, and AnimatSim::ExternalStimuli::EnablerStimulus.

Definition at line 427 of file ActivatedItem.cpp.

References m_bIsActivated.

Referenced by AnimatSim::ExternalStimuli::EnablerStimulus::Activate(), AnimatSim::ExternalStimuli::ExternalInputStimulus::Activate(), AnimatSim::ExternalStimuli::MotorStimulus::Activate(), AnimatSim::ExternalStimuli::VoltageClamp::Activate(), AnimatSim::ExternalStimuli::PropertyControlStimulus::Activate(), AnimatSim::ExternalStimuli::InverseMuscleCurrent::Activate(), AnimatSim::Charting::DataChart::Activate(), AnimatSim::ExternalStimuli::CurrentStimulus::Activate(), Enabled(), and AnimatSim::ActivatedItemMgr::StepSimulation().

Here is the caller graph for this function:

bool AnimatSim::ActivatedItem::AlwaysActive ( )

virtual

Gets whether this item is always active.

Author: dcofer

Date: 3/1/2011

Returns: true if always active, false if not.

Definition at line 337 of file ActivatedItem.cpp.

References m_bAlwaysActive.

Referenced by AnimatSim::ExternalStimuli::CurrentStimulus::AlwaysActive(), SetData(), and AnimatSim::Charting::DataChart::SetStartEndTime().

Here is the caller graph for this function:

void AnimatSim::ActivatedItem::AlwaysActive ( bool bVal )

virtual

Sets whether this item is always active.

Author: dcofer

Date: 3/1/2011

Parameters

bVal	true if always active.

Reimplemented in AnimatSim::ExternalStimuli::CurrentStimulus.

Definition at line 350 of file ActivatedItem.cpp.

References m_bAlwaysActive.

void AnimatSim::ActivatedItem::Deactivate ( )

virtual

Deactivates this item.

Author: dcofer

Date: 3/1/2011

Definition at line 441 of file ActivatedItem.cpp.

References m_bIsActivated.

Here is the caller graph for this function:

bool AnimatSim::ActivatedItem::Enabled ( )

virtual

Gets whether the item is enabled or not.

Author: dcofer

Date: 3/1/2011

Returns: true if it enabled, false if not.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 85 of file ActivatedItem.cpp.

References AnimatSim::AnimatBase::m_bEnabled.

Referenced by SetData(), and AnimatSim::ActivatedItemMgr::StepSimulation().

Here is the caller graph for this function:

void AnimatSim::ActivatedItem::Enabled ( bool bVal )

virtual

Enables the item.

Author: dcofer

Date: 3/1/2011

Parameters

bVal	true to enable, false to disable.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 98 of file ActivatedItem.cpp.

References Activate(), Deactivate(), IsActivated(), AnimatSim::AnimatBase::m_bEnabled, AnimatSim::AnimatBase::m_lpSim, NeedToActivate(), AnimatSim::Simulator::Paused(), and AnimatSim::Simulator::TimeSlice().

Here is the call graph for this function:

long AnimatSim::ActivatedItem::EndSlice ( )

virtual

Gets the end time slice for deactivation.

Author: dcofer

Date: 3/1/2011

Returns: End time slice for deactivation.

Definition at line 180 of file ActivatedItem.cpp.

References m_lEndSlice.

Referenced by AnimatSim::Recording::SimulationRecorder::Add(), AnimatSim::Simulator::MoveKeyFrame(), and Overlaps().

Here is the caller graph for this function:

float AnimatSim::ActivatedItem::EndTime ( )

virtual

Gets the end simulation time for deactivation.

Author: dcofer

Date: 3/1/2011

Returns: the end simulation time for deactivation..

Definition at line 246 of file ActivatedItem.cpp.

References m_fltEndTime.

Referenced by AnimatSim::Charting::DataChart::ReInitialize(), SetData(), and AnimatSim::Charting::DataChart::SetData().

Here is the caller graph for this function:

void AnimatSim::ActivatedItem::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::AnimatBase.

Definition at line 475 of file ActivatedItem.cpp.

References AnimatSim::AnimatBase::Initialize(), and m_bInitialized.

Referenced by AnimatSim::Recording::SimulationRecorder::Add(), AnimatSim::ExternalStimuli::ExternalStimuliMgr::AddStimulus(), AnimatSim::Charting::ArrayChart::Initialize(), AnimatSim::ExternalStimuli::EnablerStimulus::Initialize(), AnimatSim::ExternalStimuli::ExternalInputStimulus::Initialize(), AnimatSim::ExternalStimuli::MotorStimulus::Initialize(), AnimatSim::ExternalStimuli::VoltageClamp::Initialize(), AnimatSim::ExternalStimuli::PropertyControlStimulus::Initialize(), AnimatSim::ExternalStimuli::InverseMuscleCurrent::Initialize(), AnimatSim::ExternalStimuli::ForceStimulus::Initialize(), AnimatSim::ExternalStimuli::CurrentStimulus::Initialize(), AnimatSim::Charting::DataChart::Initialize(), and ReInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

bool AnimatSim::ActivatedItem::IsActivated ( )

Query if this object is activated.

Author: dcofer

Date: 3/1/2011

Returns: true if activated, false if not.

Definition at line 363 of file ActivatedItem.cpp.

References m_bIsActivated.

Referenced by Enabled(), AnimatSim::ActivatedItemMgr::Remove(), and AnimatSim::ActivatedItemMgr::StepSimulation().

Here is the caller graph for this function:

bool AnimatSim::ActivatedItem::IsInitialized ( )

Query if this object is initialized.

Author: dcofer

Date: 3/1/2011

Returns: true if initialized, false if not.

Definition at line 375 of file ActivatedItem.cpp.

References m_bInitialized.

bool AnimatSim::ActivatedItem::LoadedTime ( )

virtual

Gets whether time was loaded or time slices.

Author: dcofer

Date: 3/1/2011

Returns: true if time loaded, false if timeslices loaded.

Definition at line 121 of file ActivatedItem.cpp.

References m_bLoadedTime.

void AnimatSim::ActivatedItem::LoadedTime ( bool bVal )

virtual

Sets whether time was loaded.

Author: dcofer

Date: 3/1/2011

Parameters

bVal	true if time loaded.

Definition at line 134 of file ActivatedItem.cpp.

References m_bLoadedTime.

bool AnimatSim::ActivatedItem::NeedToActivate ( )

Determines if this item needs to be activated.

Author: dcofer

Date: 3/1/2011

Returns: true if the item is enabled and it is always active or if the current simulation time is within the start and end times.

Definition at line 389 of file ActivatedItem.cpp.

References m_bAlwaysActive, AnimatSim::AnimatBase::m_bEnabled, m_bIsActivated, m_lEndSlice, AnimatSim::AnimatBase::m_lpSim, and AnimatSim::Simulator::TimeSlice().

Referenced by Enabled(), and AnimatSim::ActivatedItemMgr::StepSimulation().

Here is the call graph for this function:

Here is the caller graph for this function:

bool AnimatSim::ActivatedItem::NeedToDeactivate ( )

Determines if this item needs to be deactivated.

Author: dcofer

Date: 3/1/2011

Returns: true if the item is not enabled or it is not always active and the current simulation time is outside of the start and end times.

Definition at line 408 of file ActivatedItem.cpp.

References m_bAlwaysActive, AnimatSim::AnimatBase::m_bEnabled, m_bIsActivated, m_lEndSlice, AnimatSim::AnimatBase::m_lpSim, and AnimatSim::Simulator::TimeSlice().

Referenced by AnimatSim::ActivatedItemMgr::StepSimulation().

Here is the call graph for this function:

Here is the caller graph for this function:

bool AnimatSim::ActivatedItem::NeedToStep ( )

virtual

Tells if this item needs to call StepSimulation or not.

Author: dcofer

Date: 3/1/2011

Returns: If StepInterval is less than 1 then it always returns true. Otherwise, it returns true if the StepIntervalCount is equal to the StepInterval.

Definition at line 524 of file ActivatedItem.cpp.

References m_iStepInterval, and m_iStepIntervalCount.

Referenced by AnimatSim::ActivatedItemMgr::StepSimulation().

Here is the caller graph for this function:

bool AnimatSim::ActivatedItem::operator< ( ActivatedItem * lpItem )

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

Implemented in AnimatSim::Charting::DataChart, AnimatSim::ExternalStimuli::ExternalStimulus, and AnimatSim::Recording::KeyFrame.

bool AnimatSim::ActivatedItem::Overlaps ( ActivatedItem * lpItem )

virtual

Query if this object overlaps the time period for another ActivatedItem.

Author: dcofer

Date: 3/1/2011

Parameters

[in,out] lpItem Pointer to the item to test against.

Returns: true if it overlaps, false if not.

Definition at line 463 of file ActivatedItem.cpp.

References EndSlice(), and StartSlice().

Referenced by AnimatSim::Recording::SimulationRecorder::Add().

Here is the call graph for this function:

Here is the caller graph for this function:

void AnimatSim::ActivatedItem::ReInitialize ( )

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.

Author: dcofer

Date: 3/1/2011

Reimplemented from AnimatSim::AnimatBase.

Reimplemented in AnimatSim::Charting::DataChart, and AnimatSim::Charting::ArrayChart.

Definition at line 499 of file ActivatedItem.cpp.

References Initialize(), and m_bInitialized.

Referenced by TimeStepModified().

Here is the call graph for this function:

Here is the caller graph for this function:

void AnimatSim::ActivatedItem::ResetSimulation ( )

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.

Author: dcofer

Date: 3/1/2011

Reimplemented from AnimatSim::AnimatBase.

Reimplemented in AnimatSim::Charting::DataChart, AnimatSim::ExternalStimuli::CurrentStimulus, AnimatSim::ExternalStimuli::ForceStimulus, VortexAnimatSim::ExternalStimuli::VsForceStimulus, AnimatSim::ExternalStimuli::InverseMuscleCurrent, AnimatSim::ExternalStimuli::MotorStimulus, AnimatSim::ExternalStimuli::VoltageClamp, VortexAnimatSim::ExternalStimuli::VsMotorVelocityStimulus, and AnimatSim::Charting::FileChart.

Definition at line 446 of file ActivatedItem.cpp.

References m_bIsActivated.

Referenced by AnimatSim::ExternalStimuli::MotorStimulus::ResetSimulation(), AnimatSim::ExternalStimuli::VoltageClamp::ResetSimulation(), AnimatSim::ExternalStimuli::ForceStimulus::ResetSimulation(), AnimatSim::ExternalStimuli::CurrentStimulus::ResetSimulation(), and AnimatSim::Charting::DataChart::ResetSimulation().

Here is the caller graph for this function:

bool AnimatSim::ActivatedItem::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::AnimatBase.

Definition at line 540 of file ActivatedItem.cpp.

References AlwaysActive(), Enabled(), EndTime(), AnimatSim::AnimatBase::SetData(), StartTime(), StdUtils::Std_CheckString(), StdUtils::Std_ToBool(), and StepInterval().

Referenced by AnimatSim::ExternalStimuli::ExternalStimulus::SetData(), and AnimatSim::Charting::DataChart::SetData().

Here is the call graph for this function:

Here is the caller graph for this function:

long AnimatSim::ActivatedItem::StartSlice ( )

virtual

Returns the starts slice for activation.

Author: dcofer

Date: 3/1/2011

Returns: Start time slice for activation.

Definition at line 147 of file ActivatedItem.cpp.

References m_lStartSlice.

Referenced by AnimatSim::Recording::SimulationRecorder::Add(), AnimatSim::Simulator::MoveKeyFrame(), and Overlaps().

Here is the caller graph for this function:

float AnimatSim::ActivatedItem::StartTime ( )

virtual

Gets the simulation start time for activation.

Author: dcofer

Date: 3/1/2011

Returns: Time for activation.

Definition at line 213 of file ActivatedItem.cpp.

References m_fltStartTime.

Referenced by AnimatSim::Charting::DataChart::ReInitialize(), SetData(), and AnimatSim::Charting::DataChart::SetData().

Here is the caller graph for this function:

int AnimatSim::ActivatedItem::StepInterval ( )

virtual

Gets the step interval.

Author: dcofer

Date: 3/1/2011

Returns: Step Interval value.

Definition at line 279 of file ActivatedItem.cpp.

References m_iStepInterval.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::ActivatedItem::StepInterval ( int iVal )

virtual

Sets the step interval.

Author: dcofer

Date: 3/1/2011

Parameters

iVal	The step interval value.

Definition at line 292 of file ActivatedItem.cpp.

References m_iStepInterval, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

int AnimatSim::ActivatedItem::StepIntervalCount ( )

virtual

Gets the step interval count.

Keeps track of how many iterations till we reach the StepInterval and call StepSimulation again.

Author: dcofer

Date: 3/1/2011

Returns: Step interval count.

Definition at line 311 of file ActivatedItem.cpp.

References m_iStepIntervalCount.

void AnimatSim::ActivatedItem::StepIntervalCount ( int iVal )

virtual

Step interval count.

Author: dcofer

Date: 3/1/2011

Parameters

iVal	The step interval count value.

Definition at line 324 of file ActivatedItem.cpp.

References m_iStepIntervalCount.

void AnimatSim::ActivatedItem::TimeStepModified ( )

virtual

Notification method that the time step modified has been modified. Objects should recalculate any slice times as needed.

Author: dcofer

Date: 1/28/2012

Reimplemented from AnimatSim::AnimatBase.

Definition at line 507 of file ActivatedItem.cpp.

References ReInitialize().

Here is the call graph for this function:

Member Data Documentation

bool AnimatSim::ActivatedItem::m_bLoadedTime

protected

Keeps track of whether we loaded in time values or time slices. This is used during the initialization procedures.

Definition at line 33 of file ActivatedItem.h.

Referenced by ActivatedItem(), and LoadedTime().

float AnimatSim::ActivatedItem::m_fltEndTime

protected

The actual simulation time where this item becomes deactivated. This is used to calculate the EndSlice.

Definition at line 47 of file ActivatedItem.h.

Referenced by ActivatedItem(), EndTime(), AnimatSim::ExternalStimuli::InverseMuscleCurrent::Initialize(), and AnimatSim::Charting::DataChart::ReInitialize().

float AnimatSim::ActivatedItem::m_fltStartTime

protected

The actual simulation time where this item becomes activated. This is used to calculate the StartSlice.

Definition at line 43 of file ActivatedItem.h.

Referenced by ActivatedItem(), AnimatSim::ExternalStimuli::CurrentStimulus::GetCurrentOn(), AnimatSim::ExternalStimuli::InverseMuscleCurrent::Initialize(), AnimatSim::Charting::DataChart::ReInitialize(), StartTime(), VortexAnimatSim::ExternalStimuli::VsMotorVelocityStimulus::StepSimulation(), AnimatSim::ExternalStimuli::MotorStimulus::StepSimulation(), and AnimatSim::ExternalStimuli::PropertyControlStimulus::StepSimulation().

int AnimatSim::ActivatedItem::m_iStepInterval

protected

Tells how many timesteps should elapse before it call StepSimulation again. This is used in cases where we do not want the item to be run every simulation time step, but instead of X steps. StepIntervalCount keeps track of how many steps until the interval is met.

Definition at line 53 of file ActivatedItem.h.

Referenced by ActivatedItem(), AnimatSim::ExternalStimuli::InverseMuscleCurrent::Initialize(), NeedToStep(), and StepInterval().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation