Odor type that can be emitted from a RigidBody and sensed by an OdorSensor. More...

#include <OdorType.h>

Inheritance diagram for AnimatSim::Environment::OdorType:

Collaboration diagram for AnimatSim::Environment::OdorType:

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

virtual	~OdorType ()
	Destructor. More...

virtual void	AddOdorSource (Odor *lpOdor)
	Adds an odor source to the list of odors that are emitting this type of odor. More...

virtual float	CalculateOdorValue (CStdFPoint &oSensorPos)
	Calculates the odor value for this OdorType for a given sensor location. More...

virtual float	DiffusionConstant ()
	Gets the diffusion constant. More...

virtual void	DiffusionConstant (float fltVal, bool bUseScaling=true)
	Sets the diffusion constant. More...

virtual Odor *	FindOdorSource (std::string strOdorID, bool bThrowError=true)
	Finds the odor source with the specified GUID ID. More...

virtual void	Load (CStdXml &oXml)

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::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	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 OdorType *	CastToDerived (AnimatBase *lpBase)

Protected Attributes
CStdMap< std::string, Odor * >	m_aryOdorSources
	The array of odor sources of this type within the environment.

float	m_fltDiffusionConstant
	The diffusion constant that defines how fast odors of this type move through the environment.

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

Odor type that can be emitted from a RigidBody and sensed by an OdorSensor.

OdorTypes can be defined for the entire simulation. A RigidBody can then emit one or more different OdorTypes. An OdorSensor can detect only a single OdorType, but you could have multiple sensors that work together. The OdorType has a diffusion constant that defines how fast the odors of that type will move from their source to a destination. Each OdorType keeps a list of all Odor source objects in the environment.

Author: dcofer

Date: 3/23/2011

Definition at line 27 of file OdorType.h.

Constructor & Destructor Documentation

AnimatSim::Environment::OdorType::OdorType ( )

Default constructor.

Author: dcofer

Date: 3/23/2011

Definition at line 47 of file OdorType.cpp.

References m_fltDiffusionConstant.

AnimatSim::Environment::OdorType::~OdorType ( )

virtual

Destructor.

Author: dcofer

Date: 3/23/2011

Definition at line 58 of file OdorType.cpp.

References m_aryOdorSources, and StdUtils::Std_TraceMsg().

Here is the call graph for this function:

Member Function Documentation

void AnimatSim::Environment::OdorType::AddOdorSource ( Odor * lpOdor )

virtual

Adds an odor source to the list of odors that are emitting this type of odor.

Author: dcofer

Date: 3/23/2011

Parameters

[in,out] lpOdor Pointer to an odor emitting this OdorType.

Definition at line 131 of file OdorType.cpp.

References FindOdorSource(), AnimatSim::AnimatBase::ID(), and m_aryOdorSources.

Referenced by AnimatSim::Environment::Odor::SetOdorType().

Here is the call graph for this function:

Here is the caller graph for this function:

float AnimatSim::Environment::OdorType::CalculateOdorValue ( CStdFPoint & oSensorPos )

virtual

Calculates the odor value for this OdorType for a given sensor location.

This loops through all of the odors that are emitting this OdorType and calculates the odor strength for each one based on its distance from the specified sensor. This is the total odor strength for the sensor.

Author: dcofer

Date: 3/23/2011

Parameters

[in,out] oSensorPos The sensor position.

Returns: The total calculated odor value.

Definition at line 153 of file OdorType.cpp.

References AnimatSim::Environment::Odor::CalculateOdorValue(), and m_aryOdorSources.

Referenced by AnimatSim::Environment::Bodies::OdorSensor::StepSimulation().

Here is the call graph for this function:

Here is the caller graph for this function:

float AnimatSim::Environment::OdorType::DiffusionConstant ( )

virtual

Gets the diffusion constant.

Author: dcofer

Date: 3/23/2011

Returns: Diffusion constant.

Definition at line 77 of file OdorType.cpp.

References m_fltDiffusionConstant.

Referenced by AnimatSim::Environment::Odor::CalculateOdorValue(), and SetData().

Here is the caller graph for this function:

void AnimatSim::Environment::OdorType::DiffusionConstant	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the diffusion constant.

Author: dcofer

Date: 3/23/2011

Parameters

fltVal	The new value.
bUseScaling	true to use unit scaling.

Definition at line 88 of file OdorType.cpp.

References AnimatSim::Simulator::DistanceUnits(), m_fltDiffusionConstant, AnimatSim::AnimatBase::m_lpSim, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

Odor * AnimatSim::Environment::OdorType::FindOdorSource	(	std::string	strOdorID,
		bool	bThrowError = `true`
	)

virtual

Finds the odor source with the specified GUID ID.

Author: dcofer

Date: 3/23/2011

Parameters

strOdorID	GUID ID of the Odor to find.
bThrowError	If true and the odor is not found then throw an error, else return NULL if not found

Returns: null if Odor is not found and bThrowError=False, else the found odor source.

Definition at line 109 of file OdorType.cpp.

References m_aryOdorSources, and StdUtils::Std_CheckString().

Referenced by AddOdorSource().

Here is the call graph for this function:

Here is the caller graph for this function:

void AnimatSim::Environment::OdorType::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.

Definition at line 191 of file OdorType.cpp.

References AnimatSim::AnimatBase::QueryProperties().

Here is the call graph for this function:

bool AnimatSim::Environment::OdorType::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 171 of file OdorType.cpp.

References DiffusionConstant(), AnimatSim::AnimatBase::SetData(), and StdUtils::Std_CheckString().

Here is the call graph for this function:

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation