TAO::details::generic_sequence

TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS > Class Template Reference

#include <Generic_Sequence_T.h>

List of all members.

Public Types

typedef T value_type
typedef ALLOCATION_TRAITS allocation_traits
typedef ELEMENT_TRAITS element_traits
typedef range_checking< value_type,
true > 		range

Public Member Functions

 generic_sequence ()
 Default constructor.
 generic_sequence (CORBA::ULong maximum)
 Constructor with control of ownership.
 generic_sequence (CORBA::ULong maximum, CORBA::ULong length, value_type *data, CORBA::Boolean release)
 generic_sequence (generic_sequence const &rhs)
 Copy constructor.
generic_sequence & operator= (generic_sequence const &rhs)
 Assignment operator.
 ~generic_sequence ()
 Destructor.
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)
 Set a new length for the sequence.
value_type const & operator[] (CORBA::ULong i) const
 Get a const element from the sequence.
value_type & operator[] (CORBA::ULong i)
 Get an element from the sequence.
void replace (CORBA::ULong maximum, CORBA::ULong length, value_type *data, CORBA::Boolean release)
value_type const * get_buffer () const
value_type * get_buffer (CORBA::Boolean orphan)
 Allows read-write access to the underlying buffer.
void swap (generic_sequence &rhs) throw ()

Static Public Member Functions

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

Private Attributes

CORBA::ULong maximum_
 The maximum number of elements the buffer can contain.
CORBA::ULong length_
 The current number of elements in the buffer.
value_type * buffer_
 The buffer with all the elements.
CORBA::Boolean release_

Detailed Description

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
class TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >

Definition at line 74 of file Generic_Sequence_T.h.

Member Typedef Documentation

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
typedef ALLOCATION_TRAITS TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::allocation_traits

Definition at line 78 of file Generic_Sequence_T.h.

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
typedef ELEMENT_TRAITS TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::element_traits

Definition at line 79 of file Generic_Sequence_T.h.

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
typedef range_checking<value_type,true> TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::range

Definition at line 80 of file Generic_Sequence_T.h.

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
typedef T TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::value_type

Definition at line 77 of file Generic_Sequence_T.h.

Constructor & Destructor Documentation

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::generic_sequence (  )  [inline]

Default constructor.

Definition at line 83 of file Generic_Sequence_T.h.

00084     : maximum_(allocation_traits::default_maximum())
00085     , length_(0)
00086     , buffer_(allocation_traits::default_buffer_allocation())
00087     , release_(buffer_ != 0)
00088   {
00089   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::generic_sequence ( CORBA::ULong  maximum  )  [inline, explicit]

Constructor with control of ownership.

Definition at line 92 of file Generic_Sequence_T.h.

00093     : maximum_(maximum)
00094     , length_(0)
00095     , buffer_(allocbuf(maximum_))
00096     , release_(true)
00097   {
00098   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::generic_sequence ( CORBA::ULong  maximum,
CORBA::ULong  length,
value_type *  data,
CORBA::Boolean  release 
) [inline]

Definition at line 100 of file Generic_Sequence_T.h.

00105     : maximum_(maximum)
00106     , length_(length)
00107     , buffer_(data)
00108     , release_(release)
00109   {
00110   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::generic_sequence ( generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS > const &  rhs  )  [inline]

Copy constructor.

Definition at line 113 of file Generic_Sequence_T.h.

References ACE_make_checked_array_iterator(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::buffer_, TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length_, TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::maximum_, and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::swap().

00114     : maximum_(0)
00115     , length_(0)
00116     , buffer_(0)
00117     , release_(false)
00118   {
00119     if (rhs.maximum_ == 0) return;
00120     generic_sequence tmp(rhs.maximum_);
00121     tmp.length_ = rhs.length_;
00122     element_traits::copy_range(
00123         rhs.buffer_,
00124         rhs.buffer_ + rhs.length_,
00125         ACE_make_checked_array_iterator (tmp.buffer_, tmp.length_));
00126     swap(tmp);
00127   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::~generic_sequence (  )  [inline]

Destructor.

Definition at line 138 of file Generic_Sequence_T.h.

References TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::buffer_, TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::freebuf(), and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::release_.

00139   {
00140     if (release_)
00141     {
00142       freebuf(buffer_);
00143     }
00144   }

Member Function Documentation

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
static value_type* TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::allocbuf ( CORBA::ULong  maximum  )  [inline, static]

Definition at line 310 of file Generic_Sequence_T.h.

Referenced by TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::get_buffer(), and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length().

00311   {
00312     return allocation_traits::allocbuf(maximum);
00313   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
static void TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::freebuf ( value_type *  buffer  )  [inline, static]

Definition at line 315 of file Generic_Sequence_T.h.

Referenced by TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::~generic_sequence().

00316   {
00317     allocation_traits::freebuf(buffer);
00318   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
value_type* TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::get_buffer ( CORBA::Boolean  orphan  )  [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 276 of file Generic_Sequence_T.h.

References TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::allocbuf(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::buffer_, TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::maximum_, TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::release_, and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::swap().

00277   {
00278     if (orphan && !release_)
00279     {
00280       return 0;
00281     }
00282     if (buffer_ == 0)
00283     {
00284       buffer_ = allocbuf(maximum_);
00285       if (!orphan)
00286         {
00287           release_ = true;
00288         }
00289     }
00290     if (!orphan)
00291     {
00292       return buffer_;
00293     }
00294 
00295     generic_sequence tmp;
00296     swap(tmp);
00297     tmp.release_ = false;
00298 
00299     return tmp.buffer_;
00300   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
value_type const* TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::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 238 of file Generic_Sequence_T.h.

References TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::allocbuf(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::buffer_, TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::maximum_, and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::release_.

00239   {
00240     if (buffer_ == 0)
00241     {
00242       buffer_ = allocbuf(maximum_);
00243       release_ = true;
00244     }
00245     return buffer_;
00246   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
void TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length ( CORBA::ULong  length  )  [inline]

Set a new length for the sequence.

Definition at line 165 of file Generic_Sequence_T.h.

References ACE_make_checked_array_iterator(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::allocbuf(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::buffer_, TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length_, TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::maximum_, TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::release_, and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::swap().

00166   {
00167     if (length <= maximum_ || length <= length_)
00168     {
00169       if (buffer_ == 0)
00170         {
00171           buffer_ = allocbuf(maximum_);
00172           release_ = true;
00173         }
00174 
00175       if (length_ < length)
00176       {
00177         // TODO This code does not provide the strong-exception
00178         //      guarantee, but it does provide the weak-exception
00179         //      guarantee.  The problem would appear when
00180         //      initialize_range() raises an exception after several
00181         //      elements have been modified.  One could argue that
00182         //      this problem is irrelevant, as the elements already
00183         //      modified are unreachable to conforming applications.
00184         element_traits::initialize_range(
00185             buffer_ + length_, buffer_ + length);
00186       }
00187       length_ = length;
00188       return;
00189     }
00190 
00191     generic_sequence tmp(length);
00192     tmp.length_ = length;
00193     element_traits::copy_range(
00194       buffer_,
00195       buffer_ + length_,
00196       ACE_make_checked_array_iterator (tmp.buffer_, tmp.length_));
00197     element_traits::initialize_range(
00198         tmp.buffer_ + length_, tmp.buffer_ + length);
00199 
00200     swap(tmp);
00201   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
CORBA::ULong TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length ( void   )  const [inline]

Returns the length of the sequence.

Definition at line 159 of file Generic_Sequence_T.h.

References TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length_.

00160   {
00161     return length_;
00162   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
CORBA::ULong TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::maximum (  )  const [inline]

Return the maximum length of the sequence.

Definition at line 147 of file Generic_Sequence_T.h.

References TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::maximum_.

00148   {
00149     return maximum_;
00150   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
generic_sequence& TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::operator= ( generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS > const &  rhs  )  [inline]

Assignment operator.

Definition at line 130 of file Generic_Sequence_T.h.

References TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::swap().

00131   {
00132     generic_sequence tmp(rhs);
00133     swap(tmp);
00134     return * this;
00135   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
value_type& TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::operator[] ( CORBA::ULong  i  )  [inline]

Get an element from the sequence.

Definition at line 211 of file Generic_Sequence_T.h.

References TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::buffer_, TAO::details::range_checking< T, dummy >::check(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length_, and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::maximum_.

00212   {
00213     range::check(i, length_, maximum_, "operator[]() non-const");
00214     return buffer_[i];
00215   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
value_type const& TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::operator[] ( CORBA::ULong  i  )  const [inline]

Get a const element from the sequence.

Definition at line 204 of file Generic_Sequence_T.h.

References TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::buffer_, TAO::details::range_checking< T, dummy >::check(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length_, and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::maximum_.

00205   {
00206     range::check(i, length_, maximum_, "operator[]() const");
00207     return buffer_[i];
00208   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
CORBA::Boolean TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::release ( void   )  const [inline]

Returns the state of the sequence release flag.

Definition at line 153 of file Generic_Sequence_T.h.

References TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::release_.

00154   {
00155     return release_;
00156   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
void TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::replace ( CORBA::ULong  maximum,
CORBA::ULong  length,
value_type *  data,
CORBA::Boolean  release 
) [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 222 of file Generic_Sequence_T.h.

References TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::swap().

00227   {
00228     generic_sequence tmp(maximum, length, data, release);
00229     swap(tmp);
00230   }

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
void TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::swap ( generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS > &  rhs  )  throw () [inline]

Definition at line 302 of file Generic_Sequence_T.h.

References TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::buffer_, TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length_, TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::maximum_, and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::release_.

Referenced by TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::generic_sequence(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::get_buffer(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::operator=(), and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::replace().

00303   {
00304     std::swap(maximum_, rhs.maximum_);
00305     std::swap(length_, rhs.length_);
00306     std::swap(buffer_, rhs.buffer_);
00307     std::swap(release_, rhs.release_);
00308   }

Member Data Documentation

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
value_type* TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::buffer_ [mutable, private]

The buffer with all the elements.

Definition at line 326 of file Generic_Sequence_T.h.

Referenced by TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::generic_sequence(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::get_buffer(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::operator[](), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::swap(), and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::~generic_sequence().

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
CORBA::ULong TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length_ [private]

The current number of elements in the buffer.

Definition at line 324 of file Generic_Sequence_T.h.

Referenced by TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::generic_sequence(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::operator[](), and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::swap().

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
CORBA::ULong TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::maximum_ [private]

The maximum number of elements the buffer can contain.

Definition at line 322 of file Generic_Sequence_T.h.

Referenced by TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::generic_sequence(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::get_buffer(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::maximum(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::operator[](), and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::swap().

template<typename T, class ALLOCATION_TRAITS, class ELEMENT_TRAITS>
CORBA::Boolean TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::release_ [mutable, private]

If true then the sequence should release the buffer when it is destroyed.

Definition at line 329 of file Generic_Sequence_T.h.

Referenced by TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::get_buffer(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::length(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::release(), TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::swap(), and TAO::details::generic_sequence< T, ALLOCATION_TRAITS, ELEMENT_TRAITS >::~generic_sequence().

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