TAO::bounded_basic_string_sequence

TAO::bounded_basic_string_sequence< charT, MAX > Class Template Reference

#include <Bounded_Basic_String_Sequence_T.h>

List of all members.

Public Types

typedef charT character_type
typedef charT * value_type
typedef charT const * const_value_type
typedef details::string_traits<
charT, true > 		element_traits
typedef details::bounded_reference_allocation_traits<
value_type, element_traits,
MAX, true > 		allocation_traits
typedef details::string_sequence_element<
element_traits > 		element_type
typedef details::string_const_sequence_element<
element_traits > 		const_element_type
typedef element_type subscript_type
typedef const_value_type const_subscript_type
typedef details::generic_sequence<
value_type, allocation_traits,
element_traits > 		implementation_type

Public Member Functions

 bounded_basic_string_sequence ()
 Default constructor.
 bounded_basic_string_sequence (CORBA::ULong length, value_type *data, CORBA::Boolean release)
 Default constructor.
CORBA::ULong maximum () const
 Return the maximum length of the sequence.
CORBA::Boolean release () const
 Returns the state of the sequence release flag.
CORBA::ULong length () const
 Returns the length of the sequence.
void length (CORBA::ULong length)
 Returns the length of the sequence.
const_element_type operator[] (CORBA::ULong i) const
 Get a const element from the sequence.
element_type operator[] (CORBA::ULong i)
 Get a const element from the sequence.
const_value_type const * get_buffer () const
 This function allows read-only access to the sequence buffer. The sequence returns its buffer, allocating one of one has not yet been allocated. No direct modification of the returned buffer by the caller is permitted.
void replace (CORBA::ULong length, value_type *data, CORBA::Boolean release=false)
 Allows the buffer underlying a sequence to be replaced. The parameters to replace() are identical in type, order, and purpose to those for the <T *data> constructor for the sequence.
value_type * get_buffer (CORBA::Boolean orphan=false)
 Allows read-write access to the underlying buffer.

If orphan is FALSE the sequence returns a pointer to its buffer, allocating one if it has not yet done so. The number of elements in the buffer can be determined from the sequence length() accessor.

If the orphan argument to get_buffer() is FALSE, the sequence maintains ownership of the underlying buffer. Elements in the returned buffer may be directly replaced by the caller. For sequences of strings, wide strings, and object references, the caller must use the sequence release accessor to determine whether elements should be freed (using string_free, wstring_free, or CORBA::release for strings, wide strings, and object references, respective) before being directly assigned to.

If the orphan argument to get_buffer is TRUE, the sequence yields ownership of the buffer to the caller. If orphan is TRUE and the sequence does not own its buffer (i.e., its release_ flag is FALSE), the return value is a null pointer. If the buffer is taken from the sequence using this form of get_buffer(), the sequence reverts to the same state it would have if constructed using its default constructor. The caller becomes responsible for eventually freeing each element of the returned buffer (for strings, wide string, and object references), and then freeing the returned buffer itself using freebuf().

void swap (bounded_basic_string_sequence &rhs) throw ()

Static Public Member Functions

static value_type * allocbuf (CORBA::ULong maximum)
static value_type * allocbuf ()
static void freebuf (value_type *buffer)

Private Attributes

implementation_type impl_

Detailed Description

template<typename charT, CORBA::ULong MAX>
class TAO::bounded_basic_string_sequence< charT, MAX >

Definition at line 23 of file Bounded_Basic_String_Sequence_T.h.

Member Typedef Documentation

template<typename charT, CORBA::ULong MAX>
typedef details::bounded_reference_allocation_traits<value_type,element_traits,MAX,true> TAO::bounded_basic_string_sequence< charT, MAX >::allocation_traits

Definition at line 31 of file Bounded_Basic_String_Sequence_T.h.

template<typename charT, CORBA::ULong MAX>
typedef charT TAO::bounded_basic_string_sequence< charT, MAX >::character_type

Definition at line 26 of file Bounded_Basic_String_Sequence_T.h.

template<typename charT, CORBA::ULong MAX>
typedef details::string_const_sequence_element<element_traits> TAO::bounded_basic_string_sequence< charT, MAX >::const_element_type

Definition at line 34 of file Bounded_Basic_String_Sequence_T.h.

template<typename charT, CORBA::ULong MAX>
typedef const_value_type TAO::bounded_basic_string_sequence< charT, MAX >::const_subscript_type

Definition at line 36 of file Bounded_Basic_String_Sequence_T.h.

template<typename charT, CORBA::ULong MAX>
typedef charT const* TAO::bounded_basic_string_sequence< charT, MAX >::const_value_type

Definition at line 28 of file Bounded_Basic_String_Sequence_T.h.

template<typename charT, CORBA::ULong MAX>
typedef details::string_traits<charT,true> TAO::bounded_basic_string_sequence< charT, MAX >::element_traits

Definition at line 30 of file Bounded_Basic_String_Sequence_T.h.

template<typename charT, CORBA::ULong MAX>
typedef details::string_sequence_element<element_traits> TAO::bounded_basic_string_sequence< charT, MAX >::element_type

Definition at line 33 of file Bounded_Basic_String_Sequence_T.h.

template<typename charT, CORBA::ULong MAX>
typedef details::generic_sequence<value_type, allocation_traits, element_traits> TAO::bounded_basic_string_sequence< charT, MAX >::implementation_type

Definition at line 38 of file Bounded_Basic_String_Sequence_T.h.

template<typename charT, CORBA::ULong MAX>
typedef element_type TAO::bounded_basic_string_sequence< charT, MAX >::subscript_type

Definition at line 35 of file Bounded_Basic_String_Sequence_T.h.

template<typename charT, CORBA::ULong MAX>
typedef charT* TAO::bounded_basic_string_sequence< charT, MAX >::value_type

Definition at line 27 of file Bounded_Basic_String_Sequence_T.h.

Constructor & Destructor Documentation

template<typename charT, CORBA::ULong MAX>
TAO::bounded_basic_string_sequence< charT, MAX >::bounded_basic_string_sequence (  )  [inline]

Default constructor.

Definition at line 41 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::impl_.

00042     : impl_()
00043   {}

template<typename charT, CORBA::ULong MAX>
TAO::bounded_basic_string_sequence< charT, MAX >::bounded_basic_string_sequence ( CORBA::ULong  length,
value_type *  data,
CORBA::Boolean  release 
) [inline]

Default constructor.

Definition at line 45 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::impl_.

00049     : impl_(MAX, length, data, release)
00050   {}

Member Function Documentation

template<typename charT, CORBA::ULong MAX>
static value_type* TAO::bounded_basic_string_sequence< charT, MAX >::allocbuf (  )  [inline, static]

Definition at line 100 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::allocbuf().

00100                                  {
00101     return implementation_type::allocbuf(MAX);
00102   }

template<typename charT, CORBA::ULong MAX>
static value_type* TAO::bounded_basic_string_sequence< charT, MAX >::allocbuf ( CORBA::ULong  maximum  )  [inline, static]

Definition at line 96 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::allocbuf().

Referenced by TAO::bounded_basic_string_sequence< charT, MAX >::allocbuf().

00097   {
00098     return implementation_type::allocbuf(maximum);
00099   }

template<typename charT, CORBA::ULong MAX>
static void TAO::bounded_basic_string_sequence< charT, MAX >::freebuf ( value_type *  buffer  )  [inline, static]

Definition at line 103 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::freebuf().

Referenced by TAO::bounded_basic_string_sequence< charT, MAX >::freebuf().

00104   {
00105     implementation_type::freebuf(buffer);
00106   }

template<typename charT, CORBA::ULong MAX>
value_type* TAO::bounded_basic_string_sequence< charT, MAX >::get_buffer ( CORBA::Boolean  orphan = false  )  [inline]

Allows read-write access to the underlying buffer.

If orphan is FALSE the sequence returns a pointer to its buffer, allocating one if it has not yet done so. The number of elements in the buffer can be determined from the sequence length() accessor.

If the orphan argument to get_buffer() is FALSE, the sequence maintains ownership of the underlying buffer. Elements in the returned buffer may be directly replaced by the caller. For sequences of strings, wide strings, and object references, the caller must use the sequence release accessor to determine whether elements should be freed (using string_free, wstring_free, or CORBA::release for strings, wide strings, and object references, respective) before being directly assigned to.

If the orphan argument to get_buffer is TRUE, the sequence yields ownership of the buffer to the caller. If orphan is TRUE and the sequence does not own its buffer (i.e., its release_ flag is FALSE), the return value is a null pointer. If the buffer is taken from the sequence using this form of get_buffer(), the sequence reverts to the same state it would have if constructed using its default constructor. The caller becomes responsible for eventually freeing each element of the returned buffer (for strings, wide string, and object references), and then freeing the returned buffer itself using freebuf().

Definition at line 89 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::get_buffer(), and TAO::bounded_basic_string_sequence< charT, MAX >::impl_.

00089                                                               {
00090     return impl_.get_buffer(orphan);
00091   }

template<typename charT, CORBA::ULong MAX>
const_value_type const* TAO::bounded_basic_string_sequence< charT, MAX >::get_buffer (  )  const [inline]

This function allows read-only access to the sequence buffer. The sequence returns its buffer, allocating one of one has not yet been allocated. No direct modification of the returned buffer by the caller is permitted.

Definition at line 78 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::get_buffer(), and TAO::bounded_basic_string_sequence< charT, MAX >::impl_.

Referenced by TAO::bounded_basic_string_sequence< charT, MAX >::get_buffer().

00078                                                      {
00079     return impl_.get_buffer();
00080   }

template<typename charT, CORBA::ULong MAX>
void TAO::bounded_basic_string_sequence< charT, MAX >::length ( CORBA::ULong  length  )  [inline]

Returns the length of the sequence.

Definition at line 65 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::impl_, and TAO::bounded_basic_string_sequence< charT, MAX >::length().

00065                                         {
00066     implementation_type::range::check_length(length, MAX);
00067     impl_.length(length);
00068   }

template<typename charT, CORBA::ULong MAX>
CORBA::ULong TAO::bounded_basic_string_sequence< charT, MAX >::length ( void   )  const [inline]

Returns the length of the sequence.

Definition at line 60 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::impl_, and TAO::bounded_basic_string_sequence< charT, MAX >::length().

Referenced by TAO::bounded_basic_string_sequence< charT, MAX >::length().

00060                                    {
00061     return impl_.length();
00062   }

template<typename charT, CORBA::ULong MAX>
CORBA::ULong TAO::bounded_basic_string_sequence< charT, MAX >::maximum (  )  const [inline]

Return the maximum length of the sequence.

Definition at line 52 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::impl_, and TAO::bounded_basic_string_sequence< charT, MAX >::maximum().

Referenced by TAO::bounded_basic_string_sequence< charT, MAX >::maximum().

00052                                     {
00053     return impl_.maximum();
00054   }

template<typename charT, CORBA::ULong MAX>
element_type TAO::bounded_basic_string_sequence< charT, MAX >::operator[] ( CORBA::ULong  i  )  [inline]

Get a const element from the sequence.

Definition at line 74 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::impl_, TAO::bounded_basic_string_sequence< charT, MAX >::operator[](), and CORBA::release().

00074                                                {
00075     return element_type(impl_[i], release());
00076   }

template<typename charT, CORBA::ULong MAX>
const_element_type TAO::bounded_basic_string_sequence< charT, MAX >::operator[] ( CORBA::ULong  i  )  const [inline]

Get a const element from the sequence.

Definition at line 70 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::impl_, TAO::bounded_basic_string_sequence< charT, MAX >::operator[](), and CORBA::release().

Referenced by TAO::bounded_basic_string_sequence< charT, MAX >::operator[]().

00070                                                            {
00071     return const_element_type (impl_[i], release());
00072   }

template<typename charT, CORBA::ULong MAX>
CORBA::Boolean TAO::bounded_basic_string_sequence< charT, MAX >::release ( void   )  const [inline]

Returns the state of the sequence release flag.

Definition at line 56 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::impl_.

00056                                       {
00057     return impl_.release();
00058   }

template<typename charT, CORBA::ULong MAX>
void TAO::bounded_basic_string_sequence< charT, MAX >::replace ( CORBA::ULong  length,
value_type *  data,
CORBA::Boolean  release = false 
) [inline]

Allows the buffer underlying a sequence to be replaced. The parameters to replace() are identical in type, order, and purpose to those for the <T *data> constructor for the sequence.

Definition at line 82 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::impl_, CORBA::release(), and TAO::bounded_basic_string_sequence< charT, MAX >::replace().

Referenced by TAO::bounded_basic_string_sequence< charT, MAX >::replace().

00085                                     {
00086     impl_.replace(MAX, length, data, release);
00087   }

template<typename charT, CORBA::ULong MAX>
void TAO::bounded_basic_string_sequence< charT, MAX >::swap ( bounded_basic_string_sequence< charT, MAX > &  rhs  )  throw () [inline]

Definition at line 92 of file Bounded_Basic_String_Sequence_T.h.

References TAO::bounded_basic_string_sequence< charT, MAX >::impl_, and TAO::bounded_basic_string_sequence< charT, MAX >::swap().

Referenced by TAO::bounded_basic_string_sequence< charT, MAX >::swap().

00092                                                                 {
00093     impl_.swap(rhs.impl_);
00094   }

Member Data Documentation

template<typename charT, CORBA::ULong MAX>
implementation_type TAO::bounded_basic_string_sequence< charT, MAX >::impl_ [private]

Definition at line 109 of file Bounded_Basic_String_Sequence_T.h.

Referenced by TAO::bounded_basic_string_sequence< charT, MAX >::bounded_basic_string_sequence(), TAO::bounded_basic_string_sequence< charT, MAX >::get_buffer(), TAO::bounded_basic_string_sequence< charT, MAX >::length(), TAO::bounded_basic_string_sequence< charT, MAX >::maximum(), TAO::bounded_basic_string_sequence< charT, MAX >::operator[](), TAO::bounded_basic_string_sequence< charT, MAX >::release(), TAO::bounded_basic_string_sequence< charT, MAX >::replace(), and TAO::bounded_basic_string_sequence< charT, MAX >::swap().

The documentation for this class was generated from the following file:
Generated on Tue Feb 2 17:39:09 2010 for TAO by  doxygen 1.4.7