CARMA C++
sza::util::RegAxes Class Reference

Class for managing coordinate axes. More...

#include <carma/szautil/RegAxes.h>

Public Member Functions

unsigned int elementOffsetOf (RegCoord &coord)
 Return the element offset of the specified coordinate from the start of the register array. More...
 
unsigned int elementOffsetOf (RegCoord coord)
 Return the element offset of the specified coordinate from the start of the register array. More...
 
unsigned int nAxis ()
 Return the number of axes. More...
 
unsigned int nEl (int axis=-1)
 Return the number of elements. More...
 
unsigned int refElementOffsetOf (RegCoord &coord)
 Return the element offset of the specified coordinate from the start of the register array. More...
 
 RegAxes ()
 Constructors. More...
 
 RegAxes (unsigned nel0)
 
 RegAxes (unsigned nel0, unsigned nel1)
 
 RegAxes (RegAxes *regAxes)
 Copy constructor. More...
 
void setAxis (unsigned nAxis, unsigned nEl)
 Method for setting arbitrary axes. More...
 
virtual ~RegAxes ()
 Destructor. More...
 

Detailed Description

Class for managing coordinate axes.

NB: all axis specifiers should be indexed from 0

Definition at line 23 of file RegAxes.h.

Constructor & Destructor Documentation

sza::util::RegAxes::RegAxes ( )

Constructors.

sza::util::RegAxes::RegAxes ( RegAxes regAxes)

Copy constructor.

virtual sza::util::RegAxes::~RegAxes ( )
virtual

Destructor.

Member Function Documentation

unsigned int sza::util::RegAxes::elementOffsetOf ( RegCoord coord)

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

unsigned int sza::util::RegAxes::elementOffsetOf ( RegCoord  coord)

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

unsigned int sza::util::RegAxes::nAxis ( )

Return the number of axes.

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

Return the number of elements.

unsigned int sza::util::RegAxes::refElementOffsetOf ( RegCoord coord)

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

void sza::util::RegAxes::setAxis ( unsigned  nAxis,
unsigned  nEl 
)

Method for setting arbitrary axes.


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