pMR API Documentation
Public Member Functions | List of all members
Window< T > Class Template Reference

Generic base class for Windows.

#include <window.hpp>

Public Member Functions

T & operator[] (int const index)
 Direct access specified element of the internal buffer. More...
 
T const & operator[] (int const index) const
 Direct access specified element of the internal buffer. More...
 
T & at (int const index)
 Direct access specified element of the internal buffer with bounds checking. More...
 
T const & at (int const index) const
 Direct access specified element of the internal buffer with bounds checking. More...
 
T * begin ()
 Returns an iterator to the beginning of the internal buffer. More...
 
T const * begin () const
 Returns an iterator to const to the beginning of the internal buffer. More...
 
T const * cbegin () const
 Returns an iterator to const to the beginning of the internal buffer. More...
 
T * end ()
 Returns an Iterator to the end of the internal buffer. More...
 
T const * end () const
 Returns an Iterator to to const the end of the internal buffer. More...
 
T const * cend () const
 Returns an Iterator to const to the end of the internal buffer. More...
 
T * rbegin ()
 Returns a reverse iterator to the beginning of the internal buffer. More...
 
T const * rbegin () const
 Returns a reverse iterator to const to the beginning of the internal buffer. More...
 
T const * crbegin () const
 Returns a reverse iterator to const to the beginning of the internal buffer. More...
 
T * rend ()
 Returns a reverse Iterator to the end of the internal buffer. More...
 
T const * rend () const
 Returns a reverse Iterator to to const the end of the internal buffer. More...
 
T const * crend () const
 Returns a reverse Iterator to const to the end of the internal buffer. More...
 
size_type size () const
 Returns the number of elements in the internal buffer. More...
 
bool isSame (T *const buffer, size_type const count)
 Compare current Window with specified input data. More...
 
bool isSame (size_type const count)
 Compare current Window with specified input data. More...
 

Member Function Documentation

T & at ( int const  index)
Parameters
indexPosition of element in internal buffer.
Returns
Reference to element at position index.
T const & at ( int const  index) const
Parameters
indexPosition of element in internal buffer.
Returns
Reference to const to element at position index.
T * begin ( )
Returns
Iterator to the first element of the internal buffer.
T const * begin ( ) const
Returns
Iterator to const to the first element of the internal buffer.
T const * cbegin ( ) const
Returns
Iterator to const to the first element of the internal buffer.
T const * cend ( ) const
Returns
Iterator to const to the element following the last element of the internal buffer.
T const * crbegin ( ) const
Returns
Reverse Iterator to const to the first element of the internal buffer.
T const * crend ( ) const
Returns
Reverse Iterator to const to the element following the last element of the internal buffer.
T * end ( )
Returns
Iterator to the element following the last element of the internal buffer.
T const * end ( ) const
Returns
Iterator to const to the element following the last element of the internal buffer.
bool isSame ( T *const  buffer,
size_type const  count 
)

Checks whether the current Window is the same as a Window with the specified buffer and count.

Parameters
bufferPointer to contigious send/receive buffer.
countNumber of elements of type T in buffer.
Returns
true if the Window is the same, false otherwise.
bool isSame ( size_type const  count)

Checks whether the current Window is suitable for the specified count using internal buffering.

Parameters
countNumber of elements of type T in buffer.
Returns
true if the Window is suitable, false otherwise.
T & operator[] ( int const  index)
Parameters
indexPosition of element in internal buffer.
Returns
Reference to element at position index.
T const & operator[] ( int const  index) const
Parameters
indexPosition of element in internal buffer.
Returns
Reference to const to element at position index.
T * rbegin ( )
Returns
Reverse Iterator to the first element of the internal buffer.
T const * rbegin ( ) const
Returns
Reverse Iterator to const to the first element of the internal buffer.
T * rend ( )
Returns
Reverse Iterator to the element following the last element of the internal buffer.
T const * rend ( ) const
Returns
Reverse Iterator to const to the element following the last element of the internal buffer.
pMR::size_type size ( ) const
Returns
The number of elements in the internal buffer.