Public Member Functions

zeus::IMapMessage Class Reference

#include <IMapMessage.hpp>

Inheritance diagram for zeus::IMapMessage:
zeus::IMessage zeus::ISerializable zeus::IZUnknown zeus::TMapMessage zeus::TLocalMapMessage

List of all members.

Public Member Functions

virtual Retval MQUALIFIER getString (const IString &rName, IString &rValue) const =0
virtual Retval MQUALIFIER getInt (const IString &rName, Int &rValue, Int iDefaultVal=0) const =0
virtual Retval MQUALIFIER getFloat (const IString &rName, Float &rValue, Float fDefaultVal=0.0) const =0
virtual Retval MQUALIFIER getUint (const IString &rName, Uint &rValue, Uint uiDefaultVal=0) const =0
virtual Retval MQUALIFIER getBool (const IString &rName, bool &rValue, bool bDefaultVal=false) const =0
virtual void MQUALIFIER setString (const IString &rName, const IString &rValue)=0
virtual void MQUALIFIER setInt (const IString &rName, Int iValue)=0
virtual void MQUALIFIER setFloat (const IString &rName, Float fValue)=0
virtual void MQUALIFIER setUint (const IString &rName, Uint uiValue)=0
virtual void MQUALIFIER setBool (const IString &rName, bool bValue)=0

Detailed Description

This message is able to store named int, float and string values.


Member Function Documentation

virtual Retval MQUALIFIER zeus::IMapMessage::getBool ( const IString rName,
bool &  rValue,
bool  bDefaultVal = false 
) const [pure virtual]

Reads a boolean value attribute of the map message

Parameters:
rName: Name of the item
rValue: return value
bDefaultVal: Default value
Return values:
RET_NOERROR: Item found and returned
RET_REQUEST_FAILED,:No such item found

Implemented in zeus::TMapMessage.

virtual Retval MQUALIFIER zeus::IMapMessage::getFloat ( const IString rName,
Float &  rValue,
Float  fDefaultVal = 0.0 
) const [pure virtual]

Reads a float attribute of the map message

Parameters:
rName: Name of the item
rValue: return value
fDefaultVal: Default value
Return values:
RET_NOERROR: Item found and returned
RET_REQUEST_FAILED,:No such item found

Implemented in zeus::TMapMessage.

virtual Retval MQUALIFIER zeus::IMapMessage::getInt ( const IString rName,
Int &  rValue,
Int  iDefaultVal = 0 
) const [pure virtual]

Reads an integer attribute of the map message

Parameters:
rName: Name of the item
rValue: return value
iDefaultVal: Default value
Return values:
RET_NOERROR: Item found and returned
RET_REQUEST_FAILED,:No such item found

Implemented in zeus::TMapMessage.

virtual Retval MQUALIFIER zeus::IMapMessage::getString ( const IString rName,
IString rValue 
) const [pure virtual]

Reads a string attribute of the map message

Parameters:
rName: Name of the item
rValue: return value
Return values:
RET_NOERROR: Item found and returned
RET_REQUEST_FAILED,:No such item found

Implemented in zeus::TMapMessage.

virtual Retval MQUALIFIER zeus::IMapMessage::getUint ( const IString rName,
Uint &  rValue,
Uint  uiDefaultVal = 0 
) const [pure virtual]

Reads an unsigned integer attribute of the map message

Parameters:
rName: Name of the item
rValue: return value
uiDefaultVal: Default value
Return values:
RET_NOERROR: Item found and returned
RET_REQUEST_FAILED,:No such item found

Implemented in zeus::TMapMessage.

virtual void MQUALIFIER zeus::IMapMessage::setBool ( const IString rName,
bool  bValue 
) [pure virtual]

Sets a boolean item

Parameters:
rName: Name of the item
bValue: Value

Implemented in zeus::TMapMessage.

virtual void MQUALIFIER zeus::IMapMessage::setFloat ( const IString rName,
Float  fValue 
) [pure virtual]

Sets a float item

Parameters:
rName: Name of the item
fValue: Value

Implemented in zeus::TMapMessage.

virtual void MQUALIFIER zeus::IMapMessage::setInt ( const IString rName,
Int  iValue 
) [pure virtual]

Sets an integer item

Parameters:
rName: Name of the item
iValue: Value

Implemented in zeus::TMapMessage.

virtual void MQUALIFIER zeus::IMapMessage::setString ( const IString rName,
const IString rValue 
) [pure virtual]

Sets a string item

Parameters:
rName: Name of the item
rValue: Value

Implemented in zeus::TMapMessage.

virtual void MQUALIFIER zeus::IMapMessage::setUint ( const IString rName,
Uint  uiValue 
) [pure virtual]

Sets an unsigned integer item

Parameters:
rName: Name of the item
uiValue: Value

Implemented in zeus::TMapMessage.


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:24