TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy > Class Template Reference

CORBA::TypeCode implementation for an OMG IDL struct or exception. More...

#include <Struct_TypeCode_Static.h>

Inheritance diagram for TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >:

[legend]

Collaboration diagram for TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >:

[legend]

List of all members.

Public Member Functions
	Struct (CORBA::TCKind kind, char const *id, char const *name, FieldArrayType const &fields, CORBA::ULong nfields)
	Constructor.
	Struct (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.
Protected Member Functions
@c TAO CORBA::TypeCode Template Methods
tk_struct or tk_except 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
Protected Attributes
Base_Attributes< StringType >	base_attributes_
CORBA::ULong	nfields_
	The number of fields in the OMG IDL structure.
FieldArrayType	fields_

---

Detailed Description

template<typename StringType, typename TypeCodeType, class FieldArrayType, class RefCountPolicy>
class TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >

CORBA::TypeCode implementation for an OMG IDL struct or exception.

This class implements a CORBA::TypeCode for an OMG IDL struct or exception.

---

Constructor & Destructor Documentation

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

TAO_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::Struct	(	CORBA::TCKind	kind,
		char const *	id,
		char const *	name,
		FieldArrayType const &	fields,
		CORBA::ULong	nfields
	)			[inline]

Constructor.

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

ACE_INLINE TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::Struct	(	CORBA::TCKind	kind,
		char const *	id
	)			[inline]

Constructor used for recursive TypeCodes.

---

Member Function Documentation

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

TAO_BEGIN_VERSIONED_NAMESPACE_DECL bool TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::tao_marshal	(	TAO_OutputCDR &	cdr,
		CORBA::ULong	offset
	)			const [inline, 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 FieldArrayType, class RefCountPolicy>

void TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::tao_duplicate

(

void

)

[inline, virtual]

Increase the reference count on this TypeCode.

Implements CORBA::TypeCode.

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

void TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::tao_release

(

void

)

[inline, virtual]

Decrease the reference count on this object.

Implements CORBA::TypeCode.

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

CORBA::Boolean TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::equal_i

(

CORBA::TypeCode_ptr

tc

)

const [inline, protected, virtual]

Implements CORBA::TypeCode.

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

CORBA::Boolean TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::equivalent_i

(

CORBA::TypeCode_ptr

tc

)

const [inline, protected, virtual]

Implements CORBA::TypeCode.

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

CORBA::TypeCode_ptr TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::get_compact_typecode_i

(

void

)

const [inline, protected, virtual]

Implements CORBA::TypeCode.

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

char const * TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::id_i

(

void

)

const [inline, protected, virtual]

Reimplemented from CORBA::TypeCode.

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

char const * TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::name_i

(

void

)

const [inline, protected, virtual]

Reimplemented from CORBA::TypeCode.

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

CORBA::ULong TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::member_count_i

(

void

)

const [inline, protected, virtual]

Reimplemented from CORBA::TypeCode.

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

char const * TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::member_name_i

(

CORBA::ULong

index

)

const [inline, protected, virtual]

Reimplemented from CORBA::TypeCode.

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

CORBA::TypeCode_ptr TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::member_type_i

(

CORBA::ULong

index

)

const [inline, protected, virtual]

Reimplemented from CORBA::TypeCode.

---

Member Data Documentation

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

Base_Attributes<StringType> TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::base_attributes_ [protected]

Struct Attributes

Attributes representing the structure of an OMG IDL struct or exception.

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 structure type.

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

CORBA::ULong TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::nfields_ [protected]

The number of fields in the OMG IDL structure.

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

FieldArrayType TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::fields_ [protected]

Array of TAO::TypeCode fields representing structure of the OMG IDL defined struct.

---

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

• Struct_TypeCode.h
• Struct_TypeCode.cpp
• Struct_TypeCode.inl
• Struct_TypeCode_Static.cpp