ulxr::Signature Class Reference
[XML-RPC handling]

Convenience class to generate larger signature strings for RPC methods: Usage examples:. More...

#include <ulxr_signature.h>

List of all members.

Public Member Functions
	Signature ()
	Constructs an empty signature.
	Signature (const CppString &s)
	Constructs a signature from a single parameter.
	Signature (const ValueBase &v)
	Constructs a signature from a single parameter.
	Signature (const Void &v)
	Constructs a signature from a void type.
Signature &	addParam (const CppString &s)
	Adds another parameter to the signature.
Signature &	addParam (const Value &v)
	Adds another parameter to the signature.
Signature &	operator<< (const CppString &s)
	Adds another parameter to the signature.
Signature &	operator<< (const Value &v)
	Adds another parameter to the signature.
CppString	getString () const
	Return the complete signature string.
Private Attributes
CppString	sig

---

Detailed Description

Convenience class to generate larger signature strings for RPC methods: Usage examples:.

    Signature()
         .addParam(Integer())
         .addParam(String())
         .....

    Signature(Integer()).addParam(String())
         .....
    Signature() << RpcString() << Integer();
 

Definition at line 58 of file ulxr_signature.h.

---

Constructor & Destructor Documentation

ulxr::Signature::Signature

(

)

Constructs an empty signature.

Definition at line 40 of file ulxr_signature.cpp.

ulxr::Signature::Signature

(

const CppString &

s

)

Constructs a signature from a single parameter.

Parameters:

s

rpc name of the parameter (int, string, ...)

Definition at line 50 of file ulxr_signature.cpp.

References sig.

ulxr::Signature::Signature

(

const ValueBase &

v

)

Constructs a signature from a single parameter.

Parameters:

v

rpc value

Definition at line 56 of file ulxr_signature.cpp.

References ulxr::ValueBase::getSignature(), and sig.

ulxr::Signature::Signature

(

const Void &

v

)

Constructs a signature from a void type.

Only exists for completeness and yields the same as the default constructor.

Parameters:

v

void value

Definition at line 45 of file ulxr_signature.cpp.

---

Member Function Documentation

Signature & ulxr::Signature::addParam

(

const CppString &

s

)

Adds another parameter to the signature.

Parameters:

s

rpc name of the parameter

Definition at line 71 of file ulxr_signature.cpp.

References sig, and ULXR_PCHAR.

Referenced by operator<<().

Signature & ulxr::Signature::addParam

(

const Value &

v

)

Adds another parameter to the signature.

Parameters:

v

rpc value

Definition at line 62 of file ulxr_signature.cpp.

References ulxr::Value::getSignature(), sig, and ULXR_PCHAR.

Signature & ulxr::Signature::operator<<

(

const CppString &

s

)

Adds another parameter to the signature.

Parameters:

s

rpc name of the parameter

Definition at line 93 of file ulxr_signature.cpp.

References addParam().

Signature & ulxr::Signature::operator<<

(

const Value &

v

)

Adds another parameter to the signature.

Parameters:

v

rpc value

Definition at line 86 of file ulxr_signature.cpp.

References addParam().

CppString ulxr::Signature::getString

(

)

const

Return the complete signature string.

Returns:

signature

Definition at line 80 of file ulxr_signature.cpp.

---

Member Data Documentation

CppString ulxr::Signature::sig [private]

Definition at line 109 of file ulxr_signature.h.

Referenced by addParam(), and Signature().

---

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

• ulxr_signature.h
• ulxr_signature.cpp

---