ulxr::Void Class Reference

Implementation of a void value. More...

#include <ulxr_value.h>

Inheritance diagram for ulxr::Void:

Inheritance graph
[legend]
Collaboration diagram for ulxr::Void:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Void ()
 Default constructor for a Void.
virtual ~Void ()
 Destroys the Value.
virtual ValueBasecloneValue () const
 Creates a copy of the actual object.
virtual CppString getSignature (bool deep=false) const
 Returns the signature of value.
virtual std::string getWbXml () const
 Returns the call as binary xml string.
virtual CppString getXml (int indent=0) const
 Returns the value as xml string.

Static Public Member Functions

static CppString getValueName ()
 Returns the xml name of the Value.

Private Attributes

bool val

Detailed Description

Implementation of a void value.

Attention:
The void type is only a helper class and not intended for direct use.

Definition at line 512 of file ulxr_value.h.


Constructor & Destructor Documentation

ulxr::Void::Void (  ) 

Default constructor for a Void.

Definition at line 553 of file ulxr_value.cpp.

ulxr::Void::~Void (  )  [virtual]

Destroys the Value.

Definition at line 559 of file ulxr_value.cpp.


Member Function Documentation

ValueBase * ulxr::Void::cloneValue (  )  const [virtual]

Creates a copy of the actual object.

Returns:
pointer to the copy

Implements ulxr::ValueBase.

Definition at line 564 of file ulxr_value.cpp.

References ulxr::RpcVoid, and ULXR_ASSERT_RPCTYPE.

CppString ulxr::Void::getSignature ( bool  deep = false  )  const [virtual]

Returns the signature of value.

The signature consists of its type name.

Parameters:
deep if nested types exist, include them
Returns:
The signature

Implements ulxr::ValueBase.

Definition at line 571 of file ulxr_value.cpp.

References ulxr::RpcVoid, and ULXR_ASSERT_RPCTYPE.

CppString ulxr::Void::getValueName (  )  [static]

Returns the xml name of the Value.

Returns:
value name

Definition at line 578 of file ulxr_value.cpp.

References ULXR_PCHAR.

std::string ulxr::Void::getWbXml (  )  const [virtual]

Returns the call as binary xml string.

The method call is converted to a wbxml sequence. It is prepended with the necessary xml procession instruction with version and encoding set to UTF-8.

Returns:
The wbxml content

Implements ulxr::ValueBase.

Definition at line 584 of file ulxr_value.cpp.

References ulxr::RpcVoid, and ULXR_ASSERT_RPCTYPE.

CppString ulxr::Void::getXml ( int  indent = 0  )  const [virtual]

Returns the value as xml string.

The content and its type name is converted to an xml text. The structure of the text is indented to facilitate easy reading of larger blocks.

Parameters:
indent current indentation level
Returns:
The xml content

Implements ulxr::ValueBase.

Definition at line 591 of file ulxr_value.cpp.

References ulxr::RpcVoid, ULXR_ASSERT_RPCTYPE, and ULXR_PCHAR.


Member Data Documentation

bool ulxr::Void::val [private]

Definition at line 561 of file ulxr_value.h.


The documentation for this class was generated from the following files:
Generated on Sun Aug 19 20:09:10 2007 for ulxmlrpcpp by  doxygen 1.5.1