Inheritance diagram for AnimatSimPy::ScriptProcessorPy:

Collaboration diagram for AnimatSimPy::ScriptProcessorPy:

Public Member Functions
virtual void	AfterStepNeuralEngine ()

virtual void	AfterStepNeuralEnginePy (std::string strVal)

virtual std::string	AfterStepNeuralEnginePy ()

virtual void	AfterStepPhysicsEngine ()

virtual void	AfterStepPhysicsEnginePy (std::string strVal)

virtual std::string	AfterStepPhysicsEnginePy ()

virtual void	BeforeStepNeuralEngine ()

virtual void	BeforeStepNeuralEnginePy (std::string strVal)

virtual std::string	BeforeStepNeuralEnginePy ()

virtual void	BeforeStepPhysicsEngine ()

virtual void	BeforeStepPhysicsEnginePy (std::string strVal)

virtual std::string	BeforeStepPhysicsEnginePy ()

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

virtual void	InitPy (std::string strVal)

virtual std::string	InitPy ()

virtual void	Kill (bool bState=true)
	Kills. More...

virtual void	KillPy (std::string strVal)

virtual std::string	KillPy ()

virtual void	KillResetPy (std::string strVal)

virtual std::string	KillResetPy ()

virtual void	Load (StdUtils::CStdXml &oXml)
	Loads the item using an XML data packet. More...

virtual void	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)

virtual void	ResetSimPy (std::string strVal)

virtual std::string	ResetSimPy ()

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 void	SimPausing ()
	Called just before the simulation pauses. More...

virtual void	SimPausingPy (std::string strVal)

virtual std::string	SimPausingPy ()

virtual void	SimStarting ()
	Called just before the simulation starts. More...

virtual void	SimStartingPy (std::string strVal)

virtual std::string	SimStartingPy ()

virtual void	SimStopping ()
	Called just before the simulation stops. More...

virtual void	SimStoppingPy (std::string strVal)

virtual std::string	SimStoppingPy ()

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	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 void	ReInitialize ()
	Re-initialize this object. 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	StepSimulation ()
	Step the simulation for this object. 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...

Protected Member Functions
virtual bool	ExecutePythonScript (const std::string &strPy, bool bThrowError=true)

Protected Attributes
std::string	m_strAfterStepNeuralEnginePy

std::string	m_strAfterStepPhysicsEnginePy

std::string	m_strBeforeStepNeuralEnginePy

std::string	m_strBeforeStepPhysicsEnginePy

std::string	m_strInitPy

std::string	m_strKillPy

std::string	m_strKillResetPy

std::string	m_strResetSimPy

std::string	m_strSimPausingPy

std::string	m_strSimStartingPy

std::string	m_strSimStoppingPy

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

Additional Inherited Members
Static Public Member Functions inherited from AnimatSim::ScriptProcessor
static ScriptProcessor *	CastToDerived (AnimatBase *lpBase)

Detailed Description

Definition at line 6 of file ScriptProcessorPy.h.

Member Function Documentation

void AnimatSimPy::ScriptProcessorPy::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 88 of file ScriptProcessorPy.cpp.

void AnimatSimPy::ScriptProcessorPy::Kill ( bool bState = true )

virtual

Kills.

Called to kill the organism, nervous system, neurons, and body parts. All neural items are disabled to prevent any further neural activity, and all joints are disabled to allow free rotation, and all biomechancical components are disabled so they can no longer produce forces. This method is only relevant to these types of objects, but I am putting the definition in the base class because a variety of different types of classes all need this method and I want it consolidated. Those classes that do not need it do not have to call it or do anything when it is called.

Author: dcofer

Date: 3/3/2011

Parameters

bState true to state.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 125 of file ScriptProcessorPy.cpp.

void AnimatSimPy::ScriptProcessorPy::Load ( StdUtils::CStdXml & oXml )

virtual

Loads the item using an XML data packet.

This method is responsible for loading the structure from a XMl configuration file. You should call this method even in your overriden function becuase it loads all of the base properties for this object like ID and Name. It also includes this object in the simulators AddToObjectList so that the simulator knows about this object when you do a FindObject call. If you do not call this base method then it is up to you to add your item to the simulators list of objects.

Author: dcofer

Date: 3/1/2011

Parameters

[in,out] oXml The CStdXml xml data packet to load.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 257 of file ScriptProcessorPy.cpp.

References AnimatSim::AnimatBase::Enabled(), StdUtils::CStdXml::GetChildBool(), StdUtils::CStdXml::GetChildString(), StdUtils::CStdXml::IntoElem(), AnimatSim::AnimatBase::m_bEnabled, and StdUtils::CStdXml::OutOfElem().

Here is the call graph for this function:

void AnimatSimPy::ScriptProcessorPy::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.

Definition at line 95 of file ScriptProcessorPy.cpp.

bool AnimatSimPy::ScriptProcessorPy::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 153 of file ScriptProcessorPy.cpp.

References AnimatSim::AnimatBase::Enabled(), StdUtils::Std_CheckString(), and StdUtils::Std_ToBool().

Here is the call graph for this function:

void AnimatSimPy::ScriptProcessorPy::SimPausing ( )

virtual

Called just before the simulation pauses.

This method is called on each AnimatBase object when the simulation pauses. It allows it to perform any intialization prior to the pause of the simulation that is needed.

Author: dcofer

Date: 3/1/2011

Reimplemented from AnimatSim::AnimatBase.

Definition at line 141 of file ScriptProcessorPy.cpp.

void AnimatSimPy::ScriptProcessorPy::SimStarting ( )

virtual

Called just before the simulation starts.

This method is called on each AnimatBase object when the simulation starts. It allows it to perform any intialization prior to the beginning of the simulation that is needed.

Author: dcofer

Date: 3/1/2011

Reimplemented from AnimatSim::AnimatBase.

Definition at line 135 of file ScriptProcessorPy.cpp.

void AnimatSimPy::ScriptProcessorPy::SimStopping ( )

virtual

Called just before the simulation stops.

This method is called on each AnimatBase object when the simulation stops. It allows it to perform any intialization prior to the stop of the simulation that is needed.

Author: dcofer

Date: 3/1/2011

Reimplemented from AnimatSim::AnimatBase.

Definition at line 147 of file ScriptProcessorPy.cpp.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation