ZeusBase-Library  2.0.4
zeus::TXObject Class Reference

#include <XObject.h>

Inheritance diagram for zeus::TXObject:
zeus::TZObject zeus::IXObject zeus::IZUnknown zeus::IZUnknown zeus::TAbstractXProcess zeus::TNamedContext zeus::TNamedObject zeus::TSimpleCommand zeus::TXLoaderObject zeus::TXProcTarget zeus::TXRootObject zeus::TXProcCall zeus::TXProcCopy zeus::TXProcDelete zeus::TXProcGroup zeus::TXProcProperty zeus::TModule zeus::TSystemManager zeus::TXErrorObject zeus::TXProcProject

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)
 
- Public Member Functions inherited from zeus::TZObject
 TZObject ()
 
 TZObject (const TString &strName)
 
 TZObject (const IString &strName)
 
Uint getHash () const
 
TString toString () const
 
virtual TString getObjName () const
 

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 Member Functions inherited from zeus::TZObject
virtual ~TZObject ()
 
 TZObject (const TZObject &rObject)
 
TZObjectoperator= (const TZObject &rObject)
 
Int getRefCounter () const
 

Protected Attributes

IXMLNodem_pNode
 XML Node. This variable must be a pointer because of TXLoaderObject. The pointer is always valid. More...
 
ICriticalSectionm_pTreeLock
 Lock of the data and object tree. More...
 
TXMemberCollectionm_pMemberVariables
 X-Object member variables. More...
 
- Protected Attributes inherited from zeus::TZObject
Uint m_uiID
 

Additional Inherited Members

- Public Types inherited from zeus::IXObject
typedef Retval MQUALIFIER(* DltCreateXObject) (IXMLNode *pMainNode, IXMLDocument *pDocu, IXObject *&rpObj)
 

Detailed Description

This is the base class for all XML based objects.

Constructor & Destructor Documentation

§ TXObject() [1/2]

zeus::TXObject::TXObject ( IXMLNode rNode)

Creates the xml object

Parameters
rNode: XML Node representing this object

§ TXObject() [2/2]

zeus::TXObject::TXObject ( )
protected

Creates an empty XML object. This constructor is protected

§ ~TXObject()

zeus::TXObject::~TXObject ( )
protectedvirtual

Destroyes the Object

Member Function Documentation

§ addChild()

Retval MQUALIFIER zeus::TXObject::addChild ( IXObject rChild)
virtual
See also
IXObject::addChild

Implements zeus::IXObject.

Reimplemented in zeus::TXLoaderObject.

§ addNewMemberVariable()

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

§ addRef()

§ askForInterface()

§ canCreateChildren()

bool MQUALIFIER zeus::TXObject::canCreateChildren ( ) const
inlinevirtual
See also
IXObject::canCreateChildren

Implements zeus::IXObject.

Reimplemented in zeus::TXLoaderObject.

§ createChildObject()

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

§ createChildObjectCustom()

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.

§ deleteChild()

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

§ freeze()

bool MQUALIFIER zeus::TXObject::freeze ( )
virtual

§ freezeChildren()

void zeus::TXObject::freezeChildren ( )
protected

freezes all child objects

§ getCastedObject()

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

§ getChild()

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

Implements zeus::IXObject.

Reimplemented in zeus::TXLoaderObject.

§ getChildByName()

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

Implements zeus::IXObject.

Reimplemented in zeus::TXLoaderObject.

§ getChildCount()

Int MQUALIFIER zeus::TXObject::getChildCount ( ) const
inlinevirtual

§ getChildrenByName()

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

§ getClassName()

void MQUALIFIER zeus::TXObject::getClassName ( IString rName) const
virtual

§ getCodeModule()

TString zeus::TXObject::getCodeModule ( ) const
virtual

Returns the codemodule of this object

Returns
name of code module

§ getID()

Uint MQUALIFIER zeus::TXObject::getID ( ) const
virtual
See also
IXObject::getID

Implements zeus::IXObject.

§ getMemberCount()

Int MQUALIFIER zeus::TXObject::getMemberCount ( ) const
virtual

§ getMemberObjectReference()

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

§ getMemberVariable()

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

§ getMemberVariableByName()

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

§ getMemberXMLNode()

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

§ getName()

void MQUALIFIER zeus::TXObject::getName ( IString rName) const
inlinevirtual
See also
IXObject::getName

Implements zeus::IXObject.

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

§ getObject()

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

Implements zeus::IXObject.

§ getObjects()

Retval MQUALIFIER zeus::TXObject::getObjects ( const IString path,
IXObjectCollection *&  pObjects 
)
virtual
See also
IXObject::getObjects

Implements zeus::IXObject.

§ getParent()

Retval MQUALIFIER zeus::TXObject::getParent ( IXObject *&  rpParent) const
virtual
See also
IXObject::getParent

Implements zeus::IXObject.

§ getRootObject()

Retval MQUALIFIER zeus::TXObject::getRootObject ( IXObject *&  rpObj)
virtual

§ getXMLNode()

Retval MQUALIFIER zeus::TXObject::getXMLNode ( IXMLNode *&  rpNode) const
virtual
See also
IXObject::getXMLNode

Implements zeus::IXObject.

§ getXMLStream()

TString zeus::TXObject::getXMLStream ( ) const
virtual

Get infomation abaout the xmlobject

Reimplemented in zeus::TXRootObject.

§ indexOfChild()

Int MQUALIFIER zeus::TXObject::indexOfChild ( IXObject rChild)
inlinevirtual

§ insertChild()

Retval MQUALIFIER zeus::TXObject::insertChild ( Int  iIndex,
IXObject rChild 
)
virtual
See also
IXObject::insertChild

Implements zeus::IXObject.

Reimplemented in zeus::TXLoaderObject.

§ isFrozen()

bool MQUALIFIER zeus::TXObject::isFrozen ( ) const
inlinevirtual
See also
IXObject::isFrozen

Implements zeus::IXObject.

§ lockTree()

void MQUALIFIER zeus::TXObject::lockTree ( )
virtual
See also
IXObject::lockTree

Implements zeus::IXObject.

§ onBroadCast()

void MQUALIFIER zeus::TXObject::onBroadCast ( ISimpleCommand rMessage)
virtual

§ onChildAdded()

virtual void zeus::TXObject::onChildAdded ( IXObject )
inlineprotectedvirtual

Reimplemented in zeus::TXProcProject.

§ onChildDeleted()

virtual void zeus::TXObject::onChildDeleted ( IXObject )
inlineprotectedvirtual

Reimplemented in zeus::TXProcProject.

§ onExecute()

Retval MQUALIFIER zeus::TXObject::onExecute ( ISimpleCommand rCommand,
Uint  uiMode 
)
inlinevirtual
See also
IXObject::onExecute

Implements zeus::IXObject.

§ readAttribute() [1/4]

Retval zeus::TXObject::readAttribute ( TString  strName,
TString rValue 
) const
inlineprotected

§ readAttribute() [2/4]

Retval zeus::TXObject::readAttribute ( TString  strName,
Int &  rValue 
) const
inlineprotected

§ readAttribute() [3/4]

Retval zeus::TXObject::readAttribute ( TString  strName,
Uint &  rValue 
) const
inlineprotected

§ readAttribute() [4/4]

Retval zeus::TXObject::readAttribute ( TString  strName,
Float &  rValue 
) const
inlineprotected

§ readBoolAttribute()

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

§ readFloatAttribute()

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

§ readIntAttribute()

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

§ readMemberVariable()

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

§ readStringAttribute()

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

§ readTimevalAttribute()

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

§ readUintAttribute()

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

§ release()

§ removeChild()

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

§ removeMemberVariable()

Retval MQUALIFIER zeus::TXObject::removeMemberVariable ( const IString rName)
virtual

§ resetMemberVariables()

void MQUALIFIER zeus::TXObject::resetMemberVariables ( )
virtual

§ setChild()

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.

§ setObjName()

void zeus::TXObject::setObjName ( const TString rName)
inlinevirtual
See also
TZObject::setObjName

Reimplemented from zeus::TZObject.

§ setParent()

Retval MQUALIFIER zeus::TXObject::setParent ( IXObject parent)
inlinevirtual
See also
IXObject::setParent

Implements zeus::IXObject.

§ setTreeLock()

void MQUALIFIER zeus::TXObject::setTreeLock ( ICriticalSection section)
virtual

§ storeAttribute() [1/4]

Retval zeus::TXObject::storeAttribute ( TString  strName,
TString  strValue 
)
inlineprotected

§ storeAttribute() [2/4]

Retval zeus::TXObject::storeAttribute ( TString  strName,
Int  iValue 
)
inlineprotected

§ storeAttribute() [3/4]

Retval zeus::TXObject::storeAttribute ( TString  strName,
Uint  uiValue 
)
inlineprotected

§ storeAttribute() [4/4]

Retval zeus::TXObject::storeAttribute ( TString  strName,
Float  fValue 
)
inlineprotected

§ storeBoolAttribute()

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

§ storeFloatAttribute()

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

§ storeIntAttribute()

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

§ storeMemberVariable()

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

§ storeStringAttribute()

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

§ storeTimevalAttribute()

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

§ storeUintAttribute()

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

§ unfreeze()

bool MQUALIFIER zeus::TXObject::unfreeze ( )
virtual

§ unfreezeChildren()

void zeus::TXObject::unfreezeChildren ( )
protected

Unfreezes all child objects

§ unlockTree()

void MQUALIFIER zeus::TXObject::unlockTree ( )
virtual
See also
IXObject::unlockTree

Implements zeus::IXObject.

Member Data Documentation

§ m_pMemberVariables

TXMemberCollection* zeus::TXObject::m_pMemberVariables
mutableprotected

X-Object member variables.

§ m_pNode

IXMLNode* zeus::TXObject::m_pNode
protected

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

§ m_pTreeLock

ICriticalSection* zeus::TXObject::m_pTreeLock
protected

Lock of the data and object tree.


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


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Tue Sep 13 2016 22:32:17