AnimatLab  2
Test
AnimatSim::Gains::Gain Class Referenceabstract

The Gain base class. More...

#include <Gain.h>

+ Inheritance diagram for AnimatSim::Gains::Gain:
+ Collaboration diagram for AnimatSim::Gains::Gain:

Public Member Functions

 Gain ()
 Default constructor. More...
 
virtual ~Gain ()
 Destructor. More...
 
virtual float CalculateGain (float fltInput)=0
 Calculates the gain. More...
 
virtual void Copy (CStdSerialize *lpSource)
 
virtual void Load (CStdXml &oXml)
 
float LowerLimit ()
 Gets the lower limit. More...
 
void LowerLimit (float fltVal)
 Sets the Lower limit. More...
 
float LowerOutput ()
 Gets the lower output. More...
 
void LowerOutput (float fltVal)
 Sets the Lower output. 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...
 
float UpperLimit ()
 Gets the upper limit. More...
 
void UpperLimit (float fltVal)
 Sets the Upper limit. More...
 
float UpperOutput ()
 Gets the upper output. More...
 
void UpperOutput (float fltVal)
 Sets the Upper output. More...
 
bool UseLimits ()
 Tells whether limits should be used. More...
 
void UseLimits (bool bVal)
 Sets if limits should be used. 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 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 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 Initialize ()
 Initializes this 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 ResetSimulation ()
 Resets the simulation back to time 0. 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 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 GainCastToDerived (AnimatBase *lpBase)
 

Protected Member Functions

float CalculateLimitOutput (float fltInput)
 Calculates the output when the input is outside of the limit ranges. More...
 
bool InLimits (float fltInput)
 Tells whether the input value is within the defined limit ranges. More...
 

Protected Attributes

bool m_bUseLimits
 Determines whether or not the gain uses upper and lower limits during its calculations.
 
float m_fltLowerLimit
 The lower limit value that is checked if UseLimits is true.
 
float m_fltLowerOutput
 The lower limit output that is used if UseLimits is true and the input is below the lower limit.
 
float m_fltUpperLimit
 The upper limit value that is checked if UseLimits is true.
 
float m_fltUpperOutput
 The upper limit output that is used if UseLimits is true and the input is above the upper limit.
 
- 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

The Gain base class.

Gains are objects that convert one numeric value into a different value by applying it to a function. For speed purposes, we do not want to use parsed functions within the simulation. To get around this you can define different gain functions that implement specific equations that are then compiled. The user can specify parameters for the function that are then evaluated at runtime. This is the base class for all of these types of objects. Just derive your new gain from this class for it to be usable in the system.

Author
dcofer
Date
3/16/2011

Definition at line 35 of file Gain.h.

Constructor & Destructor Documentation

AnimatSim::Gains::Gain::Gain ( )

Default constructor.

Author
dcofer
Date
3/16/2011

Definition at line 54 of file Gain.cpp.

References m_bUseLimits, m_fltLowerLimit, m_fltLowerOutput, m_fltUpperLimit, and m_fltUpperOutput.

AnimatSim::Gains::Gain::~Gain ( )
virtual

Destructor.

Author
dcofer
Date
3/16/2011

Definition at line 69 of file Gain.cpp.

References StdUtils::Std_TraceMsg().

+ Here is the call graph for this function:

Member Function Documentation

virtual float AnimatSim::Gains::Gain::CalculateGain ( float  fltInput)
pure virtual

Calculates the gain.

This evaluates the gain function to convert the input value into an output value. This is the method that you must override in your derived class. It is where you place the new gain functionality.

Author
dcofer
Date
3/16/2011
Parameters
fltInputThe flt input.
Returns
The calculated gain.

Implemented in AnimatSim::Gains::LengthTensionGain, IntegrateFireSim::Gains::IonChannelSigmoid, AnimatSim::Gains::BellGain, AnimatSim::Gains::PolynomialGain, AnimatSim::Gains::SigmoidGain, and AnimatSim::Gains::EquationGain.

Referenced by IntegrateFireSim::IonChannel::CalculateCurrent(), FiringRateSim::Neurons::RandomNeuron::HighCurrentOn(), FiringRateSim::Neurons::RandomNeuron::LowCurrentOn(), FiringRateSim::Synapses::ModulateNeuronPropSynapse::Process(), AnimatSim::Environment::ContactSensor::ProcessContact(), AnimatSim::Adapters::PropertyControlAdapter::StepSimulation(), and AnimatSim::Adapters::Adapter::StepSimulation().

+ Here is the caller graph for this function:

float AnimatSim::Gains::Gain::CalculateLimitOutput ( float  fltInput)
inlineprotected

Calculates the output when the input is outside of the limit ranges.

Author
dcofer
Date
3/16/2011
Parameters
fltInputThe input value.
Returns
The calculated limit output.

Definition at line 81 of file Gain.h.

Referenced by AnimatSim::Gains::EquationGain::CalculateGain(), AnimatSim::Gains::SigmoidGain::CalculateGain(), AnimatSim::Gains::PolynomialGain::CalculateGain(), AnimatSim::Gains::BellGain::CalculateGain(), and IntegrateFireSim::Gains::IonChannelSigmoid::CalculateGain().

+ Here is the caller graph for this function:

bool AnimatSim::Gains::Gain::InLimits ( float  fltInput)
inlineprotected

Tells whether the input value is within the defined limit ranges.

Author
dcofer
Date
3/16/2011
Parameters
fltInputThe input value.
Returns
true if it is within limits, false otherwise.

Definition at line 63 of file Gain.h.

Referenced by AnimatSim::Gains::EquationGain::CalculateGain(), AnimatSim::Gains::SigmoidGain::CalculateGain(), AnimatSim::Gains::PolynomialGain::CalculateGain(), AnimatSim::Gains::BellGain::CalculateGain(), and IntegrateFireSim::Gains::IonChannelSigmoid::CalculateGain().

+ Here is the caller graph for this function:

float AnimatSim::Gains::Gain::LowerLimit ( )

Gets the lower limit.

Author
dcofer
Date
3/16/2011
Returns
Lower limit.

Definition at line 107 of file Gain.cpp.

References m_fltLowerLimit.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Gains::Gain::LowerLimit ( float  fltVal)

Sets the Lower limit.

Author
dcofer
Date
3/16/2011
Parameters
fltValThe new value.

Definition at line 117 of file Gain.cpp.

References m_fltLowerLimit, m_fltUpperLimit, and StdUtils::Std_IsAboveMin().

+ Here is the call graph for this function:

float AnimatSim::Gains::Gain::LowerOutput ( )

Gets the lower output.

Author
dcofer
Date
3/16/2011
Returns
The lower output.

Definition at line 155 of file Gain.cpp.

References m_fltLowerOutput.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Gains::Gain::LowerOutput ( float  fltVal)

Sets the Lower output.

Author
dcofer
Date
3/16/2011
Parameters
fltValThe new value.

Definition at line 165 of file Gain.cpp.

References m_fltLowerOutput.

void AnimatSim::Gains::Gain::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::Gains::LengthTensionGain, AnimatSim::Gains::BellGain, AnimatSim::Gains::PolynomialGain, AnimatSim::Gains::SigmoidGain, and AnimatSim::Gains::EquationGain.

Definition at line 232 of file Gain.cpp.

References AnimatSim::AnimatBase::QueryProperties().

Referenced by AnimatSim::Gains::EquationGain::QueryProperties(), AnimatSim::Gains::SigmoidGain::QueryProperties(), AnimatSim::Gains::PolynomialGain::QueryProperties(), AnimatSim::Gains::BellGain::QueryProperties(), and AnimatSim::Gains::LengthTensionGain::QueryProperties().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool AnimatSim::Gains::Gain::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::Gains::LengthTensionGain, AnimatSim::Gains::BellGain, AnimatSim::Gains::PolynomialGain, AnimatSim::Gains::SigmoidGain, IntegrateFireSim::Gains::IonChannelSigmoid, and AnimatSim::Gains::EquationGain.

Definition at line 190 of file Gain.cpp.

References LowerLimit(), LowerOutput(), AnimatSim::AnimatBase::SetData(), StdUtils::Std_ToBool(), UpperLimit(), UpperOutput(), and UseLimits().

Referenced by AnimatSim::Gains::EquationGain::SetData(), AnimatSim::Gains::SigmoidGain::SetData(), AnimatSim::Gains::PolynomialGain::SetData(), AnimatSim::Gains::BellGain::SetData(), and AnimatSim::Gains::LengthTensionGain::SetData().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

float AnimatSim::Gains::Gain::UpperLimit ( )

Gets the upper limit.

Author
dcofer
Date
3/16/2011
Returns
Upper limit.

Definition at line 131 of file Gain.cpp.

References m_fltUpperLimit.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Gains::Gain::UpperLimit ( float  fltVal)

Sets the Upper limit.

Author
dcofer
Date
3/16/2011
Parameters
fltValThe new value.

Definition at line 141 of file Gain.cpp.

References m_fltLowerLimit, m_fltUpperLimit, and StdUtils::Std_IsAboveMin().

+ Here is the call graph for this function:

float AnimatSim::Gains::Gain::UpperOutput ( )

Gets the upper output.

Author
dcofer
Date
3/16/2011
Returns
Upper output.

Definition at line 175 of file Gain.cpp.

References m_fltUpperOutput.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Gains::Gain::UpperOutput ( float  fltVal)

Sets the Upper output.

Author
dcofer
Date
3/16/2011
Parameters
fltValThe new value.

Definition at line 251 of file Gain.cpp.

References m_fltUpperOutput.

bool AnimatSim::Gains::Gain::UseLimits ( )

Tells whether limits should be used.

Author
dcofer
Date
3/16/2011
Returns
true if using limits, false otherwise.

Definition at line 87 of file Gain.cpp.

References m_bUseLimits.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Gains::Gain::UseLimits ( bool  bVal)

Sets if limits should be used.

Author
dcofer
Date
3/16/2011
Parameters
bValtrue to use limits.

Definition at line 97 of file Gain.cpp.

References m_bUseLimits.


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