Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET Apache Qpid Documentation
Public Types | Public Member Functions | Static Public Member Functions
qpid::types::Variant Class Reference

Represents a value of variable type. More...

#include <qpid/types/Variant.h>

List of all members.

Public Types

typedef std::map< std::string,
Variant
Map
typedef std::list< VariantList

Public Member Functions

QPID_TYPES_EXTERN Variant ()
QPID_TYPES_EXTERN Variant (bool)
QPID_TYPES_EXTERN Variant (uint8_t)
QPID_TYPES_EXTERN Variant (uint16_t)
QPID_TYPES_EXTERN Variant (uint32_t)
QPID_TYPES_EXTERN Variant (uint64_t)
QPID_TYPES_EXTERN Variant (int8_t)
QPID_TYPES_EXTERN Variant (int16_t)
QPID_TYPES_EXTERN Variant (int32_t)
QPID_TYPES_EXTERN Variant (int64_t)
QPID_TYPES_EXTERN Variant (float)
QPID_TYPES_EXTERN Variant (double)
QPID_TYPES_EXTERN Variant (const std::string &)
QPID_TYPES_EXTERN Variant (const std::string &value, const std::string &encoding)
QPID_TYPES_EXTERN Variant (const char *)
QPID_TYPES_EXTERN Variant (const char *value, const char *encoding)
QPID_TYPES_EXTERN Variant (const Map &)
QPID_TYPES_EXTERN Variant (const List &)
QPID_TYPES_EXTERN Variant (const Variant &)
QPID_TYPES_EXTERN Variant (const Uuid &)
QPID_TYPES_EXTERN ~Variant ()
QPID_TYPES_EXTERN VariantType getType () const
QPID_TYPES_EXTERN bool isVoid () const
QPID_TYPES_EXTERN Variantoperator= (bool)
QPID_TYPES_EXTERN Variantoperator= (uint8_t)
QPID_TYPES_EXTERN Variantoperator= (uint16_t)
QPID_TYPES_EXTERN Variantoperator= (uint32_t)
QPID_TYPES_EXTERN Variantoperator= (uint64_t)
QPID_TYPES_EXTERN Variantoperator= (int8_t)
QPID_TYPES_EXTERN Variantoperator= (int16_t)
QPID_TYPES_EXTERN Variantoperator= (int32_t)
QPID_TYPES_EXTERN Variantoperator= (int64_t)
QPID_TYPES_EXTERN Variantoperator= (float)
QPID_TYPES_EXTERN Variantoperator= (double)
QPID_TYPES_EXTERN Variantoperator= (const std::string &)
QPID_TYPES_EXTERN Variantoperator= (const char *)
QPID_TYPES_EXTERN Variantoperator= (const Map &)
QPID_TYPES_EXTERN Variantoperator= (const List &)
QPID_TYPES_EXTERN Variantoperator= (const Variant &)
QPID_TYPES_EXTERN Variantoperator= (const Uuid &)
QPID_TYPES_EXTERN Variantparse (const std::string &)
 Parses the argument and assigns itself the appropriate value.
QPID_TYPES_EXTERN bool asBool () const
QPID_TYPES_EXTERN uint8_t asUint8 () const
QPID_TYPES_EXTERN uint16_t asUint16 () const
QPID_TYPES_EXTERN uint32_t asUint32 () const
QPID_TYPES_EXTERN uint64_t asUint64 () const
QPID_TYPES_EXTERN int8_t asInt8 () const
QPID_TYPES_EXTERN int16_t asInt16 () const
QPID_TYPES_EXTERN int32_t asInt32 () const
QPID_TYPES_EXTERN int64_t asInt64 () const
QPID_TYPES_EXTERN float asFloat () const
QPID_TYPES_EXTERN double asDouble () const
QPID_TYPES_EXTERN std::string asString () const
QPID_TYPES_EXTERN Uuid asUuid () const
QPID_TYPES_EXTERN operator bool () const
QPID_TYPES_EXTERN operator uint8_t () const
QPID_TYPES_EXTERN operator uint16_t () const
QPID_TYPES_EXTERN operator uint32_t () const
QPID_TYPES_EXTERN operator uint64_t () const
QPID_TYPES_EXTERN operator int8_t () const
QPID_TYPES_EXTERN operator int16_t () const
QPID_TYPES_EXTERN operator int32_t () const
QPID_TYPES_EXTERN operator int64_t () const
QPID_TYPES_EXTERN operator float () const
QPID_TYPES_EXTERN operator double () const
QPID_TYPES_EXTERN operator std::string () const
QPID_TYPES_EXTERN operator Uuid () const
QPID_TYPES_EXTERN const MapasMap () const
QPID_TYPES_EXTERN MapasMap ()
QPID_TYPES_EXTERN const ListasList () const
QPID_TYPES_EXTERN ListasList ()
QPID_TYPES_EXTERN const
std::string & 
getString () const
 Unlike asString(), getString() will not do any conversions.
QPID_TYPES_EXTERN std::string & getString ()
QPID_TYPES_EXTERN void setEncoding (const std::string &)
QPID_TYPES_EXTERN const
std::string & 
getEncoding () const
QPID_TYPES_EXTERN bool isEqualTo (const Variant &a) const
QPID_TYPES_EXTERN void reset ()
 Reset value to VOID, does not reset the descriptors.
QPID_TYPES_EXTERN bool isDescribed () const
 True if there is at least one descriptor associated with this variant.
QPID_TYPES_EXTERN Variant getDescriptor () const
 Get the first descriptor associated with this variant.
QPID_TYPES_EXTERN void setDescriptor (const Variant &descriptor)
 Set a single descriptor for this Variant.
QPID_TYPES_EXTERN ListgetDescriptors ()
 Return a modifiable list of descriptors for this Variant.
QPID_TYPES_EXTERN const ListgetDescriptors () const
 Return the list of descriptors for this Variant.

Static Public Member Functions

static QPID_TYPES_EXTERN Variant described (const Variant &descriptor, const Variant &value)
 Create a described value.
static QPID_TYPES_EXTERN Variant described (const Variant &descriptor, const List &value)
 Create a described list, a common special case.

Detailed Description

Represents a value of variable type.

Definition at line 73 of file Variant.h.


Member Typedef Documentation

typedef std::list<Variant> qpid::types::Variant::List

Definition at line 77 of file Variant.h.

typedef std::map<std::string, Variant> qpid::types::Variant::Map

Definition at line 76 of file Variant.h.


Constructor & Destructor Documentation

QPID_TYPES_EXTERN qpid::types::Variant::Variant ( const std::string &  value,
const std::string &  encoding 
)
QPID_TYPES_EXTERN qpid::types::Variant::Variant ( const char *  value,
const char *  encoding 
)

Member Function Documentation

static QPID_TYPES_EXTERN Variant qpid::types::Variant::described ( const Variant descriptor,
const Variant value 
) [static]

Create a described value.

static QPID_TYPES_EXTERN Variant qpid::types::Variant::described ( const Variant descriptor,
const List value 
) [static]

Create a described list, a common special case.

Get the first descriptor associated with this variant.

Normally there is at most one descriptor, when there are multiple descriptors use getDescriptors()

Returns:
The first descriptor or VOID if there is no descriptor.
See also:
isDescribed, getDescriptors

Return a modifiable list of descriptors for this Variant.

Used in case where there are multiple descriptors, for a single descriptor use getDescriptor and setDescriptor.

Return the list of descriptors for this Variant.

Used in case where there are multiple descriptors, for a single descriptor use getDescriptor and setDescriptor.

QPID_TYPES_EXTERN const std::string& qpid::types::Variant::getString ( ) const

Unlike asString(), getString() will not do any conversions.

Exceptions:
InvalidConversionif the type is not STRING.

True if there is at least one descriptor associated with this variant.

QPID_TYPES_EXTERN qpid::types::Variant::operator bool ( ) const
QPID_TYPES_EXTERN qpid::types::Variant::operator double ( ) const
QPID_TYPES_EXTERN qpid::types::Variant::operator float ( ) const
QPID_TYPES_EXTERN qpid::types::Variant::operator int16_t ( ) const
QPID_TYPES_EXTERN qpid::types::Variant::operator int32_t ( ) const
QPID_TYPES_EXTERN qpid::types::Variant::operator int64_t ( ) const
QPID_TYPES_EXTERN qpid::types::Variant::operator int8_t ( ) const
QPID_TYPES_EXTERN qpid::types::Variant::operator std::string ( ) const
QPID_TYPES_EXTERN qpid::types::Variant::operator uint16_t ( ) const
QPID_TYPES_EXTERN qpid::types::Variant::operator uint32_t ( ) const
QPID_TYPES_EXTERN qpid::types::Variant::operator uint64_t ( ) const
QPID_TYPES_EXTERN qpid::types::Variant::operator uint8_t ( ) const
QPID_TYPES_EXTERN qpid::types::Variant::operator Uuid ( ) const
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( bool  )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( uint8_t  )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( uint16_t  )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( uint32_t  )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( uint64_t  )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( int8_t  )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( int16_t  )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( int32_t  )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( int64_t  )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( float  )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( double  )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( const std::string &  )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( const char *  )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( const Map )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( const List )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( const Variant )
QPID_TYPES_EXTERN Variant& qpid::types::Variant::operator= ( const Uuid )

Parses the argument and assigns itself the appropriate value.

Recognises integers, doubles and booleans.

Reset value to VOID, does not reset the descriptors.

Set a single descriptor for this Variant.

The descriptor must be a string or integer.

QPID_TYPES_EXTERN void qpid::types::Variant::setEncoding ( const std::string &  )

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

Qpid C++ API Reference
Generated on Wed Dec 30 2015 for Qpid C++ Client API by doxygen 1.7.6.1