XSI::CDataArray2D::Accessor

CDataArray2D::Accessor Class Reference

A class for accessing the sub-array data of CDataArray2D objects. More...

#include <xsi_dataarray2D.h>

List of all members.

Public Member Functions
  Accessor ()
  Accessor (const Accessor &in_accessor)
Accessor &  operator= (const Accessor &in_accessor)
ULONG  GetCount () const
const T &  operator[] (ULONG in_index) const
T &  operator[] (ULONG in_index)

Detailed Description

template<class T>
class XSI::CDataArray2D< T >::Accessor

A class for accessing the sub-array data of CDataArray2D objects.

Since:
7.0
See also:
CIndexSet, CDataArray, CDataArray2D

Constructor & Destructor Documentation

Accessor (  )  [inline]

Constructor.

Accessor ( const Accessor &  in_accessor  )  [inline]

Constructs an Accessor object from another Accessor object.

Parameters:
in_accessor  constant Accessor object.

Member Function Documentation

Accessor& operator= ( const Accessor &  in_accessor  )  [inline]

Assignment operator.

Parameters:
in_accessor  constant class object.
Returns:
A reference to this Accessor.

ULONG GetCount ( void   )  const [inline]

Returns the number of elements in the array.

Returns:
Number of elements.

const T& operator[] ( ULONG  in_index  )  const [inline]

Accessor to elements at a given index. This operator is called when reading the data so the return value is read-only.

Parameters:
in_index  Index in the array. The index must be smaller than the number of elements in the array, otherwise the results are unpredicted.
Returns:
A read-only reference to the indexed item.

T& operator[] ( ULONG  in_index  )  [inline]

Accessor to elements at a given index.

Parameters:
in_index  Index in this zero-based array. The index must be smaller than the number of elements in the array, otherwise the results are unpredicted.
Returns:
A reference to the indexed item.

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