Public Member Functions

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

CORBA::TypeCode implementation for an OMG IDL valuetype or event. More...

#include <Value_TypeCode.h>

Inheritance diagram for TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >:
Inheritance graph
[legend]
Collaboration diagram for TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 Value (CORBA::TCKind kind, char const *id, char const *name, CORBA::ValueModifier modifier, TypeCodeType const &concrete_base, FieldArrayType const &fields, CORBA::ULong nfields)
 Constructor.
 Value (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_value or tk_event 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
virtual CORBA::Visibility member_visibility_i (CORBA::ULong index) const
virtual CORBA::ValueModifier type_modifier_i (void) const
virtual CORBA::TypeCode_ptr concrete_base_type_i (void) const

Protected Attributes

Base_Attributes< StringType > base_attributes_
CORBA::ValueModifier type_modifier_
TypeCodeType concrete_base_
CORBA::ULong nfields_
 The number of fields in the OMG IDL value.
FieldArrayType fields_

Detailed Description

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

CORBA::TypeCode implementation for an OMG IDL valuetype or event.

This class implements a CORBA::TypeCode for an OMG IDL valuetype or event.

Definition at line 52 of file Value_TypeCode.h.

Constructor & Destructor Documentation

template<typename StringType , typename TypeCodeType , class FieldArrayType , class RefCountPolicy >
TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::Value ( CORBA::TCKind  kind,
char const *  id,
char const *  name,
CORBA::ValueModifier  modifier,
TypeCodeType const &  concrete_base,
FieldArrayType const &  fields,
CORBA::ULong  nfields 
)

Constructor.

Definition at line 15 of file Value_TypeCode.inl.

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

template<typename StringType , typename TypeCodeType , class FieldArrayType , class RefCountPolicy >
TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::Value ( CORBA::TCKind  kind,
char const *  id 
)

Constructor used for recursive TypeCodes.

Definition at line 41 of file Value_TypeCode.inl.

  : ::CORBA::TypeCode (kind)
  , RefCountPolicy ()
  , base_attributes_ (id)
  , type_modifier_ (CORBA::VM_NONE)
  , concrete_base_ ()
  , nfields_ (0)
  , fields_ ()
{
}

Member Function Documentation

template<typename StringType , typename TypeCodeType , class FieldArrayType , class RefCountPolicy >
CORBA::TypeCode_ptr TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::concrete_base_type_i ( void   )  const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 418 of file Value_TypeCode.cpp.

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

template<typename StringType , typename TypeCodeType , class FieldArrayType , class RefCountPolicy >
CORBA::Boolean TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::equal_i ( CORBA::TypeCode_ptr  tc  )  const [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 119 of file Value_TypeCode.cpp.

{
  // None of these calls should throw since CORBA::TypeCode::equal()
  // verified that the TCKind is the same as our's prior to invoking
  // this method.

  CORBA::ValueModifier const tc_type_modifier =
    tc->type_modifier ();

  if (tc_type_modifier != this->type_modifier_)
    return false;

  CORBA::TypeCode_var rhs_concrete_base_type =
    tc->concrete_base_type ();

  CORBA::Boolean const equal_concrete_base_types =
    this->equal (rhs_concrete_base_type.in ()
                );

  if (!equal_concrete_base_types)
    return false;

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

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

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

      CORBA::Visibility const lhs_visibility = lhs_field.visibility;
      CORBA::Visibility const rhs_visibility =
        tc->member_visibility (i
                              );

      if (lhs_visibility != rhs_visibility)
        return false;

      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::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::equivalent_i ( CORBA::TypeCode_ptr  tc  )  const [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 192 of file Value_TypeCode.cpp.

{
  CORBA::ValueModifier const tc_type_modifier =
    tc->type_modifier ();

  if (tc_type_modifier != this->type_modifier_)
    return false;

  CORBA::TypeCode_var rhs_concrete_base_type =
    tc->concrete_base_type ();

  CORBA::Boolean const equivalent_concrete_base_types =
    this->equivalent (rhs_concrete_base_type.in ());

  if (!equivalent_concrete_base_types)
    return false;

  // 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)
    {
      Value_Field<StringType, TypeCodeType> const & lhs_field =
        this->fields_[i];

      CORBA::Visibility const lhs_visibility =
        lhs_field.visibility;
      CORBA::Visibility const rhs_visibility =
        tc->member_visibility (i);

      if (lhs_visibility != rhs_visibility)
        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 equiv_types =
        lhs_tc->equivalent (rhs_tc.in ()
                           );

      if (!equiv_types)
        return false;
    }

  return true;
}

template<typename StringType , typename TypeCodeType , class FieldArrayType , class RefCountPolicy >
CORBA::TypeCode_ptr TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::get_compact_typecode_i ( void   )  const [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 255 of file Value_TypeCode.cpp.

{
  ACE_Array_Base<Value_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 (
                );
          tc_fields[i].visibility = this->fields_[i].visibility;
        }
    }

  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_value_event_tc (
      this->kind_,
      this->base_attributes_.id (),
      "", // empty name
      this->type_modifier_,
      Traits<StringType>::get_typecode (this->concrete_base_),
      tc_fields,
      this->nfields_
     );
}

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

Reimplemented from CORBA::TypeCode.

Definition at line 310 of file Value_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::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::member_count_i ( void   )  const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 340 of file Value_TypeCode.cpp.

{
  return this->nfields_;
}

template<typename StringType , typename TypeCodeType , class FieldArrayType , class RefCountPolicy >
char const * TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::member_name_i ( CORBA::ULong  index  )  const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 353 of file Value_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::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::member_type_i ( CORBA::ULong  index  )  const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 371 of file Value_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 >
CORBA::Visibility TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::member_visibility_i ( CORBA::ULong  index  )  const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 389 of file Value_TypeCode.cpp.

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

  return this->fields_[index].visibility;
}

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

Reimplemented from CORBA::TypeCode.

Definition at line 325 of file Value_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::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::tao_duplicate ( void   )  [virtual]

Increase the reference count on this TypeCode.

Implements CORBA::TypeCode.

Definition at line 93 of file Value_TypeCode.cpp.

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

template<typename StringType , typename TypeCodeType , class FieldArrayType , class RefCountPolicy >
bool TAO::TypeCode::Value< 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 30 of file Value_TypeCode.cpp.

{
  // A tk_value 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->type_modifier_)
    && marshal (enc,
                Traits<StringType>::get_typecode (this->concrete_base_),
                offset + enc.total_length ())
    && (enc << this->nfields_);

  if (!success)
    return false;

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

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

      if (!(enc << Traits<StringType>::get_string (field.name))
          || !marshal (enc,
                       Traits<StringType>::get_typecode (field.type),
                       offset + enc.total_length ())
          || !(enc << field.visibility))
        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::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::tao_release ( void   )  [virtual]

Decrease the reference count on this object.

Implements CORBA::TypeCode.

Definition at line 106 of file Value_TypeCode.cpp.

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

template<typename StringType , typename TypeCodeType , class FieldArrayType , class RefCountPolicy >
CORBA::ValueModifier TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::type_modifier_i ( void   )  const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 405 of file Value_TypeCode.cpp.

{
  return this->type_modifier_;
}

Member Data Documentation

template<typename StringType , typename TypeCodeType , class FieldArrayType , class RefCountPolicy >
Base_Attributes<StringType> TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::base_attributes_ [protected]

Valuetype Attributes

Attributes representing the structure of an OMG IDL valuetype or event.

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 valuetype.

Definition at line 126 of file Value_TypeCode.h.

template<typename StringType , typename TypeCodeType , class FieldArrayType , class RefCountPolicy >
TypeCodeType TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::concrete_base_ [protected]

The TypeCode corresponding to the concrete base valuetype or eventtype.

Definition at line 134 of file Value_TypeCode.h.

template<typename StringType , typename TypeCodeType , class FieldArrayType , class RefCountPolicy >
FieldArrayType TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::fields_ [protected]

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

Definition at line 141 of file Value_TypeCode.h.

template<typename StringType , typename TypeCodeType , class FieldArrayType , class RefCountPolicy >
CORBA::ULong TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::nfields_ [protected]

The number of fields in the OMG IDL value.

Definition at line 137 of file Value_TypeCode.h.

template<typename StringType , typename TypeCodeType , class FieldArrayType , class RefCountPolicy >
CORBA::ValueModifier TAO::TypeCode::Value< StringType, TypeCodeType, FieldArrayType, RefCountPolicy >::type_modifier_ [protected]

The ValueModifier of the valuetype of eventtype represented by this TypeCode.

Definition at line 130 of file Value_TypeCode.h.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Dec 9 2010 11:42:49 for TAO by  doxygen 1.7.0