AnimatLab  2
Test
AnimatSim::Robotics::RemoteControlLinkage Class Referenceabstract
+ Inheritance diagram for AnimatSim::Robotics::RemoteControlLinkage:
+ Collaboration diagram for AnimatSim::Robotics::RemoteControlLinkage:

Public Member Functions

virtual float AppliedValue ()
 
virtual void AppliedValue (float fltVal)
 
virtual float * GetDataPointer (const std::string &strDataType)
 Returns a float pointer to a data item of interest in this object. More...
 
virtual void Initialize ()
 Initializes this object. More...
 
virtual bool InLink ()
 Gets the inlink value. More...
 
virtual void InLink (bool bVal)
 Sets the inlink property. More...
 
virtual void Load (CStdXml &oXml)
 
virtual void ParentRemoteControl (RemoteControl *lpParent)
 
virtual RemoteControlParentRemoteControl ()
 
virtual int PropertyID ()
 
virtual void PropertyID (int iID, bool bCreateDataTypes=true)
 
virtual std::string PropertyName ()
 Gets the property name. More...
 
virtual void PropertyName (std::string strName)
 Sets the property name. More...
 
virtual void QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
 Queries this object for a list of properties that can be changed using SetData. 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 void SetupIO ()
 This method is called after all connections to whatever control board have been made. It calls each parts SetupIO method. For example, We connect to a Firmata microcontroller like an Arduino, and then do a setup that could take some time. We should not attempt to setup any of the pins until after the board itself has been setup. After that we need to loop through and setup all the parts. More...
 
virtual void ShutdownIO ()
 This method is called just before the IO thread is closed down. It gives the IO objects a chance to do any required cleanup. More...
 
virtual std::string SourceDataTypeID ()
 Gets the target data type. More...
 
virtual void SourceDataTypeID (std::string strTypeID)
 Sets the target data type. More...
 
virtual std::string SourceID ()
 Gets the source ID. More...
 
virtual void SourceID (std::string strID)
 Sets the source ID. More...
 
virtual void StepIO ()
 This method is called from within the IO thread. It calls StepIO for each part. More...
 
virtual void StepSimulation ()
 Step the simulation for this object. More...
 
virtual std::string TargetDataTypeID ()
 Gets the target data type. More...
 
virtual void TargetDataTypeID (std::string strTypeID)
 Sets the target data type. More...
 
virtual std::string TargetID ()
 Gets the target ID. More...
 
virtual void TargetID (std::string strID)
 Sets the target ID. 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 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 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 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 RemoteControlLinkageCastToDerived (AnimatBase *lpBase)
 

Public Attributes

RemoteControlData m_Data
 This is a set of data that is associated with this linkage.
 

Protected Member Functions

virtual void ApplyValue (float fltData)
 
virtual float CalculateAppliedValue (float fltData)=0
 

Protected Attributes

bool m_bInLink
 
float m_fltAppliedValue
 The total value applied during a time step.
 
int m_iPropertyID
 
int m_iTargetDataType
 integer index of the target data type
 
RemoteControlm_lpParentRemoteControl
 Pointer tho the parent remote control.
 
AnimatBasem_lpSource
 Source object we are inserting from.
 
float * m_lpSourceData
 Pointer to the source data variable.
 
AnimatBasem_lpTarget
 Target object we are inserting into.
 
float * m_lpTargetData
 Pointer to the external value of the linked target.
 
std::string m_strPropertyName
 Name of the property that will be used for the data type if required.
 
std::string m_strSourceDataTypeID
 ID of the source data type. This is only used during loading.
 
std::string m_strSourceID
 ID of the source. This is only used during loading.
 
std::string m_strTargetDataTypeID
 ID of the target data type. This is only used during loading.
 
std::string m_strTargetID
 ID of the target. This is only used during loading.
 
- 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

Definition at line 62 of file RemoteControlLinkage.h.

Member Function Documentation

float * AnimatSim::Robotics::RemoteControlLinkage::GetDataPointer ( const std::string &  strDataType)
virtual

Returns a float pointer to a data item of interest in this object.

This is a generic method used to get a pointer to data variable of interest. It is used by a variety of systems in the simulation. The most prominent are the data charting and stimulus classes. Within this method we associate a variable with a string name. By passing in the name of the data type we are interested in we can recieve back a float pointer to that data type. We can use that to read or set the data item in other classes. For example, the data charting system gets the pointer and then each time it needs to log a data point it reads the value into an array.

Author
dcofer
Date
2/22/2011
Parameters
strDataTypename of the data item for which we are looking.
Returns
float pointer of the data item. If not found then it throws an exception.
Exceptions
IfDataType is not found.

Reimplemented from AnimatSim::AnimatBase.

Reimplemented in AnimatSim::Robotics::PulsedLinkage.

Definition at line 311 of file RemoteControlLinkage.cpp.

References m_fltAppliedValue, AnimatSim::AnimatBase::m_strName, and StdUtils::Std_CheckString().

Referenced by AnimatSim::Robotics::PulsedLinkage::GetDataPointer().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void AnimatSim::Robotics::RemoteControlLinkage::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 428 of file RemoteControlLinkage.cpp.

References AnimatSim::Simulator::FindByID(), AnimatSim::AnimatBase::GetDataPointer(), m_bInLink, m_lpParentRemoteControl, AnimatSim::AnimatBase::m_lpSim, m_lpSource, m_lpSourceData, m_lpTarget, m_lpTargetData, m_strSourceDataTypeID, m_strSourceID, m_strTargetDataTypeID, m_strTargetID, and StdUtils::Std_IsBlank().

Referenced by AnimatSim::Robotics::RemoteControl::AddRemoteControlLinkage(), SourceDataTypeID(), SourceID(), TargetDataTypeID(), and TargetID().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool AnimatSim::Robotics::RemoteControlLinkage::InLink ( )
virtual

Gets the inlink value.

Author
dcofer
Date
3/18/2011
Returns
inlink.

Definition at line 290 of file RemoteControlLinkage.cpp.

References m_bInLink.

Referenced by AnimatSim::Robotics::RemoteControl::LoadRemoteControlLinkage(), and AnimatSim::Robotics::RemoteControl::RemoveRemoteControlLinkage().

+ Here is the caller graph for this function:

void AnimatSim::Robotics::RemoteControlLinkage::InLink ( bool  bVal)
virtual

Sets the inlink property.

Author
dcofer
Date
3/18/2011
Parameters
strTypeinlink value.

Definition at line 300 of file RemoteControlLinkage.cpp.

References m_bInLink.

std::string AnimatSim::Robotics::RemoteControlLinkage::PropertyName ( )
virtual

Gets the property name.

Author
dcofer
Date
3/18/2011
Returns
property name.

Definition at line 252 of file RemoteControlLinkage.cpp.

References m_strPropertyName.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Robotics::RemoteControlLinkage::PropertyName ( std::string  strTypeID)
virtual

Sets the property name.

Author
dcofer
Date
3/18/2011
Parameters
strTypeproperty name.

Definition at line 262 of file RemoteControlLinkage.cpp.

References m_Data, m_lpParentRemoteControl, AnimatSim::Robotics::RemoteControlData::m_strProperty, m_strPropertyName, and StdUtils::Std_CheckString().

+ Here is the call graph for this function:

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

Reimplemented in AnimatSim::Robotics::PulsedLinkage, and AnimatSim::Robotics::PassThroughLinkage.

Definition at line 373 of file RemoteControlLinkage.cpp.

References AnimatSim::AnimatBase::QueryProperties().

Referenced by AnimatSim::Robotics::PassThroughLinkage::QueryProperties(), and AnimatSim::Robotics::PulsedLinkage::QueryProperties().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void AnimatSim::Robotics::RemoteControlLinkage::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::Robotics::PulsedLinkage.

Definition at line 490 of file RemoteControlLinkage.cpp.

References m_fltAppliedValue.

Referenced by AnimatSim::Robotics::PulsedLinkage::ResetSimulation().

+ Here is the caller graph for this function:

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

Reimplemented in AnimatSim::Robotics::PulsedLinkage, and AnimatSim::Robotics::PassThroughLinkage.

Definition at line 323 of file RemoteControlLinkage.cpp.

References AnimatSim::AnimatBase::Enabled(), PropertyName(), AnimatSim::AnimatBase::SetData(), SourceDataTypeID(), SourceID(), StdUtils::Std_CheckString(), StdUtils::Std_ToBool(), TargetDataTypeID(), and TargetID().

Referenced by AnimatSim::Robotics::PassThroughLinkage::SetData(), and AnimatSim::Robotics::PulsedLinkage::SetData().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void AnimatSim::Robotics::RemoteControlLinkage::SetupIO ( )
virtual

This method is called after all connections to whatever control board have been made. It calls each parts SetupIO method. For example, We connect to a Firmata microcontroller like an Arduino, and then do a setup that could take some time. We should not attempt to setup any of the pins until after the board itself has been setup. After that we need to loop through and setup all the parts.

Author
dcofer
Date
5/1/2014

Definition at line 401 of file RemoteControlLinkage.cpp.

void AnimatSim::Robotics::RemoteControlLinkage::ShutdownIO ( )
virtual

This method is called just before the IO thread is closed down. It gives the IO objects a chance to do any required cleanup.

Author
dcofer
Date
5/12/2014

Definition at line 424 of file RemoteControlLinkage.cpp.

std::string AnimatSim::Robotics::RemoteControlLinkage::SourceDataTypeID ( )
virtual

Gets the target data type.

Author
dcofer
Date
3/18/2011
Returns
Target data type.

Definition at line 193 of file RemoteControlLinkage.cpp.

References m_strSourceDataTypeID.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Robotics::RemoteControlLinkage::SourceDataTypeID ( std::string  strTypeID)
virtual

Sets the target data type.

Author
dcofer
Date
3/18/2011
Parameters
strTypeTarget DataType.

Definition at line 203 of file RemoteControlLinkage.cpp.

References Initialize(), and m_strSourceDataTypeID.

+ Here is the call graph for this function:

std::string AnimatSim::Robotics::RemoteControlLinkage::SourceID ( )
virtual

Gets the source ID.

Author
dcofer
Date
3/18/2011
Returns
Source ID.

Definition at line 145 of file RemoteControlLinkage.cpp.

References m_strSourceID.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Robotics::RemoteControlLinkage::SourceID ( std::string  strID)
virtual

Sets the source ID.

Author
dcofer
Date
3/18/2011
Parameters
strTypeTarget DataType.

Definition at line 155 of file RemoteControlLinkage.cpp.

References Initialize(), and m_strSourceID.

+ Here is the call graph for this function:

void AnimatSim::Robotics::RemoteControlLinkage::StepIO ( )
virtual

This method is called from within the IO thread. It calls StepIO for each part.

Author
dcofer
Date
5/2/2014

Reimplemented in AnimatSim::Robotics::PulsedLinkage.

Definition at line 412 of file RemoteControlLinkage.cpp.

void AnimatSim::Robotics::RemoteControlLinkage::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.

Reimplemented in AnimatSim::Robotics::PulsedLinkage.

Definition at line 495 of file RemoteControlLinkage.cpp.

References AnimatSim::AnimatBase::m_bEnabled, m_bInLink, m_Data, and m_lpSourceData.

std::string AnimatSim::Robotics::RemoteControlLinkage::TargetDataTypeID ( )
virtual

Gets the target data type.

Author
dcofer
Date
3/18/2011
Returns
Target data type.

Definition at line 217 of file RemoteControlLinkage.cpp.

References m_strTargetDataTypeID.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Robotics::RemoteControlLinkage::TargetDataTypeID ( std::string  strTypeID)
virtual

Sets the target data type.

Author
dcofer
Date
3/18/2011
Parameters
strTypeTarget DataType.

Definition at line 227 of file RemoteControlLinkage.cpp.

References Initialize(), and m_strTargetDataTypeID.

+ Here is the call graph for this function:

std::string AnimatSim::Robotics::RemoteControlLinkage::TargetID ( )
virtual

Gets the target ID.

Author
dcofer
Date
3/18/2011
Returns
Target ID.

Definition at line 169 of file RemoteControlLinkage.cpp.

References m_strTargetID.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Robotics::RemoteControlLinkage::TargetID ( std::string  strID)
virtual

Sets the target ID.

Author
dcofer
Date
3/18/2011
Parameters
strTypeTarget ID.

Definition at line 179 of file RemoteControlLinkage.cpp.

References Initialize(), and m_strTargetID.

+ Here is the call graph for this function:

Member Data Documentation

bool AnimatSim::Robotics::RemoteControlLinkage::m_bInLink
protected

True if this is an incoming link from the remote device to the simulation False if this is an outgoing link from the simulation to the remote device.

Definition at line 107 of file RemoteControlLinkage.h.

Referenced by Initialize(), InLink(), and StepSimulation().

int AnimatSim::Robotics::RemoteControlLinkage::m_iPropertyID
protected

This is used when UseRemoteDataTypes is set to false. It is either the source or target data type ID. It depends on whether InLink is true or false.

Definition at line 88 of file RemoteControlLinkage.h.


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