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

#include <Union_TypeCode_Static.h>

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

[legend]

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

[legend]

Public Types
typedef TAO::TypeCode::Case< StringType, TypeCodeType >	case_type

Public Types inherited from CORBA::TypeCode
typedef CORBA::TypeCode_ptr	_ptr_type
	Destruction callback for Anys.

typedef CORBA::TypeCode_var	_var_type
	Destruction callback for Anys.

typedef CORBA::TypeCode_out	_out_type
	Destruction callback for Anys.

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
	Accessor for cases_.

virtual void	tao_duplicate ()
	Accessor for cases_.

virtual void	tao_release ()
	Accessor for cases_.

const CaseArrayType &	cases () const
	Accessor for cases_.

Public Member Functions inherited from CORBA::TypeCode
Boolean	equal (TypeCode_ptr tc) const
	Equality of two `TypeCodes`.

Boolean	equivalent (TypeCode_ptr tc) const
	Equivalence of two `TypeCodes`.

TCKind	kind () const
	The kind of `TypeCode`.

TypeCode_ptr	get_compact_typecode () const

char const *	id () const
	The `RepositoryId` globally identifying the type.

char const *	name () const

ULong	member_count () 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 () const
	The type of all non-default union member labels.

Long	default_index () const
	The index of the default union member.

ULong	length () const
	The length of the type.

TypeCode_ptr	content_type () const
	The underlying content type.

UShort	fixed_digits () const
	The number of significant digits.

UShort	fixed_scale () const
	The scale factor.

Visibility	member_visibility (ULong index) const

ValueModifier	type_modifier () const

TypeCode_ptr	concrete_base_type () const

virtual bool	tao_marshal_kind (TAO_OutputCDR &cdr) const
	Marshal the `TypeCode` `TCKind`.

@c TAO CORBA::TypeCode Template Methods
`tk_union` `CORBA::TypeCode` -specific template methods. See also `CORBA::TypeCode`
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_

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 () const

virtual char const *	id_i () const

virtual char const *	name_i () const

virtual CORBA::ULong	member_count_i () 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 () const

virtual CORBA::Long	default_index_i () const

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 ()
	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

Protected Member Functions inherited from CORBA::TypeCode
	TypeCode (CORBA::TCKind kind)
	Constructor.

virtual	~TypeCode ()
	Destructor.

virtual ULong	length_i () const
	The kind of TypeCode.

virtual TypeCode_ptr	content_type_i () const
	The kind of TypeCode.

virtual UShort	fixed_digits_i () const
	The kind of TypeCode.

virtual UShort	fixed_scale_i () const
	The kind of TypeCode.

virtual Visibility	member_visibility_i (ULong index) const
	The kind of TypeCode.

virtual ValueModifier	type_modifier_i () const
	The kind of TypeCode.

virtual TypeCode_ptr	concrete_base_type_i () const
	The kind of TypeCode.

Protected Attributes inherited from CORBA::TypeCode
TCKind const	kind_
	The kind of TypeCode.

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

◆ case_type

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

◆ Union() [1/2]

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.

◆ Union() [2/2]

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

◆ cases()

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

const CaseArrayType & TAO::TypeCode::Union< StringType, TypeCodeType, CaseArrayType, RefCountPolicy >::cases ( ) const

Accessor for cases_.

◆ default_index_i()

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

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

protectedvirtual

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.

Reimplemented from CORBA::TypeCode.

◆ discriminator_type_i()

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

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

protectedvirtual

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.

Reimplemented from CORBA::TypeCode.

◆ equal_i()

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

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.

Implements CORBA::TypeCode.

◆ equivalent_i()

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

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.

Implements CORBA::TypeCode.

◆ get_compact_typecode_i()

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

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

protectedvirtual

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.

Implements CORBA::TypeCode.

◆ id_i()

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

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

protectedvirtual

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.

Reimplemented from CORBA::TypeCode.

◆ member_count_i()

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

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

protectedvirtual

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.

Reimplemented from CORBA::TypeCode.

◆ member_label_i()

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

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.

Reimplemented from CORBA::TypeCode.

◆ member_name_i()

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

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.

Reimplemented from CORBA::TypeCode.

◆ member_type_i()

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

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.

Reimplemented from CORBA::TypeCode.

◆ name_i()

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

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

protectedvirtual

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.

Reimplemented from CORBA::TypeCode.

◆ tao_duplicate()

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

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

virtual

Accessor for cases_.

Implements CORBA::TypeCode.

◆ tao_marshal()

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

Accessor for cases_.

Implements CORBA::TypeCode.

◆ tao_release()

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

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

virtual

Accessor for cases_.

Implements CORBA::TypeCode.

Member Data Documentation

◆ base_attributes_

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.

◆ cases_

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.

◆ default_index_

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.

◆ discriminant_type_

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.

◆ ncases_

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

@c TAO CORBA::TypeCode Template Methods

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ case_type

Constructor & Destructor Documentation

◆ Union() [1/2]

◆ Union() [2/2]

Member Function Documentation

◆ cases()

◆ default_index_i()

◆ discriminator_type_i()

◆ equal_i()

◆ equivalent_i()

◆ get_compact_typecode_i()

◆ id_i()

◆ member_count_i()

◆ member_label_i()

◆ member_name_i()

◆ member_type_i()

◆ name_i()

◆ tao_duplicate()

◆ tao_marshal()

◆ tao_release()

Member Data Documentation

◆ base_attributes_

◆ cases_

◆ default_index_

◆ discriminant_type_

◆ ncases_