zeus::TXObject Class Reference

#include <XObject.h>

Inheritance diagram for zeus::TXObject:

List of all members.

Public Member Functions
	TXObject (IXMLNode &rNode)
virtual TString	getXMLStream () const
virtual TString	getCodeModule () const
virtual void MQUALIFIER	getName (IString &rName) const
virtual void MQUALIFIER	getClassName (IString &rName) const
virtual Uint MQUALIFIER	getID () const
virtual Retval MQUALIFIER	addChild (IXObject &rChild)
virtual Retval MQUALIFIER	deleteChild (Int iIndex, bool bDoFreeze=false)
virtual Retval MQUALIFIER	removeChild (IXObject &rChild, bool bDoFreeze=false)
virtual Int MQUALIFIER	getChildCount () const
virtual Retval MQUALIFIER	getChild (Int iIndex, IXObject *&rpChild)
virtual Retval MQUALIFIER	getChildByName (const IString &rName, IXObject *&rpChild)
virtual Retval MQUALIFIER	getChildrenByName (const IString &name, IXObjectCollection *&pObjects)
virtual Retval MQUALIFIER	getParent (IXObject *&rpParent) const
virtual Retval MQUALIFIER	setParent (IXObject *pParent)
virtual Retval MQUALIFIER	getXMLNode (IXMLNode *&rpNode) const
virtual Retval MQUALIFIER	setChild (IXObject &rChild)
virtual Retval MQUALIFIER	getObject (const IString &rPath, IXObject *&rpObj)
virtual Retval MQUALIFIER	getObjects (const IString &rPath, IXObjectCollection *&pObjects)
virtual Retval MQUALIFIER	getRootObject (IXObject *&rpObj)
virtual bool MQUALIFIER	canCreateChildren () const
virtual bool MQUALIFIER	freeze ()
virtual bool MQUALIFIER	unfreeze ()
virtual bool MQUALIFIER	isFrozen () const
virtual void MQUALIFIER	setTreeLock (ICriticalSection *pSection)
virtual void MQUALIFIER	lockTree ()
virtual void MQUALIFIER	unlockTree ()
virtual Retval MQUALIFIER	onExecute (ISimpleCommand &rCommand, Uint uiMode)
virtual void MQUALIFIER	onBroadCast (ISimpleCommand &rMessage)
virtual Retval MQUALIFIER	insertChild (Int iIndex, IXObject &rChild)
virtual Int MQUALIFIER	indexOfChild (IXObject &rChild)
virtual Retval MQUALIFIER	createChildObject (const IString &rName, const IString &rClassName, const IString &rCodeModule, IXObject *&rpChild)
virtual Retval MQUALIFIER	createChildObjectCustom (const IString &rName, const IString &rClassName, const IString &rCodeModule, const IStringList &rList, IXObject *&rpChild)
virtual Retval MQUALIFIER	getCastedObject (const IString &rPath, const InterfaceID &rInterfaceID, IZUnknown *&rpObj)
virtual Retval MQUALIFIER	readIntAttribute (const IString &rName, Int &rValue, Int iDefault=0) const
virtual Retval MQUALIFIER	readUintAttribute (const IString &rName, Uint &rValue, Uint uiDefault=0) const
virtual Retval MQUALIFIER	readFloatAttribute (const IString &rName, Float &rValue, Float fDefault=0) const
virtual Retval MQUALIFIER	readStringAttribute (const IString &rName, IString &rValue) const
virtual Retval MQUALIFIER	readTimevalAttribute (const IString &rstrName, Timeval &rtmValue, Timeval rtmDefault=0) const
virtual Retval MQUALIFIER	readBoolAttribute (const IString &rstrName, bool &rbValue, bool bDefault=false) const
virtual Retval MQUALIFIER	storeIntAttribute (const IString &rName, const Int &rValue)
virtual Retval MQUALIFIER	storeUintAttribute (const IString &rName, const Uint &rValue)
virtual Retval MQUALIFIER	storeFloatAttribute (const IString &rName, const Float &rValue)
virtual Retval MQUALIFIER	storeStringAttribute (const IString &rName, const IString &rValue)
virtual Retval MQUALIFIER	storeTimevalAttribute (const IString &rstrName, const Timeval &rtmValue)
virtual Retval MQUALIFIER	storeBoolAttribute (const IString &rstrName, const bool &rbValue)
virtual Int MQUALIFIER	getMemberCount () const
virtual Retval MQUALIFIER	getMemberVariable (Int iIndex, IXMemberVariable *&rpMember) const
virtual Retval MQUALIFIER	getMemberVariableByName (const IString &rName, IXMemberVariable *&rpMember) const
virtual Retval MQUALIFIER	addNewMemberVariable (const IString &rName, IXMemberVariable::EVariableType eType)
virtual Retval MQUALIFIER	removeMemberVariable (const IString &rName)
virtual Retval MQUALIFIER	getMemberObjectReference (const IString &rName, IXObject *&rpRef)
virtual Retval MQUALIFIER	getMemberXMLNode (const IString &rName, IXMLNode *&rpNode) const
virtual Retval MQUALIFIER	readMemberVariable (const IString &rName, IZVariant &rValue) const
virtual Retval MQUALIFIER	storeMemberVariable (const IString &rName, const IZVariant &rValue)
virtual void MQUALIFIER	resetMemberVariables ()
virtual Retval MQUALIFIER	askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)
virtual void MQUALIFIER	addRef () const
virtual void MQUALIFIER	release () const
virtual void	setObjName (const TString &rName)
Protected Member Functions
	TXObject ()
virtual	~TXObject ()
virtual void	onChildAdded (IXObject &)
virtual void	onChildDeleted (IXObject &)
void	freezeChildren ()
void	unfreezeChildren ()
Retval	readAttribute (TString strName, TString &rValue) const
Retval	readAttribute (TString strName, Int &rValue) const
Retval	readAttribute (TString strName, Uint &rValue) const
Retval	readAttribute (TString strName, Float &rValue) const
Retval	storeAttribute (TString strName, TString strValue)
Retval	storeAttribute (TString strName, Int iValue)
Retval	storeAttribute (TString strName, Uint uiValue)
Retval	storeAttribute (TString strName, Float fValue)
Protected Attributes
IXMLNode *	m_pNode
	XML Node. This variable must be a pointer because of TXLoaderObject. The pointer is always valid.
ICriticalSection *	m_pTreeLock
	Lock of the data and object tree.
TXMemberCollection *	m_pMemberVariables
	X-Object member variables.

---

Detailed Description

This is the base class for all XML based objects.

---

Constructor & Destructor Documentation

zeus::TXObject::TXObject

(

IXMLNode &

rNode )

Creates the xml object

Parameters:

rNode

: XML Node representing this object

zeus::TXObject::TXObject

(

)

[protected]

Creates an empty XML object. This constructor is protected

zeus::TXObject::~TXObject

(

)

[protected, virtual]

Destroyes the Object

---

Member Function Documentation

Retval MQUALIFIER zeus::TXObject::addChild

(

IXObject &

rChild )

[virtual]

See also:

IXObject::addChild

Implements zeus::IXObject.

Reimplemented in zeus::TXLoaderObject.

Retval MQUALIFIER zeus::TXObject::addNewMemberVariable	(	const IString &	rName,
		IXMemberVariable::EVariableType	eType
	)		[virtual]

See also:

IXObject::addNewMemberVariable

Implements zeus::IXObject.

virtual void MQUALIFIER zeus::TXObject::addRef

(

)

const [virtual]

See also:

IZUnknown::addRef

Reimplemented from zeus::TZObject.

Reimplemented in zeus::TModule, zeus::TSimpleCommand, zeus::TSystemManager, zeus::TAbstractXProcess, zeus::TXProcProject, zeus::TXProcTarget, zeus::TNamedContext, zeus::TNamedObject, zeus::TXErrorObject, zeus::TXLoaderObject, and zeus::TXRootObject.

virtual Retval MQUALIFIER zeus::TXObject::askForInterface	(	const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpIface
	)		[virtual]

See also:

IZUnknown::askForInterface

Reimplemented from zeus::TZObject.

Reimplemented in zeus::TModule, zeus::TSimpleCommand, zeus::TSystemManager, zeus::TAbstractXProcess, zeus::TXProcProject, zeus::TXProcTarget, zeus::TNamedContext, zeus::TNamedObject, zeus::TXErrorObject, zeus::TXLoaderObject, and zeus::TXRootObject.

bool MQUALIFIER zeus::TXObject::canCreateChildren

(

)

const [inline, virtual]

See also:

IXObject::canCreateChildren

Implements zeus::IXObject.

Reimplemented in zeus::TXLoaderObject.

Retval MQUALIFIER zeus::TXObject::createChildObject	(	const IString &	rName,
		const IString &	rClassName,
		const IString &	rCodeModule,
		IXObject *&	rpChild
	)		[inline, virtual]

See also:

IXObject::createChildObject

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::createChildObjectCustom	(	const IString &	rName,
		const IString &	rClassName,
		const IString &	rCodeModule,
		const IStringList &	rList,
		IXObject *&	rpChild
	)		[virtual]

See also:

IXObject::createChildObjectWithID

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::deleteChild	(	Int	iIndex,
		bool	bDoFreeze = false
	)		[virtual]

See also:

IXObject::deleteChild

Implements zeus::IXObject.

bool MQUALIFIER zeus::TXObject::freeze

(

)

[virtual]

See also:

IXObject::freeze

Implements zeus::IXObject.

Reimplemented in zeus::TModule, zeus::TSimpleCommand, zeus::TSystemManager, and zeus::TXLoaderObject.

void zeus::TXObject::freezeChildren

(

)

[protected]

freezes all child objects

Retval MQUALIFIER zeus::TXObject::getCastedObject	(	const IString &	rPath,
		const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpObj
	)		[virtual]

See also:

IXObject::getCastedObject

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::getChild	(	Int	iIndex,
		IXObject *&	rpChild
	)		[virtual]

See also:

IXObject::getChild

Implements zeus::IXObject.

Reimplemented in zeus::TXLoaderObject.

Retval MQUALIFIER zeus::TXObject::getChildByName	(	const IString &	rName,
		IXObject *&	rpChild
	)		[virtual]

See also:

IXObject::getChildByName

Implements zeus::IXObject.

Reimplemented in zeus::TXLoaderObject.

Int MQUALIFIER zeus::TXObject::getChildCount

(

)

const [inline, virtual]

See also:

IXObject::getChildCount

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::getChildrenByName	(	const IString &	rName,
		IXObjectCollection *&	pObjects
	)		[virtual]

See also:

IXObject::getChildrenByName

Implements zeus::IXObject.

void MQUALIFIER zeus::TXObject::getClassName

(

IString &

rName )

const [virtual]

See also:

IXObject::getClassName

Implements zeus::IXObject.

TString zeus::TXObject::getCodeModule

(

)

const [virtual]

Returns the codemodule of this object

Returns:

name of code module

Uint MQUALIFIER zeus::TXObject::getID

(

)

const [virtual]

See also:

IXObject::getID

Implements zeus::IXObject.

Int MQUALIFIER zeus::TXObject::getMemberCount

(

)

const [virtual]

See also:

IXObject::getMemberCount

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::getMemberObjectReference	(	const IString &	rName,
		IXObject *&	rpRef
	)		[virtual]

See also:

IXObject::readMemberVariable

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::getMemberVariable	(	Int	iIndex,
		IXMemberVariable *&	rpMember
	)		const [virtual]

See also:

IXObject::getMemberVariable

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::getMemberVariableByName	(	const IString &	rName,
		IXMemberVariable *&	rpMember
	)		const [virtual]

See also:

IXObject::getMemberVariableByName

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::getMemberXMLNode	(	const IString &	rName,
		IXMLNode *&	rpNode
	)		const [virtual]

See also:

IXObject::readMemberVariable

Implements zeus::IXObject.

void MQUALIFIER zeus::TXObject::getName

(

IString &

rName )

const [inline, virtual]

See also:

IXObject::getName

Implements zeus::IXObject.

Reimplemented in zeus::TModule, and zeus::TSystemManager.

Retval MQUALIFIER zeus::TXObject::getObject	(	const IString &	path,
		IXObject *&	rpObj
	)		[virtual]

See also:

IXObject::getObject

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::getObjects	(	const IString &	path,
		IXObjectCollection *&	pObjects
	)		[virtual]

See also:

IXObject::getObjects

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::getParent

(

IXObject *&

rpParent )

const [virtual]

See also:

IXObject::getParent

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::getRootObject

(

IXObject *&

rpObj )

[virtual]

See also:

IXObject::getRootObject

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::getXMLNode

(

IXMLNode *&

rpNode )

const [virtual]

See also:

IXObject::getXMLNode

Implements zeus::IXObject.

TString zeus::TXObject::getXMLStream

(

)

const [virtual]

Get infomation abaout the xmlobject

Reimplemented in zeus::TXRootObject.

Int MQUALIFIER zeus::TXObject::indexOfChild

(

IXObject &

rChild )

[inline, virtual]

See also:

IXObject::indexOfChild

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::insertChild	(	Int	iIndex,
		IXObject &	rChild
	)		[virtual]

See also:

IXObject::insertChild

Implements zeus::IXObject.

Reimplemented in zeus::TXLoaderObject.

bool MQUALIFIER zeus::TXObject::isFrozen

(

)

const [inline, virtual]

See also:

IXObject::isFrozen

Implements zeus::IXObject.

void MQUALIFIER zeus::TXObject::lockTree

(

)

[virtual]

See also:

IXObject::lockTree

Implements zeus::IXObject.

void MQUALIFIER zeus::TXObject::onBroadCast

(

ISimpleCommand &

rMessage )

[virtual]

See also:

IXObject::onBroadCast

Implements zeus::IXObject.

virtual void zeus::TXObject::onChildAdded

(

IXObject &

)

[inline, protected, virtual]

Reimplemented in zeus::TXProcProject.

virtual void zeus::TXObject::onChildDeleted

(

IXObject &

)

[inline, protected, virtual]

Reimplemented in zeus::TXProcProject.

Retval MQUALIFIER zeus::TXObject::onExecute	(	ISimpleCommand &	rCommand,
		Uint	uiMode
	)		[inline, virtual]

See also:

IXObject::onExecute

Implements zeus::IXObject.

Retval zeus::TXObject::readAttribute	(	TString	strName,
		TString &	rValue
	)		const [inline, protected]

Retval zeus::TXObject::readAttribute	(	TString	strName,
		Uint &	rValue
	)		const [inline, protected]

Retval zeus::TXObject::readAttribute	(	TString	strName,
		Float &	rValue
	)		const [inline, protected]

Retval zeus::TXObject::readAttribute	(	TString	strName,
		Int &	rValue
	)		const [inline, protected]

Retval MQUALIFIER zeus::TXObject::readBoolAttribute	(	const IString &	rstrName,
		bool &	rbValue,
		bool	bDefault = false
	)		const [virtual]

See also:

IXObject::readBoolAttribute

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::readFloatAttribute	(	const IString &	rName,
		Float &	rValue,
		Float	fDefault = 0
	)		const [virtual]

See also:

IXObject::readFloatAttribute

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::readIntAttribute	(	const IString &	rName,
		Int &	rValue,
		Int	iDefault = 0
	)		const [virtual]

See also:

IXObject::readIntAttribute

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::readMemberVariable	(	const IString &	rName,
		IZVariant &	rValue
	)		const [virtual]

See also:

IXObject::readMemberVariable

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::readStringAttribute	(	const IString &	rName,
		IString &	rValue
	)		const [virtual]

See also:

IXObject::readStringAttribute

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::readTimevalAttribute	(	const IString &	rstrName,
		Timeval &	rtmValue,
		Timeval	rtmDefault = 0
	)		const [virtual]

See also:

IXObject::readTimevalAttribute

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::readUintAttribute	(	const IString &	rName,
		Uint &	rValue,
		Uint	uiDefault = 0
	)		const [virtual]

See also:

IXObject::readUintAttribute

Implements zeus::IXObject.

virtual void MQUALIFIER zeus::TXObject::release

(

)

const [virtual]

See also:

IZUnknown::release

Reimplemented from zeus::TZObject.

Reimplemented in zeus::TModule, zeus::TSimpleCommand, zeus::TSystemManager, zeus::TAbstractXProcess, zeus::TXProcProject, zeus::TXProcTarget, zeus::TNamedContext, zeus::TNamedObject, zeus::TXErrorObject, zeus::TXLoaderObject, and zeus::TXRootObject.

Retval MQUALIFIER zeus::TXObject::removeChild	(	IXObject &	rChild,
		bool	bDoFreeze = false
	)		[virtual]

See also:

IXObject::removeChild

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::removeMemberVariable

(

const IString &

rName )

[virtual]

See also:

IXObject::removeMemberVariable

Implements zeus::IXObject.

void MQUALIFIER zeus::TXObject::resetMemberVariables

(

)

[virtual]

See also:

IXObject::resetMemberVariables

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::setChild

(

IXObject &

rChild )

[virtual]

DO NOT USE THIS METHOD. ITS USED FROM THE FACTORY.

See also:

IXObject::setChild

Implements zeus::IXObject.

void zeus::TXObject::setObjName

(

const TString &

rName )

[inline, virtual]

See also:

TZObject::setObjName

Reimplemented from zeus::TZObject.

Retval MQUALIFIER zeus::TXObject::setParent

(

IXObject *

parent )

[inline, virtual]

See also:

IXObject::setParent

Implements zeus::IXObject.

void MQUALIFIER zeus::TXObject::setTreeLock

(

ICriticalSection *

section )

[virtual]

See also:

IXObject::setTreeLock

Implements zeus::IXObject.

Retval zeus::TXObject::storeAttribute	(	TString	strName,
		Uint	uiValue
	)		[inline, protected]

Retval zeus::TXObject::storeAttribute	(	TString	strName,
		TString	strValue
	)		[inline, protected]

Retval zeus::TXObject::storeAttribute	(	TString	strName,
		Int	iValue
	)		[inline, protected]

Retval zeus::TXObject::storeAttribute	(	TString	strName,
		Float	fValue
	)		[inline, protected]

Retval MQUALIFIER zeus::TXObject::storeBoolAttribute	(	const IString &	rstrName,
		const bool &	rbValue
	)		[virtual]

See also:

IXObject::storeBoolAttribute

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::storeFloatAttribute	(	const IString &	rName,
		const Float &	rValue
	)		[virtual]

See also:

IXObject::storeFloatAttribute

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::storeIntAttribute	(	const IString &	rName,
		const Int &	rValue
	)		[virtual]

See also:

IXObject::storeIntAttribute

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::storeMemberVariable	(	const IString &	rName,
		const IZVariant &	rValue
	)		[virtual]

See also:

IXObject::storeMemberVariable

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::storeStringAttribute	(	const IString &	rName,
		const IString &	rValue
	)		[virtual]

See also:

IXObject::storeStringAttribute

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::storeTimevalAttribute	(	const IString &	rstrName,
		const Timeval &	rtmValue
	)		[virtual]

See also:

IXObject::storeTimevalAttribute

Implements zeus::IXObject.

Retval MQUALIFIER zeus::TXObject::storeUintAttribute	(	const IString &	rName,
		const Uint &	rValue
	)		[virtual]

See also:

IXObject::storeUintAttribute

Implements zeus::IXObject.

bool MQUALIFIER zeus::TXObject::unfreeze

(

)

[virtual]

See also:

IXObject::unfreeze

Implements zeus::IXObject.

Reimplemented in zeus::TModule, zeus::TSystemManager, zeus::TXErrorObject, and zeus::TXLoaderObject.

void zeus::TXObject::unfreezeChildren

(

)

[protected]

Unfreezes all child objects

void MQUALIFIER zeus::TXObject::unlockTree

(

)

[virtual]

See also:

IXObject::unlockTree

Implements zeus::IXObject.

---

Member Data Documentation

TXMemberCollection* zeus::TXObject::m_pMemberVariables [mutable, protected]

X-Object member variables.

IXMLNode* zeus::TXObject::m_pNode [protected]

XML Node. This variable must be a pointer because of TXLoaderObject. The pointer is always valid.

ICriticalSection* zeus::TXObject::m_pTreeLock [protected]

Lock of the data and object tree.

---

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

• XObject.h
• XObject.cpp