OnixS C++ CME MDP Conflated UDP Handler  1.1.2
API documentation
Public Types | Public Member Functions | List of all members
VectorOverArray< ItemType, SizeType > Class Template Reference

#include <OnixS/CME/ConflatedUDP/VectorOverArray.h>

Public Types

typedef ItemType Item
 
typedef SizeType Size
 
typedef const Item * ConstIterator
 
typedef Item * Iterator
 

Public Member Functions

 VectorOverArray ()
 
 VectorOverArray (Item *items, Size capacity)
 
 ~VectorOverArray ()
 
bool empty () const
 
Size size () const
 
Size capacity () const
 
Iterator begin ()
 
ConstIterator begin () const
 
Iterator end ()
 
ConstIterator end () const
 
Item & front ()
 
const Item & front () const
 
Item & operator[] (Size index)
 
const Item & operator[] (Size index) const
 
Item & at (Size index)
 
const Item & at (Size index) const
 
Item & insertExtrude (Size index)
 
void erase (Size index)
 
void resize (Size newSize, const Item &item=Item())
 

Detailed Description

template<typename ItemType, typename SizeType>
class OnixS::CME::ConflatedUDP::VectorOverArray< ItemType, SizeType >

Implements vector-like container over built-in array of fixed size being referenced.

Definition at line 40 of file VectorOverArray.h.

Member Typedef Documentation

typedef const Item* ConstIterator

Aliases constant iterator type.

Definition at line 50 of file VectorOverArray.h.

typedef ItemType Item

Aliases container item type.

Definition at line 44 of file VectorOverArray.h.

typedef Item* Iterator

Aliases mutable iterator type.

Definition at line 53 of file VectorOverArray.h.

typedef SizeType Size

Aliases dimension type.

Definition at line 47 of file VectorOverArray.h.

Constructor & Destructor Documentation

VectorOverArray ( )
inline

Initializes instance with no items.

Definition at line 56 of file VectorOverArray.h.

VectorOverArray ( Item *  items,
Size  capacity 
)
inline

Initializes instance over given fixed-size array.

Definition at line 64 of file VectorOverArray.h.

~VectorOverArray ( )
inline

Cleans everything up.

Definition at line 74 of file VectorOverArray.h.

Member Function Documentation

Item& at ( Size  index)
inline

Accesses to item by index checking access bounds.

Definition at line 169 of file VectorOverArray.h.

const Item& at ( Size  index) const
inline

Accesses to item by index checking access bounds.

Definition at line 184 of file VectorOverArray.h.

Iterator begin ( )
inline

Iterator referencing to the first item.

Definition at line 102 of file VectorOverArray.h.

ConstIterator begin ( ) const
inline

Iterator referencing to the first item.

Definition at line 109 of file VectorOverArray.h.

Size capacity ( ) const
inline

Total capacity of container.

Definition at line 95 of file VectorOverArray.h.

bool empty ( ) const
inline

Indicates whether instance has no items.

Definition at line 81 of file VectorOverArray.h.

Iterator end ( )
inline

Iterator referencing to the item behind the last item.

Definition at line 116 of file VectorOverArray.h.

ConstIterator end ( ) const
inline

Iterator referencing to the item behind the last item.

Definition at line 123 of file VectorOverArray.h.

void erase ( Size  index)
inline

Erases item at given position.

Definition at line 225 of file VectorOverArray.h.

Item& front ( )
inline

Provides access to the front item if available.

Definition at line 130 of file VectorOverArray.h.

const Item& front ( ) const
inline

Provides access to the front item if available.

Definition at line 139 of file VectorOverArray.h.

Item& insertExtrude ( Size  index)
inline

Inserts new item to given position. Items under higher indices are moved back. Last item is extruded thus keeping size of or container constant.

Returns
Reference to an item at requested position for further update.

Definition at line 204 of file VectorOverArray.h.

Item& operator[] ( Size  index)
inline

Accesses to item by index.

Definition at line 148 of file VectorOverArray.h.

const Item& operator[] ( Size  index) const
inline

Accesses to item by index.

Definition at line 158 of file VectorOverArray.h.

void resize ( Size  newSize,
const Item &  item = Item() 
)
inline

Resizes container.

If vector is enlarged, new items constructed as copies of given instance.

Definition at line 253 of file VectorOverArray.h.

Size size ( ) const
inline

Number of items.

Definition at line 88 of file VectorOverArray.h.

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