My Project
 All Classes Files Functions Variables Enumerations Enumerator Friends Macros Pages
gcp::util::RegAxes Class Reference

#include <RegAxes.h>

Public Member Functions

 RegAxes ()
 
 RegAxes (unsigned nel0)
 
 RegAxes (unsigned nel0, unsigned nel1)
 
 RegAxes (RegAxes *regAxes)
 
void setAxis (unsigned nAxis, unsigned nEl)
 
virtual ~RegAxes ()
 
unsigned int nAxis ()
 
unsigned int nEl (int axis=-1)
 
unsigned int elementOffsetOf (RegCoord &coord)
 
unsigned int elementOffsetOf (RegCoord coord)
 
unsigned int refElementOffsetOf (RegCoord &coord)
 

Detailed Description

Class for managing coordinate axes.

NB: all axis specifiers should be indexed from 0

Constructor & Destructor Documentation

RegAxes::RegAxes ( )

Constructors.

....................................................................... Constructor.

RegAxes::RegAxes ( unsigned  nel0)

....................................................................... Constructor.

RegAxes::RegAxes ( unsigned  nel0,
unsigned  nel1 
)

....................................................................... Constructor.

RegAxes::RegAxes ( RegAxes regAxes)

Copy constructor

....................................................................... Copy constructor

RegAxes::~RegAxes ( )
virtual

Destructor.

....................................................................... Destructor.

Member Function Documentation

unsigned int RegAxes::elementOffsetOf ( RegCoord coord)

Return the element offset of the specified coordinate from the start of the register array

....................................................................... Return the element offset of the specified coordinate from the start of the register array

unsigned int RegAxes::elementOffsetOf ( RegCoord  coord)

Return the element offset of the specified coordinate from the start of the register array

....................................................................... Return the element offset of the specified coordinate from the start of the register array

unsigned int RegAxes::nAxis ( )

Return the number of axes

....................................................................... Return the number of axes in this register

unsigned int RegAxes::nEl ( int  axis = -1)

Return the number of elements

....................................................................... Return the number of elements in this register

unsigned int RegAxes::refElementOffsetOf ( RegCoord coord)

Return the element offset of the specified coordinate from the start of the register array

....................................................................... Return the element offset of the specified coordinate from the start of the register array

void RegAxes::setAxis ( unsigned  iAxis,
unsigned  nEl 
)

Method for setting arbitrary axes

....................................................................... Method for setting arbitrary axes


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