CORBA::TypeCode implementation for an OMG IDL union. More...

#include <Union_TypeCode_Static.h>

Inheritance diagram for TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >:

Collaboration diagram for TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >:

Public Types
typedef TAO::TypeCode::Case < StringType, TypeCodeType >	case_type
Public Types inherited from CORBA::TypeCode
typedef CORBA::TypeCode_ptr	_ptr_type
typedef CORBA::TypeCode_var	_var_type
typedef CORBA::TypeCode_out	_out_type

Public Member Functions
	Union (char const id, char const name, TypeCodeType const &discriminant_type, CaseArrayType const &cases, CORBA::ULong ncases, CORBA::Long default_index)
	Constructor.
	Union (CORBA::TCKind kind, char const *id)
	Constructor used for recursive TypeCodes.
TAO-specific @c CORBA::TypeCode Methods
Methods required by TAO's implementation of the `CORBA::TypeCode` class. See Also `CORBA::TypeCode`
virtual bool	tao_marshal (TAO_OutputCDR &cdr, CORBA::ULong offset) const
	Marshal this `TypeCode` into a CDR output stream.
virtual void	tao_duplicate (void)
	Increase the reference count on this `TypeCode`.
virtual void	tao_release (void)
	Decrease the reference count on this object.
Public Member Functions inherited from CORBA::TypeCode
virtual bool	tao_marshal_kind (TAO_OutputCDR &cdr) const
	Marshal the `TypeCode` `TCKind`.
Boolean	equal (TypeCode_ptr tc) const
	Equality of two `TypeCodes`.
Boolean	equivalent (TypeCode_ptr tc) const
	Equivalence of two `TypeCodes`.
TCKind	kind (void) const
	The kind of `TypeCode`.
TypeCode_ptr	get_compact_typecode (void) const
char const *	id (void) const
	The `RepositoryId` globally identifying the type.
char const *	name (void) const
ULong	member_count (void) const
	The type member count.
char const *	member_name (ULong index) const
	The type member name.
TypeCode_ptr	member_type (ULong index) const
	The type member `TypeCode`.
Any *	member_label (ULong index) const
	The union member label.
TypeCode_ptr	discriminator_type (void) const
	The type of all non-default union member labels.
Long	default_index (void) const
	The index of the default union member.
ULong	length (void) const
	The length of the type.
TypeCode_ptr	content_type (void) const
	The underlying content type.
UShort	fixed_digits (void) const
	The number of significant digits.
UShort	fixed_scale (void) const
	The scale factor.
Visibility	member_visibility (ULong index) const
ValueModifier	type_modifier (void) const
TypeCode_ptr	concrete_base_type (void) const

Protected Member Functions
@c TAO CORBA::TypeCode Template Methods
`tk_union` `CORBA::TypeCode` -specific template methods. See Also `CORBA::TypeCode`
virtual CORBA::Boolean	equal_i (CORBA::TypeCode_ptr tc) const
virtual CORBA::Boolean	equivalent_i (CORBA::TypeCode_ptr tc) const
virtual CORBA::TypeCode_ptr	get_compact_typecode_i (void) const
virtual char const *	id_i (void) const
virtual char const *	name_i (void) const
virtual CORBA::ULong	member_count_i (void) const
virtual char const *	member_name_i (CORBA::ULong index) const
virtual CORBA::TypeCode_ptr	member_type_i (CORBA::ULong index) const
virtual CORBA::Any *	member_label_i (CORBA::ULong index) const
virtual CORBA::TypeCode_ptr	discriminator_type_i (void) const
virtual CORBA::Long	default_index_i (void) const
Protected Member Functions inherited from CORBA::TypeCode
	TypeCode (CORBA::TCKind kind)
	Constructor.
virtual	~TypeCode (void)
	Destructor.
virtual ULong	length_i (void) const
virtual TypeCode_ptr	content_type_i (void) const
virtual UShort	fixed_digits_i (void) const
virtual UShort	fixed_scale_i (void) const
virtual Visibility	member_visibility_i (ULong index) const
virtual ValueModifier	type_modifier_i (void) const
virtual TypeCode_ptr	concrete_base_type_i (void) const

Protected Attributes

Base_Attributes< StringType >	base_attributes_
TypeCodeType	discriminant_type_
	Type of IDL `union` discriminant.
CORBA::Long	default_index_
	Index of the default union case.
CORBA::ULong	ncases_
CaseArrayType	cases_
Protected Attributes inherited from CORBA::TypeCode
TCKind const	kind_
	The kind of TypeCode.

Additional Inherited Members
Static Public Member Functions inherited from CORBA::TypeCode
static CORBA::TypeCode_ptr	_duplicate (CORBA::TypeCode_ptr tc)
	Duplicate this `TypeCode`.
static CORBA::TypeCode_ptr	_nil (void)
	Returns a NULL typecode.
static void	_tao_any_destructor (void *x)
	Destruction callback for Anys.
Static Public Attributes inherited from CORBA::TypeCode
static CORBA::TypeCode_ptr const	_tc_Bounds
static CORBA::TypeCode_ptr const	_tc_BadKind

Detailed Description

template<typename StringType, typename TypeCodeType, class CaseArrayType, class RefCountPolicy>
class TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >

CORBA::TypeCode implementation for an OMG IDL union.

This class implements a CORBA::TypeCode for an OMG IDL union.

Member Typedef Documentation

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

typedef TAO::TypeCode::Case<StringType, TypeCodeType> TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::case_type

Constructor & Destructor Documentation

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::Union	(	char const *	id,
		char const *	name,
		TypeCodeType const &	discriminant_type,
		CaseArrayType const &	cases,
		CORBA::ULong	ncases,
		CORBA::Long	default_index
	)

Constructor.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::Union	(	CORBA::TCKind	kind,
		char const *	id
	)

Constructor used for recursive TypeCodes.

Member Function Documentation

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

CORBA::Long TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::default_index_i ( void ) const

protectedvirtual

Reimplemented from CORBA::TypeCode.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

CORBA::TypeCode_ptr TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::discriminator_type_i ( void ) const

protectedvirtual

Reimplemented from CORBA::TypeCode.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

CORBA::Boolean TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::equal_i ( CORBA::TypeCode_ptr tc ) const

protectedvirtual

Implements CORBA::TypeCode.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

CORBA::Boolean TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::equivalent_i ( CORBA::TypeCode_ptr tc ) const

protectedvirtual

Implements CORBA::TypeCode.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

CORBA::TypeCode_ptr TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::get_compact_typecode_i ( void ) const

protectedvirtual

Implements CORBA::TypeCode.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

char const * TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::id_i ( void ) const

protectedvirtual

Reimplemented from CORBA::TypeCode.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

CORBA::ULong TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::member_count_i ( void ) const

protectedvirtual

Reimplemented from CORBA::TypeCode.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

CORBA::Any * TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::member_label_i ( CORBA::ULong index ) const

protectedvirtual

Reimplemented from CORBA::TypeCode.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

char const * TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::member_name_i ( CORBA::ULong index ) const

protectedvirtual

Reimplemented from CORBA::TypeCode.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

CORBA::TypeCode_ptr TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::member_type_i ( CORBA::ULong index ) const

protectedvirtual

Reimplemented from CORBA::TypeCode.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

char const * TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::name_i ( void ) const

protectedvirtual

Reimplemented from CORBA::TypeCode.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

void TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::tao_duplicate ( void )

virtual

Increase the reference count on this TypeCode.

Implements CORBA::TypeCode.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

bool TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::tao_marshal	(	TAO_OutputCDR &	cdr,
		CORBA::ULong	offset
	)		const

virtual

Marshal this TypeCode into a CDR output stream.

Marshal this TypeCode into the cdr output CDR stream, excluding the TypeCode kind. Existing cdr contents will not be altered. The marshaled TypeCode will be appended to the given cdr CDR output stream.

Parameters

cdr	Output CDR stream into which the `TypeCode` will be marshaled.
offset	Number of bytes currently in the output CDR stream, including the top-level TypeCode `TCKind`. This argument is useful for recursive `TypeCodes`. `TypeCodes` that contain other `TypeCodes` should pass an updated offset value to the marshaling operation for those contained `TypeCodes`.

Returns: true if marshaling was successful.

Note: This is a TAO-specific method that is not part of the standard CORBA::TypeCode interface.; If this method returns false, the contents of the cdr output CDR stream are undefined.

Implements CORBA::TypeCode.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

void TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::tao_release ( void )

virtual

Decrease the reference count on this object.

Implements CORBA::TypeCode.

Member Data Documentation

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

Base_Attributes<StringType> TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::base_attributes_

protected

Union Attributes

Attributes representing the structure of an OMG IDL union.

Note: These attributes are declared in the order in which they are marshaled into a CDR stream in order to increase cache hits by improving spatial locality.Base attributes containing repository ID and name of union type.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

CaseArrayType TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::cases_

protected

Array of TAO::TypeCode::Case representing structure of the OMG IDL defined union.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

CORBA::Long TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::default_index_

protected

Index of the default union case.

This value will be -1 if no default case is found in the union.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

TypeCodeType TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::discriminant_type_

protected

Type of IDL union discriminant.

template<typename StringType , typename TypeCodeType , class CaseArrayType , class RefCountPolicy >

CORBA::ULong TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::ncases_

protected

The number of cases in the OMG IDL union, excluding the default case.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<typename StringType, typename TypeCodeType, class CaseArrayType, class RefCountPolicy> class TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename StringType, typename TypeCodeType, class CaseArrayType, class RefCountPolicy>
class TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >