Manager for data charts. More...

#include <DataChartMgr.h>

Inheritance diagram for AnimatSim::Charting::DataChartMgr:

Collaboration diagram for AnimatSim::Charting::DataChartMgr:

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

virtual	~DataChartMgr ()
	Destructor. More...

virtual bool	AddDataChart (std::string strXml)
	Adds a data chart to the manager. More...

virtual void	AddDataColumn (std::string strChartKey, DataColumn *lpColumn)
	Adds a data column to the specified chart. More...

virtual DataColumn *	FindDataColumn (std::string strChartKey, std::string strColumnName, bool bThrowError=true)
	Searches for a DataColumn with the specified column name. More...

virtual void	Load (CStdXml &oXml)

virtual bool	RemoveDataChart (std::string strID)
	Removes the data chart described by ID. More...

virtual void	RemoveDataColumn (std::string strChartKey, std::string strColumnName, bool bThrowError=true)
	Removes the specified data column. More...

Public Member Functions inherited from AnimatSim::ActivatedItemMgr
	ActivatedItemMgr ()
	Default constructor. More...

virtual	~ActivatedItemMgr ()
	Destructor. More...

virtual void	Add (ActivatedItem *lpItem)
	Adds a new ActivatedItem to be managed. More...

virtual ActivatedItem *	Find (std::string strID, int &iIndex, bool bThrowError)
	Searches for an item with the specified ID and sets its index in the array. More...

virtual ActivatedItem *	Find (std::string strID, bool bThrowError=true)
	Searches for an item with the specified ID. More...

virtual int	FindListPos (std::string strID, bool bThrowError=true)
	Searches for the item with the specified ID and returns its position in the m_aryItems array. More...

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

virtual void	ReInitialize ()
	Re-initialize this object. More...

virtual void	Remove (std::string strID, bool bThrowError=true)
	Removes the item with the specified ID. More...

virtual void	Reset ()
	Resets this manager. More...

virtual void	ResetSimulation ()
	Resets the simulation back to time 0. More...

virtual void	StepSimulation ()
	Step the simulation for this object. 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	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	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
	Queries this object for a list of properties that can be changed using SetData. 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	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 std::string &strValue, bool bThrowError=true)
	Set a variable based on a string data type name. 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 DataChartMgr *	CastToDerived (AnimatBase *lpBase)

Static Public Member Functions inherited from AnimatSim::ActivatedItemMgr
static ActivatedItemMgr *	CastToDerived (AnimatBase *lpBase)

Protected Member Functions
DataChart *	LoadDataChart (CStdXml &oXml)
	Loads a data chart. More...

Additional Inherited Members
Protected Attributes inherited from AnimatSim::ActivatedItemMgr
CStdArray< ActivatedItem * >	m_aryItems

CStdPtrMap< std::string, ActivatedItem >	m_aryItemsMap

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

Manager for data charts.

This class is derived from ActivatedItemMgr. It is responisble for maintaining a set of data charts. Each chart can have its own start/end times.

Author: dcofer

Date: 3/18/2011

Definition at line 22 of file DataChartMgr.h.

Constructor & Destructor Documentation

AnimatSim::Charting::DataChartMgr::DataChartMgr ( )

Default constructor.

Author: dcofer

Date: 3/18/2011

Definition at line 53 of file DataChartMgr.cpp.

AnimatSim::Charting::DataChartMgr::~DataChartMgr ( )

virtual

Destructor.

Author: dcofer

Date: 3/18/2011

Definition at line 62 of file DataChartMgr.cpp.

Member Function Documentation

bool AnimatSim::Charting::DataChartMgr::AddDataChart ( std::string strXml )

virtual

Adds a data chart to the manager.

This method is primiarly used by the GUI to add a new chart to the system by specifying an xml packet to load.

Author: dcofer

Date: 3/18/2011

Parameters

strXml The xml data to load for the new chart.

Returns: true if it succeeds, false if it fails.

Definition at line 131 of file DataChartMgr.cpp.

References StdUtils::CStdXml::Deserialize(), StdUtils::CStdXml::FindChildElement(), StdUtils::CStdXml::FindElement(), LoadDataChart(), and AnimatSim::ActivatedItemMgr::ReInitialize().

Referenced by AnimatSim::Simulator::AddItem().

Here is the call graph for this function:

Here is the caller graph for this function:

void AnimatSim::Charting::DataChartMgr::AddDataColumn	(	std::string	strChartKey,
		DataColumn *	lpColumn
	)

virtual

Adds a data column to the specified chart.

Author: dcofer

Date: 3/18/2011

Parameters

	strChartKey	GUID ID to the chart that contains the column of interest.
[in,out]	lpColumn	Pointer to the DataColumn to add.

Definition at line 113 of file DataChartMgr.cpp.

References AnimatSim::Charting::DataChart::AddColumn(), and AnimatSim::ActivatedItemMgr::Find().

Here is the call graph for this function:

DataColumn * AnimatSim::Charting::DataChartMgr::FindDataColumn	(	std::string	strChartKey,
		std::string	strColumnName,
		bool	bThrowError = `true`
	)

virtual

Searches for a DataColumn with the specified column name.

Author: dcofer

Date: 3/18/2011

Parameters

strChartKey	GUID ID to the chart that contains the column of interest.
strColumnName	Name of the DataColumn we are searching for.
bThrowError	If no column is found and this is true, then an exception is thrown, otherwise NULL is returned.

Returns: Pointer to the found DataColumn, NULL if not found and bThrowError = false.

Definition at line 77 of file DataChartMgr.cpp.

References AnimatSim::ActivatedItemMgr::Find(), and AnimatSim::Charting::DataChart::FindColumn().

Here is the call graph for this function:

DataChart * AnimatSim::Charting::DataChartMgr::LoadDataChart ( CStdXml & oXml )

protected

Loads a data chart.

Author: dcofer

Date: 3/18/2011

Parameters

[in,out] oXml The xml used to load the chart.

Returns: Pointer to the new DataChart.

Exceptions

Throws an exception if there is a problem creating or loading the new chart.

Definition at line 191 of file DataChartMgr.cpp.

References AnimatSim::ActivatedItemMgr::Add(), AnimatSim::Simulator::CreateObject(), StdUtils::CStdXml::GetChildString(), StdUtils::CStdXml::IntoElem(), AnimatSim::Charting::DataChart::Load(), AnimatSim::AnimatBase::m_lpSim, StdUtils::CStdXml::OutOfElem(), AnimatSim::Charting::DataChart::ProjectPath(), AnimatSim::Simulator::ProjectPath(), AnimatSim::AnimatBase::SetSystemPointers(), and StdUtils::Std_IsBlank().

Referenced by AddDataChart().

Here is the call graph for this function:

Here is the caller graph for this function:

bool AnimatSim::Charting::DataChartMgr::RemoveDataChart ( std::string strID )

virtual

Removes the data chart described by ID.

Author: dcofer

Date: 3/18/2011

Parameters

strID GUID ID of the chart to remove.

Returns: true if it succeeds, false if it fails.

Definition at line 152 of file DataChartMgr.cpp.

References AnimatSim::ActivatedItemMgr::ReInitialize(), and AnimatSim::ActivatedItemMgr::Remove().

Referenced by AnimatSim::Simulator::RemoveItem().

Here is the call graph for this function:

Here is the caller graph for this function:

void AnimatSim::Charting::DataChartMgr::RemoveDataColumn	(	std::string	strChartKey,
		std::string	strColumnName,
		bool	bThrowError = `true`
	)

virtual

Removes the specified data column.

Author: dcofer

Date: 3/18/2011

Parameters

strChartKey	GUID ID to the chart that contains the column of interest.
strColumnName	Name of the DataColumn we are deleting.
bThrowError	If no column is found and this is true, then an exception is thrown, otherwise NULL is returned.

Definition at line 96 of file DataChartMgr.cpp.

References AnimatSim::ActivatedItemMgr::Find(), and AnimatSim::Charting::DataChart::RemoveColumn().

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 Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation