My Project
 All Classes Files Functions Variables Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
gcp::util::RegCoord Class Reference

#include <RegCoord.h>

Public Member Functions

 RegCoord ()
 
 RegCoord (RegCoord *coord)
 
 RegCoord (unsigned ind1)
 
 RegCoord (unsigned ind1, unsigned ind2)
 
 RegCoord (unsigned ind1, unsigned ind2, unsigned ind3)
 
virtual ~RegCoord ()
 
void setIndex (unsigned nAxis, unsigned index)
 
void reset (unsigned nAxis=1)
 
unsigned nAxis ()
 
unsigned int getIndex (unsigned iAxis)
 

Detailed Description

A class for specifying a coordinate in a multi-dimensional space. Supports up to three dimensions at the moment.

Constructor & Destructor Documentation

RegCoord::RegCoord ( )

Constructors.

....................................................................... Constructors.

RegCoord::~RegCoord ( )
virtual

Destructor.

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

Member Function Documentation

unsigned int RegCoord::getIndex ( unsigned  iAxis)

Return the coordinate index for axis iAxis

....................................................................... Return the coordinate index for axis iAxis

unsigned RegCoord::nAxis ( )

Return the number of axes in this coordinate nTuplet.

....................................................................... Return the number of axes in this coordinate nTuplet.

void RegCoord::reset ( unsigned  nAxis = 1)

Reset the coordinate ntuplet

....................................................................... Reset the coordinate ntuplet

void RegCoord::setIndex ( unsigned  iAxis,
unsigned  index 
)

Set the coordinate index of the requested axis

....................................................................... Set the coordinate index of the requested axis

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