sza::util::RegCoord Class Reference

A class for specifying a coordinate in a multi-dimensional space. More...

#include <carma/szautil/RegCoord.h>

Public Member Functions
unsigned int	getIndex (unsigned iAxis)
	Return the coordinate index for axis iAxis. More...
unsigned	nAxis ()
	Return the number of axes in this coordinate nTuplet. More...
	RegCoord ()
	Constructors. More...
	RegCoord (RegCoord *coord)
	RegCoord (unsigned ind1)
	RegCoord (unsigned ind1, unsigned ind2)
	RegCoord (unsigned ind1, unsigned ind2, unsigned ind3)
void	reset (unsigned nAxis=1)
	Reset the coordinate ntuplet. More...
void	setIndex (unsigned nAxis, unsigned index)
	Set the coordinate index of the requested axis. More...
virtual	~RegCoord ()
	Destructor. More...

Detailed Description

A class for specifying a coordinate in a multi-dimensional space.

Supports up to three dimensions at the moment.

Definition at line 20 of file RegCoord.h.

Constructor & Destructor Documentation

sza::util::RegCoord::RegCoord

(

)

Constructors.

virtual sza::util::RegCoord::~RegCoord ( )

virtual

Destructor.

Member Function Documentation

unsigned int sza::util::RegCoord::getIndex

(

unsigned

iAxis

)

Return the coordinate index for axis iAxis.

unsigned sza::util::RegCoord::nAxis

(

)

Return the number of axes in this coordinate nTuplet.

void sza::util::RegCoord::reset

(

unsigned

nAxis = 1

)

Reset the coordinate ntuplet.

void sza::util::RegCoord::setIndex	(	unsigned	nAxis,
		unsigned	index
	)

Set the coordinate index of the requested axis.

---

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

• carma/szautil/RegCoord.h