rwsf::CallInfo::ParameterObject Class Reference

Represents operation parameters. Generally not for direct use. More...

#include <rwsf/webservice/CallInfo.h>

Public Member Functions
	ParameterObject ()
	ParameterObject (const rwsf::XmlName &name)
	~ParameterObject ()
void	appendValue (const std::string &value)
std::string	getValue ()
std::list< std::string >::iterator	getValuesBegin ()
std::list< std::string >::iterator	getValuesEnd ()
bool	operator== (const ParameterObject &obj) const
void	setValue (const std::string &value)
std::string &	valueAt (size_t idx)
size_t	valueEntries ()

Public Attributes
bool	isAttachment_
bool	isParameter_
bool	isSimple_
rwsf::XmlName	name_
rwsf::XmlReader	rdr_
std::string	type_

Detailed Description

This class specifies the parameter names that request-response or solicit-response operations may require to capture the function signature. Generally, applications do not need to use this class directly.

Constructor & Destructor Documentation

ParameterObject() [1/2]

rwsf::CallInfo::ParameterObject::ParameterObject

(

)

Default constructor.

~ParameterObject()

rwsf::CallInfo::ParameterObject::~ParameterObject

(

)

Default destructor.

ParameterObject() [2/2]

rwsf::CallInfo::ParameterObject::ParameterObject

(

const rwsf::XmlName &

name

)

Constructs a parameter object with the value of name.

Member Function Documentation

appendValue()

void rwsf::CallInfo::ParameterObject::appendValue ( const std::string & value )

inline

Appends value to the existing value(s) in this parameter object.

Note

This member function is relevant only when using wrapped style with a parameter that is a list of values; in all other cases, the first value only is used.

getValue()

std::string rwsf::CallInfo::ParameterObject::getValue ( )

inline

Returns the parameter object's value. With wrapped style, a vector of values is possible. In this case, the first value in the list is returned.

getValuesBegin()

std::list< std::string >::iterator rwsf::CallInfo::ParameterObject::getValuesBegin ( )

inline

Returns an iterator to the beginning of the value list for this paramter object. Note that the existence of more than one value is possible only with the use of wrapped style in which the parameter is a vector of values.

getValuesEnd()

std::list< std::string >::iterator rwsf::CallInfo::ParameterObject::getValuesEnd ( )

inline

Returns an iterator to one past the end of the value list for this paramter object.

Note

The existence of more than one value is possible only with the use of wrapped style in which the parameter is a vector of values.

operator==()

bool rwsf::CallInfo::ParameterObject::operator==

(

const ParameterObject &

obj

)

const

Returns true if self compares equal to obj, otherwise false.

setValue()

void rwsf::CallInfo::ParameterObject::setValue ( const std::string & value )

inline

Sets the value of this parameter object. With wrapped style, a vector of values is possible. In this case, sets the first value in the list.

valueAt()

std::string & rwsf::CallInfo::ParameterObject::valueAt ( size_t idx )

inline

Returns a value at position idx in the vector. If idx is greater than the vector size, an rwsf::OutOfBoundException is thrown.

valueEntries()

size_t rwsf::CallInfo::ParameterObject::valueEntries ( )

inline

Returns the number of values in the parameter object.

Note

The only time there may be more than one value is with wrapped style in which the parameter is a vector of values.

Member Data Documentation

isAttachment_

bool rwsf::CallInfo::ParameterObject::isAttachment_

Returns true if attachment.

isParameter_

bool rwsf::CallInfo::ParameterObject::isParameter_

Returns true if an actual parameter (not just a reference, for instance, in an array)

isSimple_

bool rwsf::CallInfo::ParameterObject::isSimple_

Returns true if simple type.

name_

rwsf::XmlName rwsf::CallInfo::ParameterObject::name_

Name of the parameter

rdr_

rwsf::XmlReader rwsf::CallInfo::ParameterObject::rdr_

XmlReader instance for this parameter ready to read the element.

type_

std::string rwsf::CallInfo::ParameterObject::type_

Type of parameter.