User Manual, Developers Guide and API Documentation

wns::container::MultiReadWriteAccessible< T, N, R, I > Class Template Reference

Interface and base for classes which the [] operator can be applied to multiple times, allowing write and read access. More...

#include <container/MultiAccessible.hpp>

Inheritance diagram for wns::container::MultiReadWriteAccessible< T, N, R, I >:

Inheritance graph
[legend]
Collaboration diagram for wns::container::MultiReadWriteAccessible< T, N, R, I >:

Collaboration graph
[legend]

List of all members.

Public Types

typedef I IndexType
 The type of indexes in the [] operator.
typedef R ReturnType
 The return type for the operator [] in the first Dimension.
typedef
MultiAccessibleDefs::SizeType 
SizeType
 The type for sizes used in this class.
typedef T ValueType
 The type of the values that are accessed.

Public Member Functions

virtual SizeType dimSize (const SizeType &dim) const =0
 Get the size of a dimension.
virtual SizeType size () const
 Get the size of the total structure.
virtual ~MultiReadWriteAccessible ()
 Destructor.


Detailed Description

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&, typename I = MultiAccessibleDefs::SizeType>
class wns::container::MultiReadWriteAccessible< T, N, R, I >

Parameters:
T Type of the values we want to access.
N Number of dimensions.
I Type of the index in the [] operator. This defaults to MultiAccessibleDefs::SizeType.
This class is a combination of MultiReadAccessible and MultiWriteAccessible.

Definition at line 363 of file MultiAccessible.hpp.


Member Typedef Documentation

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&, typename I = MultiAccessibleDefs::SizeType>
typedef I wns::container::MultiReadWriteAccessible< T, N, R, I >::IndexType

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&, typename I = MultiAccessibleDefs::SizeType>
typedef R wns::container::MultiReadWriteAccessible< T, N, R, I >::ReturnType

Reimplemented from wns::container::MultiReadAccessible< T, N, R, I >.

Definition at line 385 of file MultiAccessible.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&, typename I = MultiAccessibleDefs::SizeType>
typedef MultiAccessibleDefs::SizeType wns::container::MultiReadWriteAccessible< T, N, R, I >::SizeType

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&, typename I = MultiAccessibleDefs::SizeType>
typedef T wns::container::MultiReadWriteAccessible< T, N, R, I >::ValueType


Constructor & Destructor Documentation

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&, typename I = MultiAccessibleDefs::SizeType>
virtual wns::container::MultiReadWriteAccessible< T, N, R, I >::~MultiReadWriteAccessible (  )  [inline, virtual]

Definition at line 390 of file MultiAccessible.hpp.


Member Function Documentation

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&, typename I = MultiAccessibleDefs::SizeType>
virtual SizeType wns::container::MultiReadWriteAccessible< T, N, R, I >::dimSize ( const SizeType dim  )  const [pure virtual]

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&, typename I = MultiAccessibleDefs::SizeType>
virtual SizeType wns::container::MultiReadWriteAccessible< T, N, R, I >::size (  )  const [inline, virtual]

Returns:
dimSize(0) * dimSize(1) * ... * dimSize(N-1).

Reimplemented from wns::container::MultiReadAccessible< T, N, R, I >.

Definition at line 405 of file MultiAccessible.hpp.


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

Generated on Sat May 26 03:32:52 2012 for openWNS by  doxygen 1.5.5