IT_Bus::AnyHolder Class Reference

#include <it_bus/any_holder.h>

Inheritance diagram for IT_Bus::AnyHolder:

List of all members.

---

Detailed Description

A holder class for a pointer to a type derived from AnyType.

Built-in types, which are not derived from AnyType, are contained within a type-specific holder class that is derived from AnyType. Types generated from type definitions in either a WSDL or XSD file are derived from AnyType, and the AnyHolder encapsulates a pointer to an instance of the generated type.

This class includes get and set methods for each of the built-in types (Boolean, Byte, Short, Int, Long, String, Float, Double, UByte, UShort, UInt, ULong, Decimal), as well as get and set methods for AnyType.

Definition at line 36 of file any_holder.h.

Public Types
typedef IT_Reflect::ComplexValueRef< AnyHolder >	IT_ReflectionType
Public Member Functions
	AnyHolder ()
	No argument constructor.
	AnyHolder (AnyTypeFactory *type_manager)
	Constructor.
virtual	~AnyHolder ()
	Destructor.
	AnyHolder (const AnyHolder &rhs)
	Copy constructor.
AnyHolder &	operator= (const AnyHolder &rhs)
	Assignment operator.
virtual AnyType &	copy (const AnyType &other)
	Returns a reference to this AnyHolder, which now holds a pointer to the AnyType parameter.
virtual const QName &	get_type () const
	Returns the IT_Bus::QName for the type pointed to by the holder instance.
virtual Kind	get_kind () const
	Returns the IT_Bus::AnyType::Kind for the AnyHolder class.
virtual void	read (const QName &name, ComplexTypeReader &reader) IT_THROW_DECL((DeserializationException))
	Read the value into the instance.
virtual void	write (const QName &name, ComplexTypeWriter &writer) const IT_THROW_DECL((SerializationException))
	Write the content of the instance.
bool	is_empty () const
	Determine whether the holder instance currently points to an AnyType instance.
void	set_boolean (const Boolean &)
	Set the input parameter into a BooleanHolder and point to the BooleanHolder within the AnyHolder instance.
void	set_byte (const Byte &)
	Set the input parameter into a ByteHolder and point to the ByteHolder within the AnyHolder instance.
void	set_short (const Short &)
	Set the input parameter into a ShortHolder and point to the ShortHolder within the AnyHolder instance.
void	set_int (const Int &)
	Set the input parameter into a IntHolder and point to the IntHolder within the AnyHolder instance.
void	set_long (const Long &)
	Set the input parameter into a LongHolder and point to the LongHolder within the AnyHolder instance.
void	set_string (const String &)
	Set the input parameter into a StringHolder and point to the StringHolder within the AnyHolder instance.
void	set_QName (const QName &)
	Set the input parameter into a QNameHolder and point to the QNameHolder within the QNameHolder instance.
void	set_float (const Float &)
	Set the input parameter into a FloatHolder and point to the FloatHolder within the AnyHolder instance.
void	set_double (const Double &)
	Set the input parameter into a DoubleHolder and point to the DoubleHolder within the AnyHolder instance.
void	set_ubyte (const UByte &)
	Set the input parameter into a UByteHolder and point to the UByteHolder within the AnyHolder instance.
void	set_ushort (const UShort &)
	Set the input parameter into a UShortHolder and point to the UShortHolder within the AnyHolder instance.
void	set_uint (const UInt &)
	Set the input parameter into a UIntHolder and pointto the UIntHolder within the AnyHolder instance.
void	set_ulong (const ULong &)
	Set the input parameter into a ULongHolder and point to the ULongHolder within the AnyHolder instance.
void	set_decimal (const Decimal &)
	Set the input parameter into a DecimalHolder and point to the DecimalHolder within the AnyHolder instance.
void	set_any_type (const AnyType &)
	Set the pointer within this AnyHolder instance to point to the AnyType input parameter.
Boolean &	get_boolean ()
	Obtain a reference to the Boolean value encapsulated within the BooleanHolder pointed to by this AnyHolder instance.
Byte &	get_byte ()
	Obtain a reference to the Byte value encapsulated within the ByteHolder pointed to by this AnyHolder instance.
Short &	get_short ()
	Obtain a reference to the Short value encapsulated within the ShortHolder pointed to by this AnyHolder instance.
Int &	get_int ()
	Obtain a reference to the Int value encapsulated within the IntHolder pointed to by this AnyHolder instance.
Long &	get_long ()
	Obtain a reference to the Long value encapsulated within the LongHolder pointed to by this AnyHolder instance.
String &	get_string ()
	Obtain a reference to the String value encapsulated within the StringHolder pointed to by this AnyHolder instance.
QName &	get_QName ()
	Obtain a reference to the QName value encapsulated within the QNameHolder pointed to by this AnyHolder instance.
Float &	get_float ()
	Obtain a reference to the Float value encapsulated within the FloatHolder pointed to by this AnyHolder instance.
Double &	get_double ()
	Obtain a reference to the Double value encapsulated within the DoubleHolder pointed to by this AnyHolder instance.
UByte &	get_ubyte ()
	Obtain a reference to the UByte value encapsulated within the UByteHolder pointed to by this AnyHolder instance.
UShort &	get_ushort ()
	Obtain a reference to the UShort value encapsulated within the UShortHolder pointed to by this AnyHolder instance.
UInt &	get_uint ()
	Obtain a reference to the UInt value encapsulated within the UIntHolder pointed to by this AnyHolder instance.
ULong &	get_ulong ()
	Obtain a reference to the ULong value encapsulated within the ULongHolder pointed to by this AnyHolder instance.
Decimal &	get_decimal ()
	Obtain a reference to the Decimal value encapsulated within the DecimalHolder pointed to by this AnyHolder instance.
AnyType &	get_any_type ()
	Get a reference to the AnyType instance pointed to by this AnyHolder instance.
const Boolean &	get_boolean () const
	Obtain a reference to the Boolean value encapsulated within the BooleanHolder pointed to by this AnyHolder instance.
const Byte &	get_byte () const
	Obtain a reference to the Byte value encapsulated within the ByteHolder pointed to by this AnyHolder instance.
const Short &	get_short () const
	Obtain a reference to the Short value encapsulated within the ShortHolder pointed to by this AnyHolder instance.
const Int &	get_int () const
	Obtain a reference to the Int value encapsulated within the IntHolder pointed to by this AnyHolder instance.
const Long &	get_long () const
	Obtain a reference to the Long value encapsulated within the LongHolder pointed to by this AnyHolder instance.
const String &	get_string () const
	Obtain a reference to the String value encapsulated within the StringHolder pointed to by this AnyHolder instance.
const Float &	get_float () const
	Obtain a reference to the Float value encapsulated within the FloatHolder pointed to by this AnyHolder instance.
const Double &	get_double () const
	Obtain a reference to the Double value encapsulated within the DoubleHolder pointed to by this AnyHolder instance.
const UByte &	get_ubyte () const
	Obtain a reference to the UByte value encapsulated within the UByteHolder pointed to by this AnyHolder instance.
const UShort &	get_ushort () const
	Obtain a reference to the UShort value encapsulated within the UShortHolder pointed to by this AnyHolder instance.
const UInt &	get_uint () const
	Obtain a reference to the UInt value encapsulated within the UIntHolder pointed to by this AnyHolder instance.
const ULong &	get_ulong () const
	Obtain a reference to the ULong value encapsulated within the ULongHolder pointed to by this AnyHolder instance.
const Decimal &	get_decimal () const
	Obtain a reference to the Decimal value encapsulated within the DecimalHolder pointed to by this AnyHolder instance.
const AnyType &	get_any_type () const
	Get a reference to the AnyType instance pointed to by this AnyHolder instance.
AnyType *	release ()
	Get the pointer to the AnyType instance pointed to by this AnyHolder instance, and release ownership of the same.
void	clear ()
	Free the memory associated with the pointer and set the pointer to zero.
Private Member Functions
AnyType *	create_type (const QName &type_name, ImplementationDetails::ImplementationType impl_type) const IT_THROW_DECL((DeserializationException))
	Creates an instance of a type and returns a pointer.
Private Attributes
AnyType *	m_value
	The pointer to the AnyType accessed through this instance.
AnyTypeFactory *	m_factory

---

Member Function Documentation

virtual AnyType& IT_Bus::AnyHolder::copy

(

const AnyType &

other

)

[virtual]

Returns a reference to this AnyHolder, which now holds a pointer to the AnyType parameter.

Note: The AnyHolder class is a subclass of AnyType.

Parameters:

A

reference to an AnyType instance.

Returns:

A reference to this holder instance.

AnyType* IT_Bus::AnyHolder::create_type	(	const QName &	type_name,
		ImplementationDetails::ImplementationType	impl_type
	)			const [private, virtual]

Creates an instance of a type and returns a pointer.

Parameters:

	QName	of the type to be created.
	ImplementationDetails::ImplementationType	implementation type

Returns:

pointer to the newly created instance

const AnyType& IT_Bus::AnyHolder::get_any_type

(

)

const

Get a reference to the AnyType instance pointed to by this AnyHolder instance.

Returns:

reference to AnyType

AnyType& IT_Bus::AnyHolder::get_any_type

(

)

Get a reference to the AnyType instance pointed to by this AnyHolder instance.

Returns:

reference to AnyType

const Boolean& IT_Bus::AnyHolder::get_boolean

(

)

const

Obtain a reference to the Boolean value encapsulated within the BooleanHolder pointed to by this AnyHolder instance.

Returns:

reference to Boolean

Boolean& IT_Bus::AnyHolder::get_boolean

(

)

Obtain a reference to the Boolean value encapsulated within the BooleanHolder pointed to by this AnyHolder instance.

Returns:

reference to Boolean

const Byte& IT_Bus::AnyHolder::get_byte

(

)

const

Obtain a reference to the Byte value encapsulated within the ByteHolder pointed to by this AnyHolder instance.

Returns:

reference to Byte

Byte& IT_Bus::AnyHolder::get_byte

(

)

Obtain a reference to the Byte value encapsulated within the ByteHolder pointed to by this AnyHolder instance.

Returns:

reference to Byte

const Decimal& IT_Bus::AnyHolder::get_decimal

(

)

const

Obtain a reference to the Decimal value encapsulated within the DecimalHolder pointed to by this AnyHolder instance.

Returns:

reference to Decimal

Decimal& IT_Bus::AnyHolder::get_decimal

(

)

Obtain a reference to the Decimal value encapsulated within the DecimalHolder pointed to by this AnyHolder instance.

Returns:

reference to Decimal

const Double& IT_Bus::AnyHolder::get_double

(

)

const

Obtain a reference to the Double value encapsulated within the DoubleHolder pointed to by this AnyHolder instance.

Returns:

reference to Double

Double& IT_Bus::AnyHolder::get_double

(

)

Obtain a reference to the Double value encapsulated within the DoubleHolder pointed to by this AnyHolder instance.

Returns:

reference to Double

const Float& IT_Bus::AnyHolder::get_float

(

)

const

Obtain a reference to the Float value encapsulated within the FloatHolder pointed to by this AnyHolder instance.

Returns:

reference to Float

Float& IT_Bus::AnyHolder::get_float

(

)

Obtain a reference to the Float value encapsulated within the FloatHolder pointed to by this AnyHolder instance.

Returns:

reference to Float

const Int& IT_Bus::AnyHolder::get_int

(

)

const

Obtain a reference to the Int value encapsulated within the IntHolder pointed to by this AnyHolder instance.

Returns:

reference to Int

Int& IT_Bus::AnyHolder::get_int

(

)

Obtain a reference to the Int value encapsulated within the IntHolder pointed to by this AnyHolder instance.

Returns:

reference to Int

virtual Kind IT_Bus::AnyHolder::get_kind

(

)

const [virtual]

Returns the IT_Bus::AnyType::Kind for the AnyHolder class.

Returns:

AnyType::ANY_HOLDER. This method returns ANY_HOLDER regardless of the Kind of the AnyType instance pointed to by the holder.

Reimplemented from IT_Bus::AnyType.

const Long& IT_Bus::AnyHolder::get_long

(

)

const

Obtain a reference to the Long value encapsulated within the LongHolder pointed to by this AnyHolder instance.

Returns:

reference to Long

Long& IT_Bus::AnyHolder::get_long

(

)

Obtain a reference to the Long value encapsulated within the LongHolder pointed to by this AnyHolder instance.

Returns:

reference to Long

QName& IT_Bus::AnyHolder::get_QName

(

)

Obtain a reference to the QName value encapsulated within the QNameHolder pointed to by this AnyHolder instance.

Returns:

reference to QName

const Short& IT_Bus::AnyHolder::get_short

(

)

const

Obtain a reference to the Short value encapsulated within the ShortHolder pointed to by this AnyHolder instance.

Returns:

reference to Short

Short& IT_Bus::AnyHolder::get_short

(

)

Obtain a reference to the Short value encapsulated within the ShortHolder pointed to by this AnyHolder instance.

Returns:

reference to Short

const String& IT_Bus::AnyHolder::get_string

(

)

const

Obtain a reference to the String value encapsulated within the StringHolder pointed to by this AnyHolder instance.

Returns:

reference to String

String& IT_Bus::AnyHolder::get_string

(

)

Obtain a reference to the String value encapsulated within the StringHolder pointed to by this AnyHolder instance.

Returns:

reference to String

virtual const QName& IT_Bus::AnyHolder::get_type

(

)

const [virtual]

Returns the IT_Bus::QName for the type pointed to by the holder instance.

Returns:

IT_Bus::QName. If the holder instance does not currently point to an AnyType instance, this method returns QName::EMPTY_QNAME.

Implements IT_Bus::AnyType.

const UByte& IT_Bus::AnyHolder::get_ubyte

(

)

const

Obtain a reference to the UByte value encapsulated within the UByteHolder pointed to by this AnyHolder instance.

Returns:

reference to UByte

UByte& IT_Bus::AnyHolder::get_ubyte

(

)

Obtain a reference to the UByte value encapsulated within the UByteHolder pointed to by this AnyHolder instance.

Returns:

reference to UByte

const UInt& IT_Bus::AnyHolder::get_uint

(

)

const

Obtain a reference to the UInt value encapsulated within the UIntHolder pointed to by this AnyHolder instance.

Returns:

reference to UInt

UInt& IT_Bus::AnyHolder::get_uint

(

)

Obtain a reference to the UInt value encapsulated within the UIntHolder pointed to by this AnyHolder instance.

Returns:

reference to UInt

const ULong& IT_Bus::AnyHolder::get_ulong

(

)

const

Obtain a reference to the ULong value encapsulated within the ULongHolder pointed to by this AnyHolder instance.

Returns:

reference to ULong

ULong& IT_Bus::AnyHolder::get_ulong

(

)

Obtain a reference to the ULong value encapsulated within the ULongHolder pointed to by this AnyHolder instance.

Returns:

reference to ULong

const UShort& IT_Bus::AnyHolder::get_ushort

(

)

const

Obtain a reference to the UShort value encapsulated within the UShortHolder pointed to by this AnyHolder instance.

Returns:

reference to UShort

UShort& IT_Bus::AnyHolder::get_ushort

(

)

Obtain a reference to the UShort value encapsulated within the UShortHolder pointed to by this AnyHolder instance.

Returns:

reference to UShort

bool IT_Bus::AnyHolder::is_empty

(

)

const

Determine whether the holder instance currently points to an AnyType instance.

Returns:

bool

AnyType* IT_Bus::AnyHolder::release

(

)

Get the pointer to the AnyType instance pointed to by this AnyHolder instance, and release ownership of the same.

Returns:

pointer to the AnyType. Caller should release this.

void IT_Bus::AnyHolder::set_any_type

(

const AnyType &

)

Set the pointer within this AnyHolder instance to point to the AnyType input parameter.

Parameters:

reference

to AnyType

void IT_Bus::AnyHolder::set_boolean

(

const Boolean &

)

Set the input parameter into a BooleanHolder and point to the BooleanHolder within the AnyHolder instance.

Parameters:

reference

to Boolean value

void IT_Bus::AnyHolder::set_byte

(

const Byte &

)

Set the input parameter into a ByteHolder and point to the ByteHolder within the AnyHolder instance.

Parameters:

reference

to Byte value

void IT_Bus::AnyHolder::set_decimal

(

const Decimal &

)

Set the input parameter into a DecimalHolder and point to the DecimalHolder within the AnyHolder instance.

Parameters:

reference

to Decimal value

void IT_Bus::AnyHolder::set_double

(

const Double &

)

Set the input parameter into a DoubleHolder and point to the DoubleHolder within the AnyHolder instance.

Parameters:

reference

to Double value

void IT_Bus::AnyHolder::set_float

(

const Float &

)

Set the input parameter into a FloatHolder and point to the FloatHolder within the AnyHolder instance.

Parameters:

reference

to Float value

void IT_Bus::AnyHolder::set_int

(

const Int &

)

Set the input parameter into a IntHolder and point to the IntHolder within the AnyHolder instance.

Parameters:

reference

to Int value

void IT_Bus::AnyHolder::set_long

(

const Long &

)

Set the input parameter into a LongHolder and point to the LongHolder within the AnyHolder instance.

Parameters:

reference

to Long value

void IT_Bus::AnyHolder::set_QName

(

const QName &

)

Set the input parameter into a QNameHolder and point to the QNameHolder within the QNameHolder instance.

Parameters:

reference

to QName value

void IT_Bus::AnyHolder::set_short

(

const Short &

)

Set the input parameter into a ShortHolder and point to the ShortHolder within the AnyHolder instance.

Parameters:

reference

to Short value

void IT_Bus::AnyHolder::set_string

(

const String &

)

Set the input parameter into a StringHolder and point to the StringHolder within the AnyHolder instance.

Parameters:

reference

to String value

void IT_Bus::AnyHolder::set_ubyte

(

const UByte &

)

Set the input parameter into a UByteHolder and point to the UByteHolder within the AnyHolder instance.

Parameters:

reference

to UByte value

void IT_Bus::AnyHolder::set_uint

(

const UInt &

)

Set the input parameter into a UIntHolder and pointto the UIntHolder within the AnyHolder instance.

Parameters:

reference

to UInt value

void IT_Bus::AnyHolder::set_ulong

(

const ULong &

)

Set the input parameter into a ULongHolder and point to the ULongHolder within the AnyHolder instance.

Parameters:

reference

to ULong value

void IT_Bus::AnyHolder::set_ushort

(

const UShort &

)

Set the input parameter into a UShortHolder and point to the UShortHolder within the AnyHolder instance.

Parameters:

reference

to UShort value

---