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

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

#include <Alias_TypeCode.h>

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

[legend]Collaboration diagram for TAO::TypeCode::Alias< StringType, TypeCodeType, RefCountPolicy >:

[legend]List of all members.

@c TAO CORBA::TypeCode Template Methods
tk_alias and tk_value_box 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::TypeCode_ptr	content_type_i (void) const
Base_Attributes< StringType >	attributes_
TypeCodeType const	content_type_
Public Member Functions
	Alias (CORBA::TCKind kind, char const *id, char const *name, TypeCodeType const &tc)
	Constructor.
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.

---

Detailed Description

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

CORBA::TypeCode implementation for an OMG IDL typedef.

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

Definition at line 48 of file Alias_TypeCode.h.

---

Constructor & Destructor Documentation

template<typename StringType, typename TypeCodeType, class RefCountPolicy>

TAO_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE TAO::TypeCode::Alias< StringType, TypeCodeType, RefCountPolicy >::Alias	(	CORBA::TCKind	kind,
		char const *	id,
		char const *	name,
		TypeCodeType const &	tc
	)

Constructor.

Definition at line 13 of file Alias_TypeCode.inl.

  : ::CORBA::TypeCode (kind)
  , RefCountPolicy ()
  , attributes_ (id, name)
  , content_type_ (tc)
{
}

---

Member Function Documentation

template<typename StringType, typename TypeCodeType, class RefCountPolicy>

CORBA::TypeCode_ptr TAO::TypeCode::Alias< StringType, TypeCodeType, RefCountPolicy >::content_type_i

(

void

)

const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 181 of file Alias_TypeCode.cpp.

References CORBA::TypeCode::_duplicate().

{
  return
     CORBA::TypeCode::_duplicate (
       Traits<StringType>::get_typecode (this->content_type_));
}

template<typename StringType, typename TypeCodeType, class RefCountPolicy>

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

(

CORBA::TypeCode_ptr

tc

)

const [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 86 of file Alias_TypeCode.cpp.

{
  // The CORBA::TypeCode base class already verified equality of the
  // base attributes (id and name).  Perform an equality comparison of
  // the content.

  CORBA::TypeCode_var rhs_content_type = tc->content_type ();

  return
    Traits<StringType>::get_typecode (this->content_type_)->equal (
      rhs_content_type.in ());
}

template<typename StringType, typename TypeCodeType, class RefCountPolicy>

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

(

CORBA::TypeCode_ptr

tc

)

const [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 105 of file Alias_TypeCode.cpp.

{
  // Equivalence already verified in the base class
  // CORBA::TypeCode::equivalent() method.

  return true;
}

template<typename StringType, typename TypeCodeType, class RefCountPolicy>

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

(

void

)

const [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 119 of file Alias_TypeCode.cpp.

References TAO_Pseudo_Var_T< T >::in(), CORBA::tk_alias, and TAO_ORB_Core::typecodefactory_adapter_name().

{
  TAO_TypeCodeFactory_Adapter * const adapter =
    ACE_Dynamic_Service<TAO_TypeCodeFactory_Adapter>::instance (
        TAO_ORB_Core::typecodefactory_adapter_name ()
      );

  if (adapter == 0)
    {
      throw ::CORBA::INITIALIZE ();
    }

  CORBA::TypeCode_var compact_content_type =
    Traits<StringType>::get_typecode (
      this->content_type_)->get_compact_typecode ();

  if (this->kind_ == CORBA::tk_alias)
    {
      return adapter->create_alias_tc (this->attributes_.id (),
                                       "",  /* empty name */
                                       compact_content_type.in ());
    }
  else
    {
      return adapter->create_value_box_tc (this->attributes_.id (),
                                           "",  /* empty name */
                                           compact_content_type.in ());
    }
}

template<typename StringType, typename TypeCodeType, class RefCountPolicy>

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

(

void

)

const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 155 of file Alias_TypeCode.cpp.

{
  // Ownership is retained by the TypeCode, as required by the C++
  // mapping.
  return this->attributes_.id ();
}

template<typename StringType, typename TypeCodeType, class RefCountPolicy>

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

(

void

)

const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 168 of file Alias_TypeCode.cpp.

{
  // Ownership is retained by the TypeCode, as required by the C++
  // mapping.
  return this->attributes_.name ();
}

template<typename StringType, typename TypeCodeType, class RefCountPolicy>

void TAO::TypeCode::Alias< StringType, TypeCodeType, RefCountPolicy >::tao_duplicate

(

void

)

[virtual]

Increase the reference count on this TypeCode.

Implements CORBA::TypeCode.

Definition at line 64 of file Alias_TypeCode.cpp.

{
  this->RefCountPolicy::add_ref ();
}

template<typename StringType, typename TypeCodeType, class RefCountPolicy>

TAO_BEGIN_VERSIONED_NAMESPACE_DECL bool TAO::TypeCode::Alias< StringType, TypeCodeType, 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.

Definition at line 27 of file Alias_TypeCode.cpp.

References ACE_align_binary(), ACE_CDR::OCTET_ALIGN, and TAO_ENCAP_BYTE_ORDER.

{
  // A tk_alias TypeCode has a "complex" parameter list type (see
  // Table 15-2 in Section 15.3.5.1 "TypeCode" in the CDR section of
  // the CORBA specification), meaning that it must be marshaled into
  // a CDR encapsulation.

  // Create a CDR encapsulation.

  TAO_OutputCDR enc;

  // Account for the encoded CDR encapsulation length and byte order.
  //
  // Aligning on an octet since the next value after the CDR
  // encapsulation length will always be the byte order octet/boolean
  // in this case.
  offset = ACE_align_binary (offset + 4,
                             ACE_CDR::OCTET_ALIGN);

  return
    enc << TAO_OutputCDR::from_boolean (TAO_ENCAP_BYTE_ORDER)
    && enc << TAO_OutputCDR::from_string (this->attributes_.id (), 0)
    && enc << TAO_OutputCDR::from_string (this->attributes_.name (), 0)
    && marshal (enc,
                Traits<StringType>::get_typecode (this->content_type_),
                offset + enc.total_length ())
    && cdr << static_cast<CORBA::ULong> (enc.total_length ())
    && cdr.write_octet_array_mb (enc.begin ());
}

template<typename StringType, typename TypeCodeType, class RefCountPolicy>

void TAO::TypeCode::Alias< StringType, TypeCodeType, RefCountPolicy >::tao_release

(

void

)

[virtual]

Decrease the reference count on this object.

Implements CORBA::TypeCode.

Definition at line 75 of file Alias_TypeCode.cpp.

{
  this->RefCountPolicy::remove_ref ();
}

---

Member Data Documentation

template<typename StringType, typename TypeCodeType, class RefCountPolicy>

Base_Attributes<StringType> TAO::TypeCode::Alias< StringType, TypeCodeType, RefCountPolicy >::attributes_ [private]

Base attributes for this TypeCode containing the repository ID and name of the typedef.

Definition at line 103 of file Alias_TypeCode.h.

template<typename StringType, typename TypeCodeType, class RefCountPolicy>

TypeCodeType const TAO::TypeCode::Alias< StringType, TypeCodeType, RefCountPolicy >::content_type_ [private]

A pointer to the CORBA::TypeCode_ptr rather than the CORBA::TypeCode_ptr itself is stored since that address is well-defined. We may not know the value of the CORBA::TypeCode_ptr when creating this Field statically at compile-time, hence the indirection.

Note:

This TypeCode is released upon destruction of this TypeCode::Alias.

Definition at line 117 of file Alias_TypeCode.h.

---

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

• Alias_TypeCode.h
• Alias_TypeCode.cpp
• Alias_TypeCode.inl

---