TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy > Class Template Reference

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

#include <Enum_TypeCode.h>

Inheritance diagram for TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >:

[legend]Collaboration diagram for TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >:

[legend]List of all members.

Public Member Functions
	Enum (char const *id, char const *name, EnumeratorArrayType const &enumerators, CORBA::ULong nenumerators)
	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.
Protected Member Functions
@c TAO CORBA::TypeCode Template Methods
tk_enum 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
Private Attributes
Base_Attributes< StringType >	base_attributes_
CORBA::ULong const	nenumerators_
	The number of enumerators in the OMG IDL enumeration.
EnumeratorArrayType const	enumerators_

---

Detailed Description

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>
class TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >

CORBA::TypeCode implementation for an OMG IDL enum.

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

Definition at line 46 of file Enum_TypeCode.h.

---

Constructor & Destructor Documentation

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

TAO_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::Enum	(	char const *	id,
		char const *	name,
		EnumeratorArrayType const &	enumerators,
		CORBA::ULong	nenumerators
	)

Constructor.

Definition at line 11 of file Enum_TypeCode.inl.

  : ::CORBA::TypeCode (CORBA::tk_enum)
  , RefCountPolicy ()
  , base_attributes_ (id, name)
  , nenumerators_ (nenumerators)
  , enumerators_ (enumerators)
{
}

---

Member Function Documentation

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

CORBA::Boolean TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::equal_i

(

CORBA::TypeCode_ptr

tc

)

const [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 83 of file Enum_TypeCode.cpp.

References ACE_OS::strcmp().

{
  // This call shouldn't throw since CORBA::TypeCode::equal() verified
  // that the TCKind is the same as our's prior to invoking this
  // method, meaning that member_count() is supported.

  CORBA::ULong const tc_nenumerators =
    tc->member_count ();

  if (tc_nenumerators != this->nenumerators_)
    return false;

  for (CORBA::ULong i = 0; i < this->nenumerators_; ++i)
    {
      StringType const & lhs_enumerator = this->enumerators_[i];

      char const * const lhs_name =
        Traits<StringType>::get_string (lhs_enumerator);
      char const * const rhs_name = tc->member_name (i
                                                    );

      if (ACE_OS::strcmp (lhs_name, rhs_name) != 0)
        return false;
    }

  return true;
}

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

CORBA::Boolean TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::equivalent_i

(

CORBA::TypeCode_ptr

tc

)

const [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 117 of file Enum_TypeCode.cpp.

{
  // Perform a structural comparison, excluding the name() and
  // member_name() operations.

  CORBA::ULong const tc_nenumerators =
    tc->member_count ();

  if (tc_nenumerators != this->nenumerators_)
    return false;

  return true;
}

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

CORBA::TypeCode_ptr TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::get_compact_typecode_i

(

void

)

const [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 137 of file Enum_TypeCode.cpp.

References TAO_TypeCodeFactory_Adapter::create_enum_tc(), ACE_Dynamic_Service< TYPE >::instance(), and TAO_ORB_Core::typecodefactory_adapter_name().

{
  ACE_Array_Base<CORBA::String_var> tc_enumerators (this->nenumerators_);

  // Dynamically construct a new array of enumerators stripped of
  // member names.

  static char const empty_name[] = "";

  for (CORBA::ULong i = 0; i < this->nenumerators_; ++i)
    {
      // Member names will be stripped, i.e. not embedded within
      // the compact TypeCode.

      tc_enumerators[i] = empty_name;
    }

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

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

  return
    adapter->create_enum_tc (this->base_attributes_.id (),
                             ""  /* empty name */,
                             tc_enumerators,
                             this->nenumerators_
                            );
}

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

char const * TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::id_i

(

void

)

const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 174 of file Enum_TypeCode.cpp.

References TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::base_attributes_, and TAO::TypeCode::Base_Attributes< STRING_TYPE >::id().

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

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

CORBA::ULong TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::member_count_i

(

void

)

const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 196 of file Enum_TypeCode.cpp.

{
  return this->nenumerators_;
}

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

char const * TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::member_name_i

(

CORBA::ULong

index

)

const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 206 of file Enum_TypeCode.cpp.

{
  // Ownership is retained by the TypeCode, as required by the C++
  // mapping.
  if (index >= this->nenumerators_)
    throw ::CORBA::TypeCode::Bounds ();

  return Traits<StringType>::get_string (this->enumerators_[index]);
}

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

char const * TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::name_i

(

void

)

const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 184 of file Enum_TypeCode.cpp.

References TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::base_attributes_, and TAO::TypeCode::Base_Attributes< STRING_TYPE >::name().

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

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

void TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::tao_duplicate

(

void

)

[virtual]

Increase the reference count on this TypeCode.

Implements CORBA::TypeCode.

Definition at line 65 of file Enum_TypeCode.cpp.

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

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

TAO_BEGIN_VERSIONED_NAMESPACE_DECL bool TAO::TypeCode::Enum< StringType, EnumeratorArrayType, 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 24 of file Enum_TypeCode.cpp.

References TAO_ENCAP_BYTE_ORDER.

{
  // A tk_enum 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;

  bool const success =
    (enc << TAO_OutputCDR::from_boolean (TAO_ENCAP_BYTE_ORDER))
    && (enc << TAO_OutputCDR::from_string (this->base_attributes_.id (), 0))
    && (enc << TAO_OutputCDR::from_string (this->base_attributes_.name (), 0))
    && (enc << this->nenumerators_);

  if (!success)
    return false;

  StringType const * const begin = &this->enumerators_[0];
  StringType const * const end   = begin + this->nenumerators_;

  for (StringType const * i = begin; i != end; ++i)
    {
      StringType const & enumerator = *i;

      if (!(enc << TAO_OutputCDR::from_string (
              Traits<StringType>::get_string (enumerator), 0)))
        return false;
    }

  return
    cdr << static_cast<CORBA::ULong> (enc.total_length ())
    && cdr.write_octet_array_mb (enc.begin ());
}

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

void TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::tao_release

(

void

)

[virtual]

Decrease the reference count on this object.

Implements CORBA::TypeCode.

Definition at line 74 of file Enum_TypeCode.cpp.

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

---

Member Data Documentation

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

Base_Attributes<StringType> TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::base_attributes_ [private]

Base attributes containing repository ID and name of structure type.

Definition at line 107 of file Enum_TypeCode.h.

Referenced by TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::id_i(), and TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::name_i().

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

EnumeratorArrayType const TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::enumerators_ [private]

Array of TAO::TypeCode enumerators representing enumerators in the OMG IDL defined enum.

Definition at line 114 of file Enum_TypeCode.h.

template<typename StringType, class EnumeratorArrayType, class RefCountPolicy>

CORBA::ULong const TAO::TypeCode::Enum< StringType, EnumeratorArrayType, RefCountPolicy >::nenumerators_ [private]

The number of enumerators in the OMG IDL enumeration.

Definition at line 110 of file Enum_TypeCode.h.

---

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

• Enum_TypeCode.h
• Enum_TypeCode.cpp
• Enum_TypeCode.inl

---