zeus::IXMemberVariable Class Reference

#include <IXMemberVariable.hpp>

Inheritance diagram for zeus::IXMemberVariable:

List of all members.

Public Types
enum	EVariableType {   etXMLNode = 0, etInt = 1, etUint = 2, etFloat = 3,   etBoolean = 4, etString = 5, etObjectRef = 6, etList = 7 }
Public Member Functions
virtual EVariableType MQUALIFIER	getMemberType () const =0
virtual void MQUALIFIER	getName (IString &rstrName) const =0
virtual Retval MQUALIFIER	getString (IString &rstrValue) const =0
virtual Retval MQUALIFIER	getValue (IZVariant &rValue) const =0
virtual Retval MQUALIFIER	getXMLNode (IXMLNode *&rpValue) const =0
virtual Retval MQUALIFIER	setString (const IString &rstrValue)=0
virtual Retval MQUALIFIER	setValue (const IZVariant &rValue)=0
virtual Retval MQUALIFIER	getListItems (IXPathResults *&rpList) const =0
virtual Retval MQUALIFIER	getListItem (Int iIndex, IXMLNode *&rpItem) const =0
virtual Retval MQUALIFIER	addListItem (IXMLNode *&rpItem)=0
virtual Retval MQUALIFIER	insertListItem (Int iIndex, IXMLNode *&rpItem)=0
virtual Retval MQUALIFIER	deleteListItem (Int iIndex)=0

---

Detailed Description

This interface defines a X-Object member

---

Member Enumeration Documentation

enum zeus::IXMemberVariable::EVariableType

Available member types

Enumerator:

etXMLNode	Member is an XML node
etInt	Member is an integer
etUint	Member is an unsigned integer
etFloat	Member is a float value
etBoolean	Member is a boolean value
etString	Member is a string value
etObjectRef	Member is an object reference
etList	Member is a list of values

---

Member Function Documentation

virtual Retval MQUALIFIER zeus::IXMemberVariable::addListItem

(

IXMLNode *&

rpItem )

[pure virtual]

Adds an item to the list

Parameters:

rpItem,:

return parameter of the added item

Return values:

RET_NOERROR,:	Item added
RET_REQUEST_FAILED,:	Wasn't able to add a new item
RET_INVALID_TYPE,:	Invalid variable type

Implemented in zeus::TXMemberVariable.

virtual Retval MQUALIFIER zeus::IXMemberVariable::deleteListItem

(

Int

iIndex )

[pure virtual]

Removes an element out of the list

Parameters:

iIndex,:

Index of the element to remove

Return values:

RET_NOERROR,:	Element removed
RET_INVALID_TYPE,:	Invalid variable type

Implemented in zeus::TXMemberVariable.

virtual Retval MQUALIFIER zeus::IXMemberVariable::getListItem	(	Int	iIndex,
		IXMLNode *&	rpItem
	)		const [pure virtual]

Returns the indexed item at position iIndex of list type

Parameters:

iIndex,:	Index of requested item
rpItem,:	Item at [iIndex]

Return values:

RET_NOERROR,:	Item returned
RET_REQUEST_FAILED,:	Invalid item index
RET_INVALID_TYPE,:	Invalid variable type

Implemented in zeus::TXMemberVariable.

virtual Retval MQUALIFIER zeus::IXMemberVariable::getListItems

(

IXPathResults *&

rpList )

const [pure virtual]

Returns the items of list type as a IXPathResult

Parameters:

rpList,:

return variable of the item list

Return values:

RET_NOERROR,:	List returned
RET_INVALID_TYPE,:	Invalid variable type

Implemented in zeus::TXMemberVariable.

virtual EVariableType MQUALIFIER zeus::IXMemberVariable::getMemberType

(

)

const [pure virtual]

Returns the member type

Implemented in zeus::TXMemberVariable.

virtual void MQUALIFIER zeus::IXMemberVariable::getName

(

IString &

rstrName )

const [pure virtual]

Returns the name of the variable

Parameters:

rstrName,:

return parameter

Implemented in zeus::TXMemberVariable.

virtual Retval MQUALIFIER zeus::IXMemberVariable::getString

(

IString &

rstrValue )

const [pure virtual]

returns the string value

Parameters:

rstrValue,:

return parameter

Return values:

RET_NOERROR,:	Value returned
RET_INVALID_TYPE,:	invalid variable type

Implemented in zeus::TXMemberVariable.

virtual Retval MQUALIFIER zeus::IXMemberVariable::getValue

(

IZVariant &

rValue )

const [pure virtual]

returns the member value

Parameters:

rValue,:

variant value to return

Return values:

RET_NOERROR,:	Value returned
RET_INVALID_TYPE,:	invalid variable type

Implemented in zeus::TXMemberVariable.

virtual Retval MQUALIFIER zeus::IXMemberVariable::getXMLNode

(

IXMLNode *&

rpValue )

const [pure virtual]

returns the XML node

Parameters:

rpValue,:

return parameter

Return values:

RET_NOERROR,:	XML node returned
RET_REQUEST_FAILED,:	not a XML value type

Implemented in zeus::TXMemberVariable.

virtual Retval MQUALIFIER zeus::IXMemberVariable::insertListItem	(	Int	iIndex,
		IXMLNode *&	rpItem
	)		[pure virtual]

Inserts an item into the list at position iIndex of list type. If iIndex = 0, then the rItem is placed in the front (prepend); if the iIndex >= count or iIndex < 0, the item is placed at the end (append); else the rItem is placed at position iIndex

Parameters:

iIndex,:	Insert position
rpItem,:	return parameter of the inserted item

Return values:

RET_NOERROR,:	Item inserted
RET_REQUEST_FAILED,:	Wasn't able to insert a new item
RET_INVALID_TYPE,:	Invalid variable type

Implemented in zeus::TXMemberVariable.

virtual Retval MQUALIFIER zeus::IXMemberVariable::setString

(

const IString &

rstrValue )

[pure virtual]

returns the string value

Parameters:

rstrValue,:

value to set

Return values:

RET_NOERROR,:	Value set
RET_INVALID_TYPE,:	Invalid variable type

Implemented in zeus::TXMemberVariable.

virtual Retval MQUALIFIER zeus::IXMemberVariable::setValue

(

const IZVariant &

rValue )

[pure virtual]

sets the member value

Parameters:

rValue,:

variant value to set

Return values:

RET_NOERROR,:	Value set
RET_INVALID_TYPE,:	invalid variable type

Implemented in zeus::TXMemberVariable.

---

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

• IXMemberVariable.hpp