ACE_Array_Base< T > Class Template Reference

Implement a simple dynamic array. More...

#include <Array_Base.h>

Inheritance diagram for ACE_Array_Base< T >:

Inheritance graph
[legend]
Collaboration diagram for ACE_Array_Base< T >:

Collaboration graph
[legend]

List of all members.

Public Types

typedef T TYPE
typedef ACE_Array_Iterator< T > ITERATOR
typedef T value_type
typedef value_typeiterator
typedef value_type const * const_iterator
typedef value_typereference
typedef value_type const & const_reference
typedef value_typepointer
typedef value_type const * const_pointer
typedef ptrdiff_t difference_type
typedef ACE_Allocator::size_type size_type

Public Member Functions

ACE_DECLARE_STL_REVERSE_ITERATORS ACE_Array_Base (size_type size=0, ACE_Allocator *the_allocator=0)
 Dynamically create an uninitialized array.
 ACE_Array_Base (size_type size, T const &default_value, ACE_Allocator *the_allocator=0)
 Dynamically initialize the entire array to the <default_value>.
 ACE_Array_Base (ACE_Array_Base< T > const &s)
void operator= (ACE_Array_Base< T > const &s)
 ~ACE_Array_Base (void)
 Clean up the array (e.g., delete dynamically allocated memory).
T & operator[] (size_type slot)
T const & operator[] (size_type slot) const
int set (T const &new_item, size_type slot)
int get (T &item, size_type slot) const
size_type size (void) const
 Returns the <cur_size_> of the array.
int size (size_type new_size)
size_type max_size (void) const
 Returns the <max_size_> of the array.
int max_size (size_type new_size)
void swap (ACE_Array_Base< T > &array)
Forward Iterator Accessors
Forward iterator accessors.

iterator begin (void)
iterator end (void)
const_iterator begin (void) const
const_iterator end (void) const
Reverse Iterator Accessors
Reverse iterator accessors.

reverse_iterator rbegin (void)
reverse_iterator rend (void)
const_reverse_iterator rbegin (void) const
const_reverse_iterator rend (void) const

Protected Member Functions

bool in_range (size_type slot) const

Protected Attributes

size_type max_size_
size_type cur_size_
value_typearray_
 Pointer to the array's storage buffer.
ACE_Allocatorallocator_
 Allocation strategy of the ACE_Array_Base.

Friends

class ACE_Array_Iterator< T >


Detailed Description

template<class T>
class ACE_Array_Base< T >

Implement a simple dynamic array.

This parametric class implements a simple dynamic array; resizing must be controlled by the user. No comparison or find operations are implemented.


Member Typedef Documentation

template<class T>
typedef T ACE_Array_Base< T >::TYPE

template<class T>
typedef ACE_Array_Iterator<T> ACE_Array_Base< T >::ITERATOR

template<class T>
typedef T ACE_Array_Base< T >::value_type

template<class T>
typedef value_type* ACE_Array_Base< T >::iterator

template<class T>
typedef value_type const* ACE_Array_Base< T >::const_iterator

template<class T>
typedef value_type& ACE_Array_Base< T >::reference

template<class T>
typedef value_type const& ACE_Array_Base< T >::const_reference

template<class T>
typedef value_type* ACE_Array_Base< T >::pointer

template<class T>
typedef value_type const* ACE_Array_Base< T >::const_pointer

template<class T>
typedef ptrdiff_t ACE_Array_Base< T >::difference_type

template<class T>
typedef ACE_Allocator::size_type ACE_Array_Base< T >::size_type


Constructor & Destructor Documentation

template<class T>
ACE_DECLARE_STL_REVERSE_ITERATORS ACE_Array_Base< T >::ACE_Array_Base ( size_type  size = 0,
ACE_Allocator the_allocator = 0 
)

Dynamically create an uninitialized array.

template<class T>
ACE_Array_Base< T >::ACE_Array_Base ( size_type  size,
T const &  default_value,
ACE_Allocator the_allocator = 0 
)

Dynamically initialize the entire array to the <default_value>.

template<class T>
ACE_Array_Base< T >::ACE_Array_Base ( ACE_Array_Base< T > const &  s  )  [inline]

The copy constructor performs initialization by making an exact copy of the contents of parameter <s>, i.e., *this == s will return true.

template<class T>
ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE ACE_Array_Base< T >::~ACE_Array_Base ( void   )  [inline]

Clean up the array (e.g., delete dynamically allocated memory).


Member Function Documentation

template<class T>
void ACE_Array_Base< T >::operator= ( ACE_Array_Base< T > const &  s  )  [inline]

Assignment operator performs an assignment by making an exact copy of the contents of parameter <s>, i.e., *this == s will return true. Note that if the <max_size_> of <array_> is >= than <s.max_size_> we can copy it without reallocating. However, if <max_size_> is < <s.max_size_> we must delete the <array_>, reallocate a new <array_>, and then copy the contents of <s>.

template<class T>
T& ACE_Array_Base< T >::operator[] ( size_type  slot  ) 

Set item in the array at location slot. Doesn't perform range checking.

template<class T>
T const& ACE_Array_Base< T >::operator[] ( size_type  slot  )  const

Get item in the array at location slot. Doesn't perform range checking.

template<class T>
int ACE_Array_Base< T >::set ( T const &  new_item,
size_type  slot 
)

Set an item in the array at location slot. Returns -1 if slot is not in range, else returns 0.

template<class T>
int ACE_Array_Base< T >::get ( T &  item,
size_type  slot 
) const

Get an item in the array at location slot. Returns -1 if slot is not in range, else returns 0. Note that this function copies the item. If you want to avoid the copy, you can use the const operator [], but then you'll be responsible for range checking.

template<class T>
ACE_INLINE ACE_Array_Base< T >::size_type ACE_Array_Base< T >::size ( void   )  const [inline]

Returns the <cur_size_> of the array.

Reimplemented in ACE_Vector< T, DEFAULT_SIZE >.

template<class T>
int ACE_Array_Base< T >::size ( size_type  new_size  ) 

Changes the size of the array to match <new_size>. It copies the old contents into the new array. Return -1 on failure.

template<class T>
ACE_INLINE ACE_Array_Base< T >::size_type ACE_Array_Base< T >::max_size ( void   )  const [inline]

Returns the <max_size_> of the array.

template<class T>
int ACE_Array_Base< T >::max_size ( size_type  new_size  ) 

Changes the size of the array to match <new_size>. It copies the old contents into the new array. Return -1 on failure. It does not affect new_size

template<class T>
ACE_INLINE ACE_Array_Base< T >::iterator ACE_Array_Base< T >::begin ( void   )  [inline]

template<class T>
ACE_INLINE ACE_Array_Base< T >::iterator ACE_Array_Base< T >::end ( void   )  [inline]

template<class T>
ACE_INLINE ACE_Array_Base< T >::const_iterator ACE_Array_Base< T >::begin ( void   )  const [inline]

template<class T>
ACE_INLINE ACE_Array_Base< T >::const_iterator ACE_Array_Base< T >::end ( void   )  const [inline]

template<class T>
ACE_INLINE ACE_Array_Base< T >::reverse_iterator ACE_Array_Base< T >::rbegin ( void   )  [inline]

template<class T>
ACE_INLINE ACE_Array_Base< T >::reverse_iterator ACE_Array_Base< T >::rend ( void   )  [inline]

template<class T>
ACE_INLINE ACE_Array_Base< T >::const_reverse_iterator ACE_Array_Base< T >::rbegin ( void   )  const [inline]

template<class T>
ACE_INLINE ACE_Array_Base< T >::const_reverse_iterator ACE_Array_Base< T >::rend ( void   )  const [inline]

template<class T>
void ACE_Array_Base< T >::swap ( ACE_Array_Base< T > &  array  )  [inline]

Swap the contents of this array with the given array in an exception-safe manner.

template<class T>
bool ACE_Array_Base< T >::in_range ( size_type  slot  )  const [protected]

Returns 1 if slot is within range, i.e., 0 >= slot < <cur_size_>, else returns 0.


Friends And Related Function Documentation

template<class T>
friend class ACE_Array_Iterator< T > [friend]


Member Data Documentation

template<class T>
size_type ACE_Array_Base< T >::max_size_ [protected]

Maximum size of the array, i.e., the total number of <T> elements in <array_>.

template<class T>
size_type ACE_Array_Base< T >::cur_size_ [protected]

Current size of the array. This starts out being == to <max_size_>. However, if we are assigned a smaller array, then <cur_size_> will become less than <max_size_>. The purpose of keeping track of both sizes is to avoid reallocating memory if we don't have to.

template<class T>
value_type* ACE_Array_Base< T >::array_ [protected]

Pointer to the array's storage buffer.

template<class T>
ACE_Allocator* ACE_Array_Base< T >::allocator_ [protected]

Allocation strategy of the ACE_Array_Base.


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

Generated on Wed Apr 23 02:37:58 2008 for ACE by  doxygen 1.5.5