A standard xml manipulation class. More...

#include <StdXml.h>

Inheritance diagram for StdUtils::CStdXml:

Collaboration diagram for StdUtils::CStdXml:

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

virtual	~CStdXml ()
	Destructor. More...

virtual void	AddChildCData (std::string strElementName, std::string strCData)
	Adds a child CDATA section. More...

virtual void	AddChildDoc (std::string &strDoc)
	Adds a child document. More...

virtual void	AddChildElement (std::string strElementName)
	Adds a child element to current element. More...

virtual void	AddChildElement (std::string strElementName, std::string strVal)
	Adds a child element to current element. More...

virtual void	AddChildElement (std::string strElementName, char cVal)
	Adds a child element to current element. More...

virtual void	AddChildElement (std::string strElementName, unsigned char cVal)
	Adds a child element to current element. More...

virtual void	AddChildElement (std::string strElementName, long lVal)
	Adds a child element to current element. More...

virtual void	AddChildElement (std::string strElementName, int iVal)
	Adds a child element to current element. More...

virtual void	AddChildElement (std::string strElementName, double dblVal)
	Adds a child element to current element. More...

virtual void	AddChildElement (std::string strElementName, float fltVal)
	Adds a child element to current element. More...

virtual void	AddChildElement (std::string strElementName, bool bVal)
	Adds a child element to current element. More...

virtual void	AddElement (std::string strElementName, std::string strData="")
	Adds an element to current element. More...

virtual void	Deserialize (std::string &strXml)
	Deserializes a string into an xml document. More...

virtual bool	FindChildByIndex (int iIndex, bool bThrowError=true)
	Finds a child element by index. More...

virtual bool	FindChildElement (std::string strElementName, bool fThrowError=true)
	Finds a child element by name. More...

virtual bool	FindElement (std::string strElementName, bool fThrowError=true)
	Finds an element with the specified name. More...

virtual std::string	FullTagPath (bool bAddChildName=true)
	Full tag path. More...

virtual bool	GetAttribBool (std::string strAttribName, bool bThrowError=true, bool bDefault=false)
	Gets an attribute bool. More...

virtual double	GetAttribDouble (std::string strAttribName, bool bThrowError=true, double dblDefault=0)
	Gets an attribute double. More...

virtual float	GetAttribFloat (std::string strAttribName, bool bThrowError=true, float fltDefault=0)
	Gets an attribute float. More...

virtual int	GetAttribInt (std::string strAttribName, bool bThrowError=true, int iDefault=0)
	Gets an attribute int. More...

virtual long	GetAttribLong (std::string strAttribName, bool bThrowError=true, long lDefault=0)
	Gets an attribute long. More...

virtual std::string	GetAttribString (std::string strAttribName, bool bCanBeBlank=false, bool bThrowError=true, std::string strDefault="")
	Gets an attribute string of an element. More...

virtual bool	GetChildAttribBool (std::string strAttribName, bool bThrowError=true, bool bDefault=false)
	Gets a child attribute bool. More...

virtual double	GetChildAttribDouble (std::string strAttribName, bool bThrowError=true, double dblDefault=0)
	Gets a child attribute double. More...

virtual float	GetChildAttribFloat (std::string strAttribName, bool bThrowError=true, float fltDefault=0)
	Gets a child attribute float. More...

virtual int	GetChildAttribInt (std::string strAttribName, bool bThrowError=true, int iDefault=0)
	Gets a child attribute int. More...

virtual long	GetChildAttribLong (std::string strAttribName, bool bThrowError=true, long lDefault=0)
	Gets a child attribute long. More...

virtual std::string	GetChildAttribString (std::string strAttribName, bool bCanBeBlank=false, bool bThrowError=true, std::string strDefault="")
	Gets a child attribute string. More...

virtual bool	GetChildBool (std::string strElementName)
	Gets a bool value from the element with the specified name. More...

virtual bool	GetChildBool (std::string strElementName, bool bDefault)
	Gets a float value from the element with the specified name. It uses the default if no element is found. More...

virtual bool	GetChildBool ()
	Gets a bool value from the currently selected element. More...

virtual std::string	GetChildDoc ()
	Gets a child document. More...

virtual double	GetChildDouble (std::string strElementName)
	Gets a double value from the element with the specified name. More...

virtual double	GetChildDouble (std::string strElementName, double dblDefault)
	Gets a double value from the element with the specified name. It uses the default if no element is found. More...

virtual double	GetChildDouble ()
	Gets a double value from the currently selected element. More...

virtual float	GetChildFloat (std::string strElementName)
	Gets a float value from the element with the specified name. More...

virtual float	GetChildFloat (std::string strElementName, float fltDefault)
	Gets a float value from the element with the specified name. It uses the default if no element is found. More...

virtual float	GetChildFloat ()
	Gets a float value from the currently selected element. More...

virtual int	GetChildInt (std::string strElementName)
	Gets an integer value from the element with the specified name. More...

virtual int	GetChildInt (std::string strElementName, int iDefault)
	Gets an integer value from the element with the specified name. It uses the default if no element is found. More...

virtual int	GetChildInt ()
	Gets an integer value from the currently selected element. More...

virtual long	GetChildLong (std::string strElementName)
	Gets a long value from the element with the specified name. More...

virtual long	GetChildLong (std::string strElementName, long lDefault)
	Gets a long value from the element with the specified name. It uses the default if no element is found. More...

virtual long	GetChildLong ()
	Gets a long value from the currently selected element. More...

virtual std::string	GetChildString (std::string strElementName)
	Gets a string value from the element with the specified name. More...

virtual std::string	GetChildString (std::string strElementName, std::string strDefault)
	Gets a string value from the element with the specified name. It uses the default if no element is found. More...

virtual std::string	GetChildString ()
	Gets a string value from the currently selected element. More...

virtual std::string	GetParentTagName ()
	Gets the parent tag name. More...

virtual bool	IntoChildElement (std::string strElementName, bool bThrowError=true)
	Goes into the child element with the specified name. More...

virtual bool	IntoElem ()
	Goes into the next element where the cursor is located. More...

virtual void	Load (std::string strFilename)
	Loads an xml data file. More...

virtual int	NumberOfChildren ()
	Gets the number of children of the current element. More...

virtual bool	OutOfElem ()
	Goes out of the element where the cursor is located. More...

virtual void	Save (std::string strFilename)
	Saves am xml data file. More...

virtual std::string	Serialize ()
	Serializes the document to a string. More...

virtual void	SetAttrib (std::string strAttribName, std::string strVal)
	Sets an attribute. More...

virtual void	SetAttrib (std::string strAttribName, char cVal)
	Sets an attribute. More...

virtual void	SetAttrib (std::string strAttribName, unsigned char cVal)
	Sets an attribute. More...

virtual void	SetAttrib (std::string strAttribName, long lVal)
	Sets an attribute. More...

virtual void	SetAttrib (std::string strAttribName, int iVal)
	Sets an attribute. More...

virtual void	SetAttrib (std::string strAttribName, double dblVal)
	Sets an attribute. More...

virtual void	SetAttrib (std::string strAttribName, float fltVal)
	Sets an attribute. More...

virtual void	SetAttrib (std::string strAttribName, bool bVal)
	Sets an attribute. More...

virtual void	SetChildAttrib (std::string strAttribName, std::string strVal)
	Sets a child attribute. More...

virtual void	SetChildAttrib (std::string strAttribName, char cVal)
	Sets a child attribute. More...

virtual void	SetChildAttrib (std::string strAttribName, unsigned char cVal)
	Sets a child attribute. More...

virtual void	SetChildAttrib (std::string strAttribName, long lVal)
	Sets a child attribute. More...

virtual void	SetChildAttrib (std::string strAttribName, int iVal)
	Sets a child attribute. More...

virtual void	SetChildAttrib (std::string strAttribName, double dblVal)
	Sets a child attribute. More...

virtual void	SetChildAttrib (std::string strAttribName, float fltVal)
	Sets a child attribute. More...

virtual void	SetChildAttrib (std::string strAttribName, bool bVal)
	Sets a child attribute. More...

Public Member Functions inherited from StdUtils::CMarkupSTL
	CMarkupSTL (const char *szDoc)

	CMarkupSTL (const CMarkupSTL &markup)

bool	AddAttrib (const char szAttrib, const char szValue)

bool	AddAttrib (const char *szAttrib, int nValue)

bool	AddChildAttrib (const char szAttrib, const char szValue)

bool	AddChildAttrib (const char *szAttrib, int nValue)

bool	AddChildElem (const char szName, const char szData=NULL)

bool	AddChildSubDoc (const char *szSubDoc)

bool	AddElem (const char szName, const char szData=NULL)

bool	FindChildElem (const char *szName=NULL)

bool	FindElem (const char *szName=NULL)

std::string	GetAttrib (const char *szAttrib) const

std::string	GetAttribName (int n) const

std::string	GetChildAttrib (const char *szAttrib) const

std::string	GetChildData () const

std::string	GetChildSubDoc () const

std::string	GetChildTagName () const

std::string	GetData () const

std::string	GetDoc () const

std::string	GetError () const

bool	GetOffsets (int &nStart, int &nEnd) const

std::string	GetTagName () const

bool	InsertChildElem (const char szName, const char szData=NULL)

bool	InsertChildSubDoc (const char *szSubDoc)

bool	InsertElem (const char szName, const char szData=NULL)

bool	IsWellFormed ()

bool	Load (const char *szFileName)

void	operator= (const CMarkupSTL &markup)

bool	RemoveChildElem ()

bool	RemoveElem ()

void	ResetChildPos ()

void	ResetMainPos ()

void	ResetPos ()

bool	RestorePos (const char *szPosName="")

bool	Save (const char *szFileName)

bool	SavePos (const char *szPosName="")

bool	SetAttrib (const char szAttrib, const char szValue)

bool	SetAttrib (const char *szAttrib, int nValue)

bool	SetChildAttrib (const char szAttrib, const char szValue)

bool	SetChildAttrib (const char *szAttrib, int nValue)

bool	SetChildData (const char *szData, int nCDATA=0)

bool	SetData (const char *szData, int nCDATA=0)

bool	SetDoc (const char *szDoc)

Protected Member Functions
virtual void	ClearTagStack ()
	Clears the tag stack. More...

virtual std::string	ValueErrorString (std::string strValue)
	Generates a value error string. More...

Protected Member Functions inherited from StdUtils::CMarkupSTL
bool	x_AddElem (const char szName, const char szValue, bool bInsert, bool bAddChild)

bool	x_AddSubDoc (const char *szSubDoc, bool bInsert, bool bAddChild)

void	x_Adjust (int iPos, int nShift, bool bAfterPos=false)

bool	x_CreateNode (std::string &strNode, int nNodeType, const char *szText)

void	x_DocChange (int nLeft, int nReplace, const std::string &strInsert)

bool	x_FindAttrib (TokenPos &token, const char *szAttrib=NULL) const

int	x_FindElem (int iPosParent, int iPos, const char *szPath)

std::string	x_GetAttrib (int iPos, const char *szAttrib) const

std::string	x_GetData (int iPos) const

int	x_GetFreePos ()

std::string	x_GetTagName (int iPos) const

std::string	x_GetToken (const TokenPos &token) const

void	x_LocateNew (int iPosParent, int &iPosRel, int &nOffset, int nLength, int nFlags)

int	x_ParseElem (int iPos)

int	x_ParseError (const char szError, const char szName=NULL)

int	x_ParseNode (TokenPos &token)

void	x_PosInsert (int iPos, int nInsertLength)

int	x_ReleasePos ()

int	x_RemoveElem (int iPos)

bool	x_SetAttrib (int iPos, const char szAttrib, const char szValue)

bool	x_SetAttrib (int iPos, const char *szAttrib, int nValue)

bool	x_SetData (int iPos, const char *szData, int nCDATA)

void	x_SetPos (int iPosParent, int iPos, int iPosChild)

std::string	x_TextFromDoc (int nLeft, int nRight) const

std::string	x_TextToDoc (const char *szText, bool bAttrib=false) const

Protected Attributes
std::stack< std::string >	m_aryTagStack
	Stack of tags.

Protected Attributes inherited from StdUtils::CMarkupSTL
vectorElemPosT	m_aPos

int	m_iPos

int	m_iPosChild

int	m_iPosFree

int	m_iPosParent

mapSavedPosT	m_mapSavedPos

int	m_nNodeType

std::string	m_strDoc

std::string	m_strError

Additional Inherited Members
Public Types inherited from StdUtils::CMarkupSTL
enum	MarkupNodeType { MNT_ELEMENT = 1, MNT_TEXT = 2, MNT_WHITESPACE = 4, MNT_CDATA_SECTION = 8, MNT_PROCESSING_INSTRUCTION = 16, MNT_COMMENT = 32, MNT_DOCUMENT_TYPE = 64, MNT_EXCLUDE_WHITESPACE = 123 }

Protected Types inherited from StdUtils::CMarkupSTL
typedef std::map< std::string, SavedPos >	mapSavedPosT

typedef std::vector< ElemPos >	vectorElemPosT

Static Protected Member Functions inherited from StdUtils::CMarkupSTL
static bool	x_FindChar (const char *szDoc, int &nChar, char c)

static bool	x_FindToken (TokenPos &token)

Detailed Description

A standard xml manipulation class.

This class is used to load, save, and manipulate xml data packets.

Author: dcofer

Date: 5/4/2011

Definition at line 19 of file StdXml.h.

Constructor & Destructor Documentation

StdUtils::CStdXml::CStdXml ( )

Default constructor.

Author: dcofer

Date: 5/4/2011

Definition at line 18 of file StdXml.cpp.

StdUtils::CStdXml::~CStdXml ( )

virtual

Destructor.

Author: dcofer

Date: 5/4/2011

Definition at line 29 of file StdXml.cpp.

Member Function Documentation

void StdUtils::CStdXml::AddChildCData	(	std::string	strElementName,
		std::string	strCData
	)

virtual

Adds a child CDATA section.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the string element.
strCData	Information within the CDATA section.

Definition at line 939 of file StdXml.cpp.

References AddChildElement(), IntoElem(), and OutOfElem().

Here is the call graph for this function:

void StdUtils::CStdXml::AddChildDoc ( std::string & strDoc )

virtual

Adds a child document.

Author: dcofer

Date: 5/4/2011

Parameters

[in,out] strDoc The string document.

Definition at line 1639 of file StdXml.cpp.

void StdUtils::CStdXml::AddChildElement ( std::string strElementName )

virtual

Adds a child element to current element.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName Name of the new element.

Definition at line 799 of file StdXml.cpp.

Referenced by AddChildCData(), AddChildElement(), StdUtils::CStdFont::Save(), StdUtils::CStdVariant::Save(), and StdUtils::Std_SavePoint().

Here is the caller graph for this function:

void StdUtils::CStdXml::AddChildElement	(	std::string	strElementName,
		std::string	strVal
	)

virtual

Adds a child element to current element.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the new element.
strData	Data to add.

Definition at line 785 of file StdXml.cpp.

References FullTagPath().

Here is the call graph for this function:

void StdUtils::CStdXml::AddChildElement	(	std::string	strElementName,
		char	cVal
	)

virtual

Adds a child element to current element.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the new element.
cVal	Data to add.

Definition at line 814 of file StdXml.cpp.

References AddChildElement().

Here is the call graph for this function:

void StdUtils::CStdXml::AddChildElement	(	std::string	strElementName,
		unsigned char	cVal
	)

virtual

Adds a child element to current element.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the new element.
cVal	Data to add.

Definition at line 832 of file StdXml.cpp.

References AddChildElement().

Here is the call graph for this function:

void StdUtils::CStdXml::AddChildElement	(	std::string	strElementName,
		long	lVal
	)

virtual

Adds a child element to current element.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the new element.
lVal	Data to add.

Definition at line 850 of file StdXml.cpp.

References AddChildElement().

Here is the call graph for this function:

void StdUtils::CStdXml::AddChildElement	(	std::string	strElementName,
		int	iVal
	)

virtual

Adds a child element to current element.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the new element.
iVal	Data to add.

Definition at line 867 of file StdXml.cpp.

References AddChildElement().

Here is the call graph for this function:

void StdUtils::CStdXml::AddChildElement	(	std::string	strElementName,
		double	dblVal
	)

virtual

Adds a child element to current element.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the new element.
dblVal	Data to add.

Definition at line 884 of file StdXml.cpp.

References AddChildElement().

Here is the call graph for this function:

void StdUtils::CStdXml::AddChildElement	(	std::string	strElementName,
		float	fltVal
	)

virtual

Adds a child element to current element.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the new element.
fltVal	Data to add.

Definition at line 901 of file StdXml.cpp.

References AddChildElement().

Here is the call graph for this function:

void StdUtils::CStdXml::AddChildElement	(	std::string	strElementName,
		bool	bVal
	)

virtual

Adds a child element to current element.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the new element.
bVal	Data to add.

Definition at line 918 of file StdXml.cpp.

References AddChildElement().

Here is the call graph for this function:

void StdUtils::CStdXml::AddElement	(	std::string	strElementName,
		std::string	strData = `""`
	)

virtual

Adds an element to current element.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the new element.
strData	Data to add.

Definition at line 770 of file StdXml.cpp.

References FullTagPath().

Here is the call graph for this function:

void StdUtils::CStdXml::ClearTagStack ( )

protectedvirtual

Clears the tag stack.

Author: dcofer

Date: 5/4/2011

Definition at line 135 of file StdXml.cpp.

References m_aryTagStack.

Referenced by FindElement().

Here is the caller graph for this function:

void StdUtils::CStdXml::Deserialize ( std::string & strXml )

virtual

Deserializes a string into an xml document.

Author: dcofer

Date: 5/4/2011

Parameters

[in,out] strXml The string xml.

Definition at line 162 of file StdXml.cpp.

bool StdUtils::CStdXml::FindChildByIndex	(	int	iIndex,
		bool	bThrowError = `true`
	)

virtual

Finds a child element by index.

Author: dcofer

Date: 5/4/2011

Parameters

iIndex	Zero-based index of the element.
bThrowError	true to throw error.

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

Definition at line 225 of file StdXml.cpp.

Referenced by AnimatSim::Environment::Bodies::LineBase::LoadAttachments(), AnimatSim::Simulator::LoadEnvironment(), AnimatSim::Behavior::NeuralModule::LoadExternalSynapses(), AnimatSim::Environment::Structure::LoadLayout(), and StdUtils::Std_LoadPoint().

Here is the caller graph for this function:

bool StdUtils::CStdXml::FindChildElement	(	std::string	strElementName,
		bool	bThrowError = `true`
	)

virtual

Finds a child element by name.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the string element.
bThrowError	true to throw error.

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

Definition at line 256 of file StdXml.cpp.

References FullTagPath().

Here is the call graph for this function:

bool StdUtils::CStdXml::FindElement	(	std::string	strElementName,
		bool	bThrowError = `true`
	)

virtual

Finds an element with the specified name.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the string element.
bThrowError	true to throw error.

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

Definition at line 179 of file StdXml.cpp.

References ClearTagStack(), FullTagPath(), and m_aryTagStack.

Here is the call graph for this function:

std::string StdUtils::CStdXml::FullTagPath ( bool bAddChildName = true )

virtual

Full tag path.

Author: dcofer

Date: 5/4/2011

Parameters

bAddChildName true to add child name.

Returns: .

Definition at line 73 of file StdXml.cpp.

References m_aryTagStack.

Referenced by AddChildElement(), AddElement(), FindChildElement(), FindElement(), SetAttrib(), SetChildAttrib(), and ValueErrorString().

Here is the caller graph for this function:

bool StdUtils::CStdXml::GetAttribBool	(	std::string	strAttribName,
		bool	bThrowError = `true`,
		bool	bDefault = `false`
	)

virtual

Gets an attribute bool.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bThrowError	true to throw error.
bDefault	true to default.

Returns: The attribute bool.

Definition at line 1129 of file StdXml.cpp.

References StdUtils::Std_CheckString(), StdUtils::Std_IsBlank(), and ValueErrorString().

Here is the call graph for this function:

double StdUtils::CStdXml::GetAttribDouble	(	std::string	strAttribName,
		bool	bThrowError = `true`,
		double	dblDefault = `0`
	)

virtual

Gets an attribute double.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bThrowError	true to throw error.
dblDefault	The double default.

Returns: The attribute double.

Definition at line 1061 of file StdXml.cpp.

References StdUtils::Std_IsBlank(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Referenced by StdUtils::Std_LoadPoint().

Here is the call graph for this function:

Here is the caller graph for this function:

float StdUtils::CStdXml::GetAttribFloat	(	std::string	strAttribName,
		bool	bThrowError = `true`,
		float	fltDefault = `0`
	)

virtual

Gets an attribute float.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bThrowError	true to throw error.
fltDefault	The flt default.

Returns: The attribute float.

Definition at line 1095 of file StdXml.cpp.

References StdUtils::Std_IsBlank(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Referenced by StdUtils::CStdColor::Load(), StdUtils::Std_LoadColor(), and StdUtils::Std_LoadPoint().

Here is the call graph for this function:

Here is the caller graph for this function:

int StdUtils::CStdXml::GetAttribInt	(	std::string	strAttribName,
		bool	bThrowError = `true`,
		int	iDefault = `0`
	)

virtual

Gets an attribute int.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bThrowError	true to throw error.
iDefault	The default.

Returns: The attribute int.

Definition at line 1024 of file StdXml.cpp.

References StdUtils::Std_IsBlank(), StdUtils::Std_IsIntegerType(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Referenced by StdUtils::Std_LoadPoint().

Here is the call graph for this function:

Here is the caller graph for this function:

long StdUtils::CStdXml::GetAttribLong	(	std::string	strAttribName,
		bool	bThrowError = `true`,
		long	lDefault = `0`
	)

virtual

Gets an attribute long.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bThrowError	true to throw error.
lDefault	The default.

Returns: The attribute long.

Definition at line 987 of file StdXml.cpp.

References StdUtils::Std_IsBlank(), StdUtils::Std_IsIntegerType(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Referenced by StdUtils::Std_LoadPoint().

Here is the call graph for this function:

Here is the caller graph for this function:

std::string StdUtils::CStdXml::GetAttribString	(	std::string	strAttribName,
		bool	bCanBeBlank = `false`,
		bool	bThrowError = `true`,
		std::string	strDefault = `""`
	)

virtual

Gets an attribute string of an element.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bCanBeBlank	true if can be blank.
bThrowError	true to throw error.
strDefault	The string default.

Returns: The attribute string.

Definition at line 960 of file StdXml.cpp.

References StdUtils::Std_IsBlank(), and ValueErrorString().

Here is the call graph for this function:

bool StdUtils::CStdXml::GetChildAttribBool	(	std::string	strAttribName,
		bool	bThrowError = `true`,
		bool	bDefault = `false`
	)

virtual

Gets a child attribute bool.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bThrowError	true to throw error.
bDefault	true to default.

Returns: The child attribute bool.

Definition at line 1468 of file StdXml.cpp.

References StdUtils::Std_CheckString(), StdUtils::Std_IsBlank(), and ValueErrorString().

Referenced by StdUtils::CStdFont::Load().

Here is the call graph for this function:

Here is the caller graph for this function:

double StdUtils::CStdXml::GetChildAttribDouble	(	std::string	strAttribName,
		bool	bThrowError = `true`,
		double	dblDefault = `0`
	)

virtual

Gets a child attribute double.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bThrowError	true to throw error.
dblDefault	The double default.

Returns: The child attribute double.

Definition at line 1404 of file StdXml.cpp.

References StdUtils::Std_IsBlank(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Here is the call graph for this function:

float StdUtils::CStdXml::GetChildAttribFloat	(	std::string	strAttribName,
		bool	bThrowError = `true`,
		float	fltDefault = `0`
	)

virtual

Gets a child attribute float.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bThrowError	true to throw error.
fltDefault	The flt default.

Returns: The child attribute float.

Definition at line 1436 of file StdXml.cpp.

References StdUtils::Std_IsBlank(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Referenced by StdUtils::CStdFont::Load().

Here is the call graph for this function:

Here is the caller graph for this function:

int StdUtils::CStdXml::GetChildAttribInt	(	std::string	strAttribName,
		bool	bThrowError = `true`,
		int	iDefault = `0`
	)

virtual

Gets a child attribute int.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bThrowError	true to throw error.
iDefault	The default.

Returns: The child attribute int.

Definition at line 1369 of file StdXml.cpp.

References StdUtils::Std_IsBlank(), StdUtils::Std_IsIntegerType(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Referenced by StdUtils::Std_LoadRGB().

Here is the call graph for this function:

Here is the caller graph for this function:

long StdUtils::CStdXml::GetChildAttribLong	(	std::string	strAttribName,
		bool	bThrowError = `true`,
		long	lDefault = `0`
	)

virtual

Gets a child attribute long.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bThrowError	true to throw error.
lDefault	The default.

Returns: The child attribute long.

Definition at line 1334 of file StdXml.cpp.

References StdUtils::Std_IsBlank(), StdUtils::Std_IsIntegerType(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Here is the call graph for this function:

std::string StdUtils::CStdXml::GetChildAttribString	(	std::string	strAttribName,
		bool	bCanBeBlank = `false`,
		bool	bThrowError = `true`,
		std::string	strDefault = `""`
	)

virtual

Gets a child attribute string.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bCanBeBlank	true if can be blank.
bThrowError	true to throw error.
strDefault	The string default.

Returns: The child attribute string.

Definition at line 1307 of file StdXml.cpp.

References StdUtils::Std_IsBlank(), and ValueErrorString().

Referenced by StdUtils::CStdFont::Load().

Here is the call graph for this function:

Here is the caller graph for this function:

bool StdUtils::CStdXml::GetChildBool ( std::string strElementName )

virtual

Gets a bool value from the element with the specified name.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName Name of the string element.

Returns: The child bool value.

Definition at line 699 of file StdXml.cpp.

References FindChildElement(), StdUtils::Std_CheckString(), and ValueErrorString().

Referenced by AnimatSimPy::ScriptProcessorPy::Load(), StdUtils::CStdVariant::Load(), AnimatSim::AnimatBase::Load(), StdUtils::CStdLookupTable::Load(), AnimatSim::Simulator::Load(), and AnimatSim::Simulator::LoadEnvironment().

Here is the call graph for this function:

Here is the caller graph for this function:

bool StdUtils::CStdXml::GetChildBool	(	std::string	strElementName,
		bool	bDefault
	)

virtual

Gets a float value from the element with the specified name. It uses the default if no element is found.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the string element.
bDefault	bool default value.

Returns: The child bool value.

Definition at line 728 of file StdXml.cpp.

References FindChildElement(), and StdUtils::Std_CheckString().

Here is the call graph for this function:

bool StdUtils::CStdXml::GetChildBool ( )

virtual

Gets a bool value from the currently selected element.

Author: dcofer

Date: 5/4/2011

Returns: The child bool value.

Definition at line 672 of file StdXml.cpp.

References StdUtils::Std_CheckString(), and ValueErrorString().

Here is the call graph for this function:

std::string StdUtils::CStdXml::GetChildDoc ( )

virtual

Gets a child document.

Author: dcofer

Date: 5/4/2011

Returns: The child document.

Definition at line 1654 of file StdXml.cpp.

double StdUtils::CStdXml::GetChildDouble ( std::string strElementName )

virtual

Gets a double value from the element with the specified name.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName Name of the string element.

Returns: The child double value.

Definition at line 538 of file StdXml.cpp.

References FindChildElement(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Referenced by OsgAnimatSim::Visualization::ControlPoint::Load(), VortexAnimatSim::Visualization::ControlPoint::Load(), StdUtils::CStdVariant::Load(), and StdUtils::CStdLookupTable::Load().

Here is the call graph for this function:

Here is the caller graph for this function:

double StdUtils::CStdXml::GetChildDouble	(	std::string	strElementName,
		double	dblDefault
	)

virtual

Gets a double value from the element with the specified name. It uses the default if no element is found.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the string element.
dblDefault	The double default value.

Returns: The child double value.

Definition at line 564 of file StdXml.cpp.

References FindChildElement(), StdUtils::Std_IsNumeric(), and StdUtils::Std_Trim().

Here is the call graph for this function:

double StdUtils::CStdXml::GetChildDouble ( )

virtual

Gets a double value from the currently selected element.

Author: dcofer

Date: 5/4/2011

Returns: The child double value.

Definition at line 514 of file StdXml.cpp.

References StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Here is the call graph for this function:

float StdUtils::CStdXml::GetChildFloat ( std::string strElementName )

virtual

Gets a float value from the element with the specified name.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName Name of the string element.

Returns: The child float value.

Definition at line 617 of file StdXml.cpp.

References FindChildElement(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Referenced by StdUtils::CStdVariant::Load(), AnimatSim::Simulator::Load(), AnimatSim::Simulator::LoadEnvironment(), and AnimatSim::Environment::Structure::LoadLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

float StdUtils::CStdXml::GetChildFloat	(	std::string	strElementName,
		float	fltDefault
	)

virtual

Gets a float value from the element with the specified name. It uses the default if no element is found.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the string element.
fltDefault	The float default value.

Returns: The child float value.

Definition at line 643 of file StdXml.cpp.

References FindChildElement(), StdUtils::Std_IsNumeric(), and StdUtils::Std_Trim().

Here is the call graph for this function:

float StdUtils::CStdXml::GetChildFloat ( )

virtual

Gets a float value from the currently selected element.

Author: dcofer

Date: 5/4/2011

Returns: The child float value.

Definition at line 593 of file StdXml.cpp.

References StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Here is the call graph for this function:

int StdUtils::CStdXml::GetChildInt ( std::string strElementName )

virtual

Gets an integer value from the element with the specified name.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName Name of the string element.

Returns: The child integer value.

Definition at line 456 of file StdXml.cpp.

References FindChildElement(), StdUtils::Std_IsIntegerType(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Referenced by HybridInterfaceSim::Robotics::HiC884Controller::Load(), HybridInterfaceSim::Robotics::HiSpike2::Load(), RoboticsAnimatSim::Robotics::RobotIOControls::DynamixelUSB::RbDynamixelUSB::Load(), RoboticsAnimatSim::Robotics::RobotIOControls::Firmata::RbFirmataController::Load(), RoboticsAnimatSim::Robotics::RobotIOControls::RbAnimatSerial::Load(), RoboticsAnimatSim::Robotics::RobotIOControls::RbXBeeCommander::Load(), StdUtils::CStdVariant::Load(), AnimatSim::Simulator::Load(), and AnimatSim::Simulator::LoadEnvironment().

Here is the call graph for this function:

Here is the caller graph for this function:

int StdUtils::CStdXml::GetChildInt	(	std::string	strElementName,
		int	iDefault
	)

virtual

Gets an integer value from the element with the specified name. It uses the default if no element is found.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the string element.
iDefault	The default value.

Returns: The child integer value.

Definition at line 485 of file StdXml.cpp.

References FindChildElement(), StdUtils::Std_IsIntegerType(), StdUtils::Std_IsNumeric(), and StdUtils::Std_Trim().

Here is the call graph for this function:

int StdUtils::CStdXml::GetChildInt ( )

virtual

Gets an integer value from the currently selected element.

Author: dcofer

Date: 5/4/2011

Returns: The child integer value.

Definition at line 429 of file StdXml.cpp.

References StdUtils::Std_IsIntegerType(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Here is the call graph for this function:

long StdUtils::CStdXml::GetChildLong ( std::string strElementName )

virtual

Gets a long value from the element with the specified name.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName Name of the string element.

Returns: The child long value.

Definition at line 371 of file StdXml.cpp.

References FindChildElement(), StdUtils::Std_IsIntegerType(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Referenced by StdUtils::CStdVariant::Load().

Here is the call graph for this function:

Here is the caller graph for this function:

long StdUtils::CStdXml::GetChildLong	(	std::string	strElementName,
		long	lDefault
	)

virtual

Gets a long value from the element with the specified name. It uses the default if no element is found.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the string element.
lDefault	The default value.

Returns: The child long value.

Definition at line 400 of file StdXml.cpp.

References FindChildElement(), StdUtils::Std_IsIntegerType(), StdUtils::Std_IsNumeric(), and StdUtils::Std_Trim().

Here is the call graph for this function:

long StdUtils::CStdXml::GetChildLong ( )

virtual

Gets a long value from the currently selected element.

Author: dcofer

Date: 5/4/2011

Returns: The child long value.

Definition at line 344 of file StdXml.cpp.

References StdUtils::Std_IsIntegerType(), StdUtils::Std_IsNumeric(), StdUtils::Std_Trim(), and ValueErrorString().

Here is the call graph for this function:

std::string StdUtils::CStdXml::GetChildString ( std::string strElementName )

virtual

Gets a string value from the element with the specified name.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName Name of the string element.

Returns: The child string.

Definition at line 307 of file StdXml.cpp.

References FindChildElement().

Here is the call graph for this function:

std::string StdUtils::CStdXml::GetChildString	(	std::string	strElementName,
		std::string	strDefault
	)

virtual

Gets a string value from the element with the specified name. It uses the default if no element is found.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the string element.
strDefault	The default value.

Returns: The child string.

Definition at line 324 of file StdXml.cpp.

References FindChildElement().

Here is the call graph for this function:

std::string StdUtils::CStdXml::GetChildString ( )

virtual

Gets a string value from the currently selected element.

Author: dcofer

Date: 5/4/2011

Returns: The child string.

Definition at line 294 of file StdXml.cpp.

std::string StdUtils::CStdXml::GetParentTagName ( )

virtual

Gets the parent tag name.

Author: dcofer

Date: 5/4/2011

Returns: The parent tag name.

Definition at line 1667 of file StdXml.cpp.

References IntoElem(), and OutOfElem().

Here is the call graph for this function:

bool StdUtils::CStdXml::IntoChildElement	(	std::string	strElementName,
		bool	bThrowError = `true`
	)

virtual

Goes into the child element with the specified name.

Author: dcofer

Date: 5/4/2011

Parameters

strElementName	Name of the string element.
bThrowError	true to throw error.

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

Definition at line 278 of file StdXml.cpp.

References FindChildElement(), and IntoElem().

Referenced by StdUtils::CStdColor::Load(), AnimatSim::Simulator::LoadEnvironment(), AnimatSim::Behavior::NeuralModule::LoadExternalSynapses(), AnimatSim::Gains::LoadGain(), AnimatSim::Environment::RigidBody::LoadJoint(), AnimatSim::Environment::Organism::LoadRobotInterface(), StdUtils::Std_LoadColor(), and StdUtils::Std_SavePoint().

Here is the call graph for this function:

Here is the caller graph for this function:

bool StdUtils::CStdXml::IntoElem ( )

virtual

Goes into the next element where the cursor is located.

Author: dcofer

Date: 5/4/2011

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

Reimplemented from StdUtils::CMarkupSTL.

Definition at line 42 of file StdXml.cpp.

References m_aryTagStack.

void StdUtils::CStdXml::Load ( std::string strFilename )

virtual

Loads an xml data file.

Author: dcofer

Date: 5/4/2011

Parameters

strFilename The name of the file to load.

Definition at line 1685 of file StdXml.cpp.

References StdUtils::Std_IsBlank().

Referenced by AnimatSim::Charting::DataChart::Load(), and AnimatSim::Simulator::Load().

Here is the call graph for this function:

Here is the caller graph for this function:

int StdUtils::CStdXml::NumberOfChildren ( )

virtual

Gets the number of children of the current element.

Author: dcofer

Date: 5/4/2011

Returns: The total number of children.

Definition at line 202 of file StdXml.cpp.

Referenced by StdUtils::CStdLookupTable::Load(), AnimatSim::Environment::Bodies::LineBase::LoadAttachments(), AnimatSim::Simulator::LoadEnvironment(), AnimatSim::Behavior::NeuralModule::LoadExternalSynapses(), and AnimatSim::Environment::Structure::LoadLayout().

Here is the caller graph for this function:

bool StdUtils::CStdXml::OutOfElem ( )

virtual

Goes out of the element where the cursor is located.

Author: dcofer

Date: 5/4/2011

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

Reimplemented from StdUtils::CMarkupSTL.

Definition at line 56 of file StdXml.cpp.

References m_aryTagStack.

void StdUtils::CStdXml::Save ( std::string strFilename )

virtual

Saves am xml data file.

Author: dcofer

Date: 5/4/2011

Parameters

strFilename The name of the file to save.

Definition at line 1711 of file StdXml.cpp.

References StdUtils::Std_IsBlank().

Here is the call graph for this function:

std::string StdUtils::CStdXml::Serialize ( )

virtual

Serializes the document to a string.

Author: dcofer

Date: 5/4/2011

Returns: xml document string.

Definition at line 151 of file StdXml.cpp.

void StdUtils::CStdXml::SetAttrib	(	std::string	strAttribName,
		std::string	strData
	)

virtual

Sets an attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
strData	Data in the attribute.

Definition at line 1163 of file StdXml.cpp.

References FullTagPath().

Referenced by SetAttrib(), and StdUtils::Std_SavePoint().

Here is the call graph for this function:

Here is the caller graph for this function:

void StdUtils::CStdXml::SetAttrib	(	std::string	strAttribName,
		char	cVal
	)

virtual

Sets an attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
cVal	Data in the attribute.

Definition at line 1178 of file StdXml.cpp.

References SetAttrib().

Here is the call graph for this function:

void StdUtils::CStdXml::SetAttrib	(	std::string	strAttribName,
		unsigned char	cVal
	)

virtual

Sets an attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
cVal	Data in the attribute.

Definition at line 1196 of file StdXml.cpp.

References SetAttrib().

Here is the call graph for this function:

void StdUtils::CStdXml::SetAttrib	(	std::string	strAttribName,
		long	lVal
	)

virtual

Sets an attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
lVal	Data in the attribute.

Definition at line 1214 of file StdXml.cpp.

References SetAttrib().

Here is the call graph for this function:

void StdUtils::CStdXml::SetAttrib	(	std::string	strAttribName,
		int	iVal
	)

virtual

Sets an attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
iVal	Data in the attribute.

Definition at line 1231 of file StdXml.cpp.

References SetAttrib().

Here is the call graph for this function:

void StdUtils::CStdXml::SetAttrib	(	std::string	strAttribName,
		double	dblVal
	)

virtual

Sets an attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
dblVal	Data in the attribute.

Definition at line 1248 of file StdXml.cpp.

References SetAttrib().

Here is the call graph for this function:

void StdUtils::CStdXml::SetAttrib	(	std::string	strAttribName,
		float	fltVal
	)

virtual

Sets an attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
fltVal	Data in the attribute.

Definition at line 1265 of file StdXml.cpp.

References SetAttrib().

Here is the call graph for this function:

void StdUtils::CStdXml::SetAttrib	(	std::string	strAttribName,
		bool	bVal
	)

virtual

Sets an attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bVal	Data in the attribute.

Definition at line 1282 of file StdXml.cpp.

References SetAttrib().

Here is the call graph for this function:

void StdUtils::CStdXml::SetChildAttrib	(	std::string	strAttribName,
		std::string	strVal
	)

virtual

Sets a child attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
strVal	The string value.

Definition at line 1500 of file StdXml.cpp.

References FullTagPath().

Referenced by StdUtils::CStdFont::Save(), and SetChildAttrib().

Here is the call graph for this function:

Here is the caller graph for this function:

void StdUtils::CStdXml::SetChildAttrib	(	std::string	strAttribName,
		char	cVal
	)

virtual

Sets a child attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
cVal	The value.

Definition at line 1515 of file StdXml.cpp.

References SetChildAttrib().

Here is the call graph for this function:

void StdUtils::CStdXml::SetChildAttrib	(	std::string	strAttribName,
		unsigned char	cVal
	)

virtual

Sets a child attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
cVal	The value.

Definition at line 1533 of file StdXml.cpp.

References SetChildAttrib().

Here is the call graph for this function:

void StdUtils::CStdXml::SetChildAttrib	(	std::string	strAttribName,
		long	lVal
	)

virtual

Sets a child attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
lVal	The value.

Definition at line 1551 of file StdXml.cpp.

References SetChildAttrib().

Here is the call graph for this function:

void StdUtils::CStdXml::SetChildAttrib	(	std::string	strAttribName,
		int	iVal
	)

virtual

Sets a child attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
iVal	The value.

Definition at line 1568 of file StdXml.cpp.

References SetChildAttrib().

Here is the call graph for this function:

void StdUtils::CStdXml::SetChildAttrib	(	std::string	strAttribName,
		double	dblVal
	)

virtual

Sets a child attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
dblVal	The double value.

Definition at line 1585 of file StdXml.cpp.

References SetChildAttrib().

Here is the call graph for this function:

void StdUtils::CStdXml::SetChildAttrib	(	std::string	strAttribName,
		float	fltVal
	)

virtual

Sets a child attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
fltVal	The float value.

Definition at line 1602 of file StdXml.cpp.

References SetChildAttrib().

Here is the call graph for this function:

void StdUtils::CStdXml::SetChildAttrib	(	std::string	strAttribName,
		bool	bVal
	)

virtual

Sets a child attribute.

Author: dcofer

Date: 5/4/2011

Parameters

strAttribName	Name of the string attribute.
bVal	The bool value.

Definition at line 1619 of file StdXml.cpp.

References SetChildAttrib().

Here is the call graph for this function:

std::string StdUtils::CStdXml::ValueErrorString ( std::string strValue )

protectedvirtual

Generates a value error string.

Author: dcofer

Date: 5/4/2011

Parameters

strValue The string value.

Returns: .

Definition at line 122 of file StdXml.cpp.

References FullTagPath().

Referenced by GetAttribBool(), GetAttribDouble(), GetAttribFloat(), GetAttribInt(), GetAttribLong(), GetAttribString(), GetChildAttribBool(), GetChildAttribDouble(), GetChildAttribFloat(), GetChildAttribInt(), GetChildAttribLong(), GetChildAttribString(), GetChildBool(), GetChildDouble(), GetChildFloat(), GetChildInt(), and GetChildLong().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation