TAO::TypeCode::String< RefCountPolicy > Class Template Reference

CORBA::TypeCode implementation for OMG IDL string types. More...

#include <String_TypeCode.h>

Inheritance diagram for TAO::TypeCode::String< RefCountPolicy >:

[legend]Collaboration diagram for TAO::TypeCode::String< RefCountPolicy >:

[legend]List of all members.

@c TAO CORBA::TypeCode Template Methods
CORBA::TypeCode template methods specific to tk_string TypeCodes. 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 CORBA::ULong	length_i (void) const
CORBA::ULong const	length_
Public Member Functions
	String (CORBA::TCKind kind, CORBA::ULong length)
	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<class RefCountPolicy>
class TAO::TypeCode::String< RefCountPolicy >

CORBA::TypeCode implementation for OMG IDL string types.

This class implements a CORBA::TypeCode for OMG IDL string types, including wstring.

Definition at line 44 of file String_TypeCode.h.

---

Constructor & Destructor Documentation

template<class RefCountPolicy>

TAO_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE TAO::TypeCode::String< RefCountPolicy >::String	(	CORBA::TCKind	kind,
		CORBA::ULong	length
	)

Constructor.

Definition at line 9 of file String_TypeCode.inl.

  : ::CORBA::TypeCode (kind)
  , RefCountPolicy ()
  , length_ (length)
{
  // ACE_ASSERT (kind == CORBA::tk_string || kind == CORBA::tk_wstring);
}

---

Member Function Documentation

template<class RefCountPolicy>

CORBA::Boolean TAO::TypeCode::String< RefCountPolicy >::equal_i

(

CORBA::TypeCode_ptr

tc

)

const [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 45 of file String_TypeCode.cpp.

References CORBA::TypeCode::length().

Referenced by TAO::TypeCode::String< TAO::Null_RefCount_Policy >::equivalent_i(), and TAO::TypeCode::String< RefCountPolicy >::equivalent_i().

{
  // The following call won't throw since CORBA::TypeCode::equal() has
  // already established the kind of tc is the same as our kind.
  CORBA::ULong const tc_length = tc->length ();

  return (this->length_ == tc_length);
}

template<class RefCountPolicy>

CORBA::Boolean TAO::TypeCode::String< RefCountPolicy >::equivalent_i

(

CORBA::TypeCode_ptr

tc

)

const [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 57 of file String_TypeCode.cpp.

References TAO::TypeCode::String< RefCountPolicy >::equal_i().

{
  // Since TCKind comparisons must be performed before equal_i() is
  // called, we can also call it to determine equivalence of
  // tk_string-based TypeCodes.
  return this->equal_i (tc);
}

template<class RefCountPolicy>

CORBA::TypeCode_ptr TAO::TypeCode::String< RefCountPolicy >::get_compact_typecode_i

(

void

)

const [protected, virtual]

Implements CORBA::TypeCode.

Definition at line 68 of file String_TypeCode.cpp.

References CORBA::TypeCode::_duplicate().

{
  // Already compact since tk_string and tk_wstring TypeCodes have no
  // name or member names, meaning that we can simply call
  // _duplicate() on this TypeCode.

  CORBA::TypeCode_ptr mutable_tc =
    const_cast<TAO::TypeCode::String<RefCountPolicy> *> (this);

  return CORBA::TypeCode::_duplicate (mutable_tc);
}

template<class RefCountPolicy>

CORBA::ULong TAO::TypeCode::String< RefCountPolicy >::length_i

(

void

)

const [protected, virtual]

Reimplemented from CORBA::TypeCode.

Definition at line 82 of file String_TypeCode.cpp.

References TAO::TypeCode::String< RefCountPolicy >::length_.

{
  return this->length_;
}

template<class RefCountPolicy>

void TAO::TypeCode::String< RefCountPolicy >::tao_duplicate

(

void

)

[virtual]

Increase the reference count on this TypeCode.

Implements CORBA::TypeCode.

Definition at line 31 of file String_TypeCode.cpp.

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

template<class RefCountPolicy>

TAO_BEGIN_VERSIONED_NAMESPACE_DECL bool TAO::TypeCode::String< 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 17 of file String_TypeCode.cpp.

{
  // A tk_string TypeCode has a "simple" parameter list type (see
  // Table 15-2 in Section 15.3.5.1 "TypeCode" in the CDR section of
  // the CORBA specification), meaning that its parameter(s) must be
  // marshaled immediately following the TCKind.  No CDR encapsulation
  // is to be created.

  return (cdr << this->length_);
}

template<class RefCountPolicy>

void TAO::TypeCode::String< RefCountPolicy >::tao_release

(

void

)

[virtual]

Decrease the reference count on this object.

Implements CORBA::TypeCode.

Definition at line 38 of file String_TypeCode.cpp.

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

---

Member Data Documentation

template<class RefCountPolicy>

CORBA::ULong const TAO::TypeCode::String< RefCountPolicy >::length_ [private]

Length of the string. A length of zero indicates an unbounded string.

Definition at line 91 of file String_TypeCode.h.

Referenced by TAO::TypeCode::String< TAO::Null_RefCount_Policy >::length_i(), and TAO::TypeCode::String< RefCountPolicy >::length_i().

---

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

• String_TypeCode.h
• String_TypeCode.cpp
• String_TypeCode.inl

---