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

#include <Struct_TypeCode.h>

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

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

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.

Definition at line 51 of file Struct_TypeCode.h.

Constructor & Destructor Documentation

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

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

Constructor.

Definition at line 15 of file Struct_TypeCode.inl.

  : ::CORBA::TypeCode (kind)
  , RefCountPolicy ()
  , base_attributes_ (id, name)
  , nfields_ (nfields)
  , fields_ (fields)
{
}

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

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

Constructor used for recursive TypeCodes.

Definition at line 37 of file Struct_TypeCode.inl.

  : ::CORBA::TypeCode (kind)
  , RefCountPolicy ()
  , base_attributes_ (id)
  , nfields_ (0)
  , fields_ ()
{
  // CORBA::tk_except is not allowed in the recursive TypeCode case.
  // ACE_ASSERT (kind == CORBA::tk_struct);
}

Member Function Documentation

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 [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 115 of file Struct_TypeCode.cpp.

{
  // 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_nfields =
    tc->member_count ();

  if (tc_nfields != this->nfields_)
    return false;

  for (CORBA::ULong i = 0; i < this->nfields_; ++i)
    {
      Struct_Field<StringType, TypeCodeType> const & lhs_field =
        this->fields_[i];

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

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

      CORBA::TypeCode_ptr const lhs_tc =
        Traits<StringType>::get_typecode (lhs_field.type);
      CORBA::TypeCode_var const rhs_tc =
        tc->member_type (i);

      CORBA::Boolean const equal_members =
        lhs_tc->equal (rhs_tc.in ());

      if (!equal_members)
        return false;
    }

  return true;
}

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 [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 162 of file Struct_TypeCode.cpp.

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

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

  if (tc_nfields != this->nfields_)
    return false;

  for (CORBA::ULong i = 0; i < this->nfields_; ++i)
    {
      CORBA::TypeCode_ptr const lhs =
        Traits<StringType>::get_typecode (this->fields_[i].type);
      CORBA::TypeCode_var const rhs =
        tc->member_type (i);

      CORBA::Boolean const equiv_members =
        lhs->equivalent (rhs.in ());

      if (!equiv_members)
        return false;
    }

  return true;
}

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 [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 199 of file Struct_TypeCode.cpp.

{
  ACE_Array_Base<Struct_Field<CORBA::String_var,
                              CORBA::TypeCode_var> >
    tc_fields (this->nfields_);

  if (this->nfields_ > 0)
    {
      // Dynamically construct a new array of fields stripped of
      // member names.

      static char const empty_name[] = "";

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

          tc_fields[i].name = empty_name;
          tc_fields[i].type =
            Traits<StringType>::get_typecode (
              this->fields_[i].type)->get_compact_typecode ();
        }
    }

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

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

  return
    adapter->create_struct_except_tc (this->kind_,
                                      this->base_attributes_.id (),
                                      ""  /* empty name */,
                                      tc_fields,
                                      this->nfields_);
}

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

char const * TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::id_i ( void ) const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 249 of file Struct_TypeCode.cpp.

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

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

CORBA::ULong TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::member_count_i ( void ) const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 279 of file Struct_TypeCode.cpp.

{
  return this->nfields_;
}

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 [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 292 of file Struct_TypeCode.cpp.

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

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

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 [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 311 of file Struct_TypeCode.cpp.

{
  if (index >= this->nfields_)
    throw ::CORBA::TypeCode::Bounds ();

  return
    CORBA::TypeCode::_duplicate (
      Traits<StringType>::get_typecode (this->fields_[index].type));
}

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

char const * TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::name_i ( void ) const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 264 of file Struct_TypeCode.cpp.

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

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

void TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::tao_duplicate ( void ) [virtual]

Increase the reference count on this TypeCode.

Implements CORBA::TypeCode.

Definition at line 89 of file Struct_TypeCode.cpp.

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

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

bool TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, 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 31 of file Struct_TypeCode.cpp.

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

  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->nfields_);

  if (!success)
    return false;

  Struct_Field<StringType, TypeCodeType> const * const begin =
    &this->fields_[0];
  Struct_Field<StringType, TypeCodeType> const * const end =
    begin + this->nfields_;

  for (Struct_Field<StringType, TypeCodeType> const * i = begin; i != end; ++i)
    {
      Struct_Field<StringType, TypeCodeType> const & field = *i;

      if (!(enc << TAO_OutputCDR::from_string (
                       Traits<StringType>::get_string (field.name), 0))
          || !marshal (enc,
                       Traits<StringType>::get_typecode (field.type),
                       offset + enc.total_length ()))
        return false;
    }

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

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

void TAO::TypeCode::Struct< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::tao_release ( void ) [virtual]

Decrease the reference count on this object.

Implements CORBA::TypeCode.

Definition at line 102 of file Struct_TypeCode.cpp.

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

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.

Definition at line 118 of file Struct_TypeCode.h.

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.

Definition at line 125 of file Struct_TypeCode.h.

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.

Definition at line 121 of file Struct_TypeCode.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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