Public Types | Public Member Functions

zeus::IXObject Class Reference

#include <IXObject.hpp>

Inheritance diagram for zeus::IXObject:
zeus::IZUnknown zeus::TXObject 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

List of all members.

Public Types

typedef Retval MQUALIFIER(* DltCreateXObject )(IXMLNode *pMainNode, IXMLDocument *pDocu, IXObject *&rpObj)

Public Member Functions

virtual void MQUALIFIER getName (IString &rstrName) const =0
virtual void MQUALIFIER getClassName (IString &rstrName) const =0
virtual Uint MQUALIFIER getID () const =0
virtual Retval MQUALIFIER addChild (IXObject &rChild)=0
virtual Retval MQUALIFIER deleteChild (Int iIndex, bool bDoFreeze=false)=0
virtual Retval MQUALIFIER removeChild (IXObject &rChild, bool bDoFreeze=false)=0
virtual Int MQUALIFIER getChildCount () const =0
virtual Retval MQUALIFIER getChild (Int iIndex, IXObject *&rpChild)=0
virtual Retval MQUALIFIER getChildByName (const IString &rstrName, IXObject *&rpChild)=0
virtual Retval MQUALIFIER getChildrenByName (const IString &rstrName, IXObjectCollection *&rpObjects)=0
virtual Retval MQUALIFIER getParent (IXObject *&rpParent) const =0
virtual Retval MQUALIFIER getXMLNode (IXMLNode *&rpParent) const =0
virtual Retval MQUALIFIER setParent (IXObject *pParent)=0
virtual Retval MQUALIFIER setChild (IXObject &rChild)=0
virtual Retval MQUALIFIER getRootObject (IXObject *&rpObj)=0
virtual Retval MQUALIFIER getObject (const IString &rstrPath, IXObject *&rpObj)=0
virtual Retval MQUALIFIER getObjects (const IString &rstrPath, IXObjectCollection *&rpObjects)=0
virtual bool MQUALIFIER canCreateChildren () const =0
virtual bool MQUALIFIER freeze ()=0
virtual bool MQUALIFIER unfreeze ()=0
virtual bool MQUALIFIER isFrozen () const =0
virtual void MQUALIFIER setTreeLock (ICriticalSection *pSection)=0
virtual void MQUALIFIER lockTree ()=0
virtual void MQUALIFIER unlockTree ()=0
virtual Retval MQUALIFIER onExecute (ISimpleCommand &rCommand, Uint uiMode)=0
virtual void MQUALIFIER onBroadCast (ISimpleCommand &rMessage)=0
virtual Retval MQUALIFIER insertChild (Int iIndex, IXObject &rChild)=0
virtual Int MQUALIFIER indexOfChild (IXObject &rChild)=0
virtual Retval MQUALIFIER createChildObject (const IString &rstrName, const IString &rstrClassName, const IString &rstrCodeModule, IXObject *&rpChild)=0
virtual Retval MQUALIFIER createChildObjectCustom (const IString &rstrName, const IString &rstrClassName, const IString &rstrCodeModule, const IStringList &rList, IXObject *&rpChild)=0
virtual Retval MQUALIFIER getCastedObject (const IString &rstrPath, const InterfaceID &rInterfaceID, IZUnknown *&rpObj)=0
virtual Retval MQUALIFIER readIntAttribute (const IString &rstrName, Int &riValue, Int iDefault=0) const =0
virtual Retval MQUALIFIER readUintAttribute (const IString &rstrName, Uint &ruiValue, Uint uiDefault=0) const =0
virtual Retval MQUALIFIER readFloatAttribute (const IString &rstrName, Float &rfValue, Float fDefault=0) const =0
virtual Retval MQUALIFIER readStringAttribute (const IString &rstrName, IString &rstrValue) const =0
virtual Retval MQUALIFIER readTimevalAttribute (const IString &rstrName, Timeval &rtmValue, Timeval tmDefault=0) const =0
virtual Retval MQUALIFIER readBoolAttribute (const IString &rstrName, bool &rbValue, bool bDefault=false) const =0
virtual Retval MQUALIFIER storeIntAttribute (const IString &rstrName, const Int &riValue)=0
virtual Retval MQUALIFIER storeUintAttribute (const IString &rstrName, const Uint &ruiValue)=0
virtual Retval MQUALIFIER storeFloatAttribute (const IString &rstrName, const Float &rfValue)=0
virtual Retval MQUALIFIER storeStringAttribute (const IString &rstrName, const IString &rstrValue)=0
virtual Retval MQUALIFIER storeTimevalAttribute (const IString &rstrName, const Timeval &rtmValue)=0
virtual Retval MQUALIFIER storeBoolAttribute (const IString &rstrName, const bool &rbValue)=0
virtual Int MQUALIFIER getMemberCount () const =0
virtual Retval MQUALIFIER getMemberVariable (Int iIndex, IXMemberVariable *&rpMember) const =0
virtual Retval MQUALIFIER getMemberVariableByName (const IString &rstrName, IXMemberVariable *&rpMember) const =0
virtual Retval MQUALIFIER addNewMemberVariable (const IString &rstrName, IXMemberVariable::EVariableType eType)=0
virtual Retval MQUALIFIER removeMemberVariable (const IString &rstrName)=0
virtual Retval MQUALIFIER getMemberObjectReference (const IString &rstrName, IXObject *&rpRef)=0
virtual Retval MQUALIFIER getMemberXMLNode (const IString &rstrName, IXMLNode *&rpNode) const =0
virtual Retval MQUALIFIER readMemberVariable (const IString &rstrName, IZVariant &rValue) const =0
virtual Retval MQUALIFIER storeMemberVariable (const IString &rstrName, const IZVariant &rValue)=0
virtual void MQUALIFIER resetMemberVariables ()=0

Detailed Description

This interface defines a X-Object interface. An X-Object wrapps a XML node and can be created using automated factories. X-Objects are used to created object trees and for persistent object layers using xml.

Member Typedef Documentation

typedef Retval MQUALIFIER(* zeus::IXObject::DltCreateXObject)(IXMLNode *pMainNode, IXMLDocument *pDocu, IXObject *&rpObj)

Callback function definition for creation of an XObject

Parameters:
pMainNode,:Xml node repersenting the object
pDocu,:Xml document containing node definition
rpObj,:Created object

Member Function Documentation

virtual Retval MQUALIFIER zeus::IXObject::addChild ( IXObject &  rChild ) [pure virtual]

This methods adds an XObject as a child to this object

Parameters:
rChild,:child object to add
Return values:
RET_NOERROR,:Child object added
RET_REQUEST_FAILED,:Could not add object

Implemented in zeus::TXLoaderObject, and zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::addNewMemberVariable ( const IString &  rstrName,
IXMemberVariable::EVariableType  eType 
) [pure virtual]

Adds a new member variable to the x-object class. This method is used to design a X-Object.

Parameters:
rstrName,:Name of the member variable
eType,:Type of the member variable
Return values:
RET_NOERROR,:Member created and added
RET_REQUEST_FAILED,:Invalid name

Implemented in zeus::TXObject.

virtual bool MQUALIFIER zeus::IXObject::canCreateChildren (  ) const [pure virtual]

This methods checks if the children components can be created

Return values:
true,:Able to create children
false,:Do not create children

Implemented in zeus::TXLoaderObject, and zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::createChildObject ( const IString &  rstrName,
const IString &  rstrClassName,
const IString &  rstrCodeModule,
IXObject *&  rpChild 
) [pure virtual]

creates a new child object

Parameters:
rstrName,:Object name
rstrClassName,:Name of the class
rstrCodeModule,:Codemodule
rpChild,:Return parameter of the child object
Return values:
RET_NOERROR,:Child created
RET_INVALID_DATA,:Could not generate XML data
RET_REQUEST_FAILED,:Could not create child

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::createChildObjectCustom ( const IString &  rstrName,
const IString &  rstrClassName,
const IString &  rstrCodeModule,
const IStringList &  rList,
IXObject *&  rpChild 
) [pure virtual]

creates a new child object

Parameters:
rstrName,:Object name
rstrClassName,:Name of the class
rstrCodeModule,:Codemodule
rList,:List of attribute - value pairs
rpChild,:Return parameter of the child object
Return values:
RET_NOERROR,:Child created
RET_INVALID_DATA,:Could not generate XML data
RET_REQUEST_FAILED,:Could not create child

Implemented in zeus::TXObject.

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

Deletes a child out of the list.

Parameters:
iIndex,:Index of child to Remove
bDoFreeze,:Flag to freeze the removed child. Default is false
Return values:
RET_NOERROR,:Child deleted
RET_REQUEST_FAILED,:Could not delete child.

Implemented in zeus::TXObject.

virtual bool MQUALIFIER zeus::IXObject::freeze (  ) [pure virtual]

This method freezes a xobject. All external references has to be released at that point.

Return values:
true,:Freezing has been performed
false,:Already frozen

Implemented in zeus::TModule, zeus::TSimpleCommand, zeus::TSystemManager, zeus::TXLoaderObject, and zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::getCastedObject ( const IString &  rstrPath,
const InterfaceID &  rInterfaceID,
IZUnknown *&  rpObj 
) [pure virtual]

This method is used to get an object from the tree. Therefor a special Syntax is used. The object will be casted to the required type. If the cast fails, this method will return the next object with the corresponding name and interface id.

Parameters:
rstrPath,:Objectpath
rInterfaceID,:ID of the interface
rpObj,:Return parameter of the object
Return values:
RET_NOERROR,:object found and returned
RET_REQUEST_FAILED,:Could not find object
RET_INVALID_DATA,:Invalid path

Implemented in zeus::TXObject.

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

Get a child object by index

Parameters:
iIndex,:Index of the object
rpChild,:Return parameter of the found object
Return values:
RET_NOERROR,:Child object found
RET_INVALID_PARAMETER,:Invalid parameter received

Implemented in zeus::TXLoaderObject, and zeus::TXObject.

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

Get a child object by name

Parameters:
rstrName,:Name of the object
rpChild,:Return parameter of the found object
Return values:
RET_NOERROR,:Child object found
RET_INVALID_PARAMETER,:Invalid parameter received
RET_REQUEST_FAILED,:No child found

Implemented in zeus::TXLoaderObject, and zeus::TXObject.

virtual Int MQUALIFIER zeus::IXObject::getChildCount (  ) const [pure virtual]

Get count of the children

Returns:
number of children

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::getChildrenByName ( const IString &  rstrName,
IXObjectCollection *&  rpObjects 
) [pure virtual]

Get children objects by name. If the name is empty, all children of this object are returned.

Parameters:
rstrName,:Name of the objects
rpObjects,:Return parameter of the found objects
Return values:
RET_NOERROR,:Child objects found
RET_INVALID_PARAMETER,:Invalid parameter received
RET_REQUEST_FAILED,:No child found

Implemented in zeus::TXObject.

virtual void MQUALIFIER zeus::IXObject::getClassName ( IString &  rstrName ) const [pure virtual]

This methods returns the classname of the object

Parameters:
rstrName,:return parameter

Implemented in zeus::TXObject.

virtual Uint MQUALIFIER zeus::IXObject::getID (  ) const [pure virtual]

This methods returns the id of an object

Returns:
id of object

Implemented in zeus::TXObject.

virtual Int MQUALIFIER zeus::IXObject::getMemberCount (  ) const [pure virtual]

Gets the number of member variables

Returns:
Number of members

Implemented in zeus::TXObject.

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

Returns the object reference if the member value is of type 'ref'. The Reference attribute of the member node contains the X-Object path of the requested object. This method is not const since reading a X-Object can change the X-Object tree (see XLoaderObject).

Parameters:
rstrName,:Name of the member variable
rpRef,:Return value
Return values:
RET_NOERROR,:object found and returned
RET_INVALID_PARAMETER,:no such member found. Name is invalid.
RET_INVALID_TYPE,:Invalid type. Must be 'ref'.
RET_REQUEST_FAILED,:No such object found.

Implemented in zeus::TXObject.

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

Returns the indexed member variable

Parameters:
iIndex,:Index of the member
rpMember,:Member description object
Return values:
RET_NOERROR,:Member returned
RET_REQUEST_FAILED,:Could not find such a member

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::getMemberVariableByName ( const IString &  rstrName,
IXMemberVariable *&  rpMember 
) const [pure virtual]

Returns the a member variable by name

Parameters:
rstrName,:Name of the member
rpMember,:Member description object
Return values:
RET_NOERROR,:Member returned
RET_REQUEST_FAILED,:Could not find such a member

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::getMemberXMLNode ( const IString &  rstrName,
IXMLNode *&  rpNode 
) const [pure virtual]

This returns the XML node of a requested member variable. The type of the variable must be 'xml'.

Parameters:
rstrName,:Name of the member variable
rpNode,:Return value
Return values:
RET_NOERROR,:XML Node returned
RET_INVALID_PARAMETER,:no such member found. Name is invalid
RET_INVALID_TYPE,:Type is not 'xml'

Implemented in zeus::TXObject.

virtual void MQUALIFIER zeus::IXObject::getName ( IString &  rstrName ) const [pure virtual]

This methods returns the name of the object

Parameters:
rstrName,:return parameter

Implemented in zeus::TModule, zeus::TSystemManager, and zeus::TXObject.

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

This method is used to get an object from the tree. Therefor a special Syntax is used.

Parameters:
rstrPath,:Path of the object inside the xobject tree
rpObj,:Return parameter of the object
Return values:
RET_NOERROR,:object found and returned
RET_REQUEST_FAILED,:Could not find object
RET_INVALID_DATA,:Invalid path

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::getObjects ( const IString &  rstrPath,
IXObjectCollection *&  rpObjects 
) [pure virtual]

This method is used to get an object list from the tree. Therefor a special Syntax is used.

Parameters:
rstrPath,:Path of the object inside the xobject tree
rpObjects,:Return parameter of the objects
Return values:
RET_NOERROR,:objects found and returned
RET_REQUEST_FAILED,:Could not find any object
RET_INVALID_DATA,:Invalid path

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::getParent ( IXObject *&  rpParent ) const [pure virtual]

Get the parent object

Parameters:
rpParent,:Return parameter of the found object
Return values:
RET_NOERROR,:parent found
RET_REQUEST_FAILED,:No parent found -> this is the root object

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::getRootObject ( IXObject *&  rpObj ) [pure virtual]

Returns the root object of the object tree.

Parameters:
rpObj,:Return parameter of the root object
Return values:
RET_NOERROR,:Root object returned
RET_INVALID_PARAMETER,:Invalid parameter received;

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::getXMLNode ( IXMLNode *&  rpParent ) const [pure virtual]

Get the xml node of the xobject

Parameters:
rpParent,:return parameter of the xml node
Return values:
RET_NOERROR,:node returned
RET_REQUEST_FAILED,:Could not get the xml node

Implemented in zeus::TXObject.

virtual Int MQUALIFIER zeus::IXObject::indexOfChild ( IXObject &  rChild ) [pure virtual]

This method returns the index of a child object

Parameters:
rChild,:Child reference
Return values:
>=0,:index of child in the list
-1,:the child does not exists inside the list.

Implemented in zeus::TXObject.

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

This method inserts a child to the parent object. The child will be added at the insert position. If the insert position is bigger than the child list, it will add the child at the end of the list.

Parameters:
iIndex,:Insert position of the child
rChild,:Child reference
Return values:
RET_NOERROR,:Child inserted
RET_REQUEST_FAILED,:Could not inset the child object

Implemented in zeus::TXLoaderObject, and zeus::TXObject.

virtual bool MQUALIFIER zeus::IXObject::isFrozen (  ) const [pure virtual]

Checks if a xobject is frozen.

Return values:
true,:xobject is frozen
false,:xobject is alive

Implemented in zeus::TXObject.

virtual void MQUALIFIER zeus::IXObject::lockTree (  ) [pure virtual]

This locks the xobject tree. Before using this method, set a lock object using setTreeLock()

Implemented in zeus::TXObject.

virtual void MQUALIFIER zeus::IXObject::onBroadCast ( ISimpleCommand &  rMessage ) [pure virtual]

Handles and sents a broad cast message to all its children.

Parameters:
rMessage,:Message to perform

Implemented in zeus::TXObject.

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

Executes a simple command. This can be used as a action method

Parameters:
rCommand,:Command to execute
uiMode,:Mode of execution
Return values:
RET_NOERROR,:Command executed
RET_REQUEST_FAILED,:Command has not been understand

Implemented in zeus::TXObject.

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

Returns a bool attribute of the object.

Parameters:
rstrName,:Name of the attribute
rbValue,:Return value
bDefault,:Default value if the attribute can not be converted
Return values:
RET_NOERROR,:Attribute returned
RET_REQUEST_FAILED,:No such attribute found

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::readFloatAttribute ( const IString &  rstrName,
Float &  rfValue,
Float  fDefault = 0 
) const [pure virtual]

Returns a float attribute of the object.

Parameters:
rstrName,:Name of the attribute
rfValue,:Return value
fDefault,:Default value if the attribute can not be converted
Return values:
RET_NOERROR,:Attribute returned
RET_REQUEST_FAILED,:No such attribute found

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::readIntAttribute ( const IString &  rstrName,
Int &  riValue,
Int  iDefault = 0 
) const [pure virtual]

Returns an integer attribute of the object.

Parameters:
rstrName,:Name of the attribute
riValue,:Return value
iDefault,:Default value if the attribute can not be converted
Return values:
RET_NOERROR,:Attribute returned
RET_REQUEST_FAILED,:No such attribute found

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::readMemberVariable ( const IString &  rstrName,
IZVariant &  rValue 
) const [pure virtual]

Returns an member variable of the object.

Parameters:
rstrName,:Name of the member variable
rValue,:Return value
Return values:
RET_NOERROR,:member returned
RET_INVALID_PARAMETER,:no such member found. Name is invalid
RET_INVALID_TYPE,:Invalid member type. Could not get value.

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::readStringAttribute ( const IString &  rstrName,
IString &  rstrValue 
) const [pure virtual]

Returns a string attribute of the object.

Parameters:
rstrName,:Name of the attribute
rstrValue,:Return value
Return values:
RET_NOERROR,:Attribute returned
RET_REQUEST_FAILED,:No such attribute found

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::readTimevalAttribute ( const IString &  rstrName,
Timeval &  rtmValue,
Timeval  tmDefault = 0 
) const [pure virtual]

Returns a timeval attribute of the object.

Parameters:
rstrName,:Name of the attribute
rtmValue,:Return value
tmDefault,:Default value if the attribute can not be converted
Return values:
RET_NOERROR,:Attribute returned
RET_REQUEST_FAILED,:No such attribute found

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::readUintAttribute ( const IString &  rstrName,
Uint &  ruiValue,
Uint  uiDefault = 0 
) const [pure virtual]

Returns an unsigned integer attribute of the object.

Parameters:
rstrName,:Name of the attribute
ruiValue,:Return value
uiDefault,:Default value if the attribute can not be converted
Return values:
RET_NOERROR,:Attribute returned
RET_REQUEST_FAILED,:No such attribute found

Implemented in zeus::TXObject.

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

This methods removes an XObject

Parameters:
rChild,:child object to remove
bDoFreeze,:Flag to freeze the removed child. Default is false
Return values:
RET_NOERROR,:Child removed
RET_REQUEST_FAILED,:Could not remove child.

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::removeMemberVariable ( const IString &  rstrName ) [pure virtual]

Removes a member variable from this X-Object. This method is used to design a X-Object.

Parameters:
rstrName,:Name of the member variable
Return values:
RET_NOERROR,:Member removed
RET_REQUEST_FAILED,:Member not found

Implemented in zeus::TXObject.

virtual void MQUALIFIER zeus::IXObject::resetMemberVariables (  ) [pure virtual]

Resets the list of member variables. This is nessecary if the XMember structure of the XML changes. This might happen during a synchronizing process of the XObjectTreeSynchronizing.

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::setChild ( IXObject &  rChild ) [pure virtual]

This methods sets an XObject as a child of this object. Do not use this method. Its only used by the factory creating the tree. Therefor the xml structure wont be touched. For adding children, use the method addChild() instead. It will update the xml structure as well.

Parameters:
rChild,:child object to add
Return values:
RET_NOERROR,:Child object added
RET_REQUEST_FAILED,:Could not add child

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::setParent ( IXObject *  pParent ) [pure virtual]

Set the parent object. Only for internal use

Parameters:
pParent,:Parameter to set. If NULL is set, the object resets its parent
Return values:
RET_NOERROR,:parent set
RET_REQUEST_FAILED,:Could not set the parent

Implemented in zeus::TXObject.

virtual void MQUALIFIER zeus::IXObject::setTreeLock ( ICriticalSection *  pSection ) [pure virtual]

This method sets a lock for the whole XObject tree. This enables a secure multithreading access to the xobject tree.

Parameters:
pSection,:Lock object

Implemented in zeus::TXObject.

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

Stores a bool attribute of the object. The value will be stored as 0 for false, or 1 for true.

Parameters:
rstrName,:Name of the attribute
rbValue,:value to store
Return values:
RET_NOERROR,:Attribute stored
RET_REQUEST_FAILED,:Storing attribute failed

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::storeFloatAttribute ( const IString &  rstrName,
const Float &  rfValue 
) [pure virtual]

Stores a float attribute of the object.

Parameters:
rstrName,:Name of the attribute
rfValue,:value to store
Return values:
RET_NOERROR,:Attribute stored
RET_REQUEST_FAILED,:Storing attribute failed

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::storeIntAttribute ( const IString &  rstrName,
const Int &  riValue 
) [pure virtual]

Stores an integer attribute of the object.

Parameters:
rstrName,:Name of the attribute
riValue,:value to store
Return values:
RET_NOERROR,:Attribute stored
RET_REQUEST_FAILED,:Storing attribute failed

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::storeMemberVariable ( const IString &  rstrName,
const IZVariant &  rValue 
) [pure virtual]

Stores an member variable of the object.

Parameters:
rstrName,:Name of the member variable
rValue,:Return value
Return values:
RET_NOERROR,:member stored
RET_INVALID_PARAMETER,:no such member found. Name is invalid
RET_INVALID_TYPE,:Invalid member type. Could not get value.

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::storeStringAttribute ( const IString &  rstrName,
const IString &  rstrValue 
) [pure virtual]

Stores a string attribute of the object.

Parameters:
rstrName,:Name of the attribute
rstrValue,:value to store
Return values:
RET_NOERROR,:Attribute stored
RET_REQUEST_FAILED,:Storing attribute failed

Implemented in zeus::TXObject.

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

Stores a timeval attribute of the object.

Parameters:
rstrName,:Name of the attribute
rtmValue,:value to store
Return values:
RET_NOERROR,:Attribute stored
RET_REQUEST_FAILED,:Storing attribute failed

Implemented in zeus::TXObject.

virtual Retval MQUALIFIER zeus::IXObject::storeUintAttribute ( const IString &  rstrName,
const Uint &  ruiValue 
) [pure virtual]

Stores an unsigned integer attribute of the object.

Parameters:
rstrName,:Name of the attribute
ruiValue,:value to store
Return values:
RET_NOERROR,:Attribute stored
RET_REQUEST_FAILED,:Storing attribute failed

Implemented in zeus::TXObject.

virtual bool MQUALIFIER zeus::IXObject::unfreeze (  ) [pure virtual]

This method unfreezes a xobject. The external References begin to live and are accecible for others.

Return values:
true,:Unfreezing has been performed
false,:Already unfrozen

Implemented in zeus::TModule, zeus::TSystemManager, zeus::TXErrorObject, zeus::TXLoaderObject, and zeus::TXObject.

virtual void MQUALIFIER zeus::IXObject::unlockTree (  ) [pure virtual]

Unlocks the xobject tree

Implemented in zeus::TXObject.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Sun Jan 22 2012 15:28:37