#include <Odor.h>

Inheritance diagram for AnimatSim::Environment::Odor:

Collaboration diagram for AnimatSim::Environment::Odor:

Public Member Functions
	Odor (RigidBody *lpParent)
	Constructor. More...

virtual	~Odor ()
	Destructor. More...

virtual float	CalculateOdorValue (OdorType *lpType, CStdFPoint &oSensorPos)
	Calculates the odor value for this Odorant for a given odor sensor somewhere in the environment. More...

virtual void	Enabled (bool bEnabled)
	Enables the odor. More...

virtual bool	Enabled ()
	Gets whether the odor is enabled or not. More...

virtual OdorType *	GetOdorType ()
	Gets a pointer to the odor type. More...

virtual void	Load (CStdXml &oXml)

virtual float	Quantity ()
	Gets the quantity that will be used when calculating the odor concentration. More...

virtual void	Quantity (float fltVal)
	Sets the quantity that can be used when calculating the odor concentration. 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...

virtual void	SetOdorType (std::string strType)
	Sets the odor type to emit for this odorant. More...

virtual bool	UseFoodQuantity ()
	Tells whether we should use the FoodQuantity of the parent RigidBody when calculating the odor value. More...

virtual void	UseFoodQuantity (bool bVal)
	Sets whether we should use the FoodQuantity of the parent RigidBody when calculating the odor value. 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	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 Odor *	CastToDerived (AnimatBase *lpBase)

Protected Attributes
bool	m_bUseFoodQuantity

float	m_fltQuantity
	The quantity used to calculate the odor value.

OdorType *	m_lpOdorType
	Pointer to the type of odor the body part is emitting.

RigidBody *	m_lpParent
	Pointer to the parent RigidBody part that is emitting the odor.

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.

Author: dcofer

Date: 3/23/2011

Definition at line 19 of file Odor.h.

Constructor & Destructor Documentation

AnimatSim::Environment::Odor::Odor ( RigidBody * lpParent )

Constructor.

Author: dcofer

Date: 3/23/2011

Parameters

[in,out] lpParent If non-null, the pointer to a parent.

Definition at line 49 of file Odor.cpp.

References AnimatSim::AnimatBase::m_bEnabled, m_bUseFoodQuantity, m_fltQuantity, m_lpOdorType, and m_lpParent.

AnimatSim::Environment::Odor::~Odor ( )

virtual

Destructor.

Author: dcofer

Date: 3/23/2011

Definition at line 64 of file Odor.cpp.

References m_lpParent, and StdUtils::Std_TraceMsg().

Here is the call graph for this function:

Member Function Documentation

float AnimatSim::Environment::Odor::CalculateOdorValue	(	OdorType *	lpType,
		CStdFPoint &	oSensorPos
	)

virtual

Calculates the odor value for this Odorant for a given odor sensor somewhere in the environment.

The odor value that a sensor detects is determined by how far away a givent odorant is from it, the diffusion constant, and the quantity of the odor present at the source. This equation describes the relationship. fltVal = (this->Quantity() * lpType->DiffusionConstant()) / (fltDist * fltDist);

Author: dcofer

Date: 3/23/2011

Parameters

[in,out]	lpType	Pointer to the OdorType for which we are calculating the odor.
[in,out]	oSensorPos	The position to the odor sensor.

Returns: The calculated odor value.

Definition at line 200 of file Odor.cpp.

References AnimatSim::Environment::OdorType::DiffusionConstant(), AnimatSim::Environment::MovableItem::GetCurrentPosition(), AnimatSim::AnimatBase::m_bEnabled, m_lpParent, Quantity(), and StdUtils::Std_CalculateDistance().

Referenced by AnimatSim::Environment::OdorType::CalculateOdorValue().

Here is the call graph for this function:

Here is the caller graph for this function:

void AnimatSim::Environment::Odor::Enabled ( bool bVal )

virtual

Enables the odor.

Author: dcofer

Date: 3/1/2011

Parameters

bVal	true to enable, false to disable.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 98 of file Odor.cpp.

References AnimatSim::AnimatBase::m_bEnabled.

bool AnimatSim::Environment::Odor::Enabled ( )

virtual

Gets whether the odor 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 Odor.cpp.

References AnimatSim::AnimatBase::m_bEnabled.

Referenced by SetData().

Here is the caller graph for this function:

OdorType * AnimatSim::Environment::Odor::GetOdorType ( )

virtual

Gets a pointer to the odor type.

Author: dcofer

Date: 3/23/2011

Returns: Pointer to OdorType.

Definition at line 128 of file Odor.cpp.

References m_lpOdorType.

float AnimatSim::Environment::Odor::Quantity ( )

virtual

Gets the quantity that will be used when calculating the odor concentration.

If m_bUseFoodQuantity is True then this return FoodQuantity from the parent RigidBody, else it returns m_fltQuantity.

Author: dcofer

Date: 3/23/2011

Returns: Current quantity.

Definition at line 157 of file Odor.cpp.

References AnimatSim::Environment::RigidBody::FoodQuantity(), m_bUseFoodQuantity, m_fltQuantity, and m_lpParent.

Referenced by CalculateOdorValue(), and SetData().

Here is the call graph for this function:

Here is the caller graph for this function:

void AnimatSim::Environment::Odor::Quantity ( float fltVal )

virtual

Sets the quantity that can be used when calculating the odor concentration.

If m_bUseFoodQuantity is True then this value is not used.

Author: dcofer

Date: 3/23/2011

Parameters

fltVal The new value.

Definition at line 140 of file Odor.cpp.

References m_fltQuantity, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

void AnimatSim::Environment::Odor::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 244 of file Odor.cpp.

References AnimatSim::AnimatBase::QueryProperties().

Here is the call graph for this function:

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

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

Here is the call graph for this function:

void AnimatSim::Environment::Odor::SetOdorType ( std::string strType )

virtual

Sets the odor type to emit for this odorant.

This takes teh supplied odor type ID and finds that odor, and adds itself as a source.

Author: dcofer

Date: 3/23/2011

Parameters

strType OdorType ID.

Definition at line 113 of file Odor.cpp.

References AnimatSim::Environment::OdorType::AddOdorSource(), AnimatSim::Simulator::FindOdorType(), m_lpOdorType, and AnimatSim::AnimatBase::m_lpSim.

Here is the call graph for this function:

bool AnimatSim::Environment::Odor::UseFoodQuantity ( )

virtual

Tells whether we should use the FoodQuantity of the parent RigidBody when calculating the odor value.

Author: dcofer

Date: 3/23/2011

Returns: true if it uses RigidBody food quantity, false else.

Definition at line 173 of file Odor.cpp.

References m_bUseFoodQuantity.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::Environment::Odor::UseFoodQuantity ( bool bVal )

virtual

Sets whether we should use the FoodQuantity of the parent RigidBody when calculating the odor value.

Author: dcofer

Date: 3/23/2011

Parameters

bVal	true if it uses RigidBody food quantity, false else.

Definition at line 183 of file Odor.cpp.

References m_bUseFoodQuantity.

Member Data Documentation

bool AnimatSim::Environment::Odor::m_bUseFoodQuantity

protected

If this is true then the food quantity of the parent RigidBody is used to calculate the odor strength instead of the m_fltQuantity of this odor object.

Definition at line 33 of file Odor.h.

Referenced by Odor(), Quantity(), and UseFoodQuantity().

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

Member Data Documentation