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

A class for iterating over slot ranges specified in a CoordRange object. More...

#include <carma/szautil/RegAxisRange.h>

Inherits sza::util::AxisRange.

Public Member Functions

CoordRange currentCoordRange ()
 Return the (singleton) coordinate range corresponding to the current element. More...
 
int currentSlot ()
 Return the current element. More...
 
 RegAxisRange (RegDescription &reg, CoordRange &range)
 Constructor. More...
 
 RegAxisRange (RegDescription &reg, CoordRange *range=0)
 
 RegAxisRange (RegMapBlock *block)
 
void setTo (RegDescription &reg, CoordRange *range)
 
virtual ~RegAxisRange ()
 Destructor. More...
 
- Public Member Functions inherited from sza::util::AxisRange
 AxisRange (CoordAxes axes, CoordRange range)
 Constructor. More...
 
 AxisRange (CoordAxes &axes, CoordRange *range=0)
 
 AxisRange (CoordAxes *axes, CoordRange *range=0)
 
 AxisRange (RegMapBlock *block, CoordRange *range=0)
 
 AxisRange (unsigned nEl)
 Constructor for a simplistic axis conisting of nEl consecutive elements. More...
 
Coord currentCoord ()
 Return the current coordinate. More...
 
unsigned currentElement ()
 Return the current element. More...
 
unsigned currentIterator ()
 Return the current iterator. More...
 
bool isEnd ()
 Return true if we are at the end of our range. More...
 
unsigned nEl ()
 
const AxisRange & operator++ ()
 Prefix increment operator. More...
 
void reset ()
 Reset all iterators. More...
 
void setTo (CoordAxes *axes, CoordRange *range)
 Set the axis range. More...
 
void setTo (unsigned nEl)
 
void setToDc (CoordAxes *axes, CoordRange *range)
 
virtual ~AxisRange ()
 Destructor. More...
 

Friends

std::ostream & operator<< (std::ostream &os, RegAxisRange &range)
 Allows cout << RegAxisRange. More...
 

Detailed Description

A class for iterating over slot ranges specified in a CoordRange object.

Definition at line 27 of file RegAxisRange.h.

Constructor & Destructor Documentation

sza::util::RegAxisRange::RegAxisRange ( RegDescription &  reg,
CoordRange &  range 
)

Constructor.

virtual sza::util::RegAxisRange::~RegAxisRange ( )
virtual

Destructor.

Member Function Documentation

CoordRange sza::util::RegAxisRange::currentCoordRange ( )

Return the (singleton) coordinate range corresponding to the current element.

int sza::util::RegAxisRange::currentSlot ( )

Return the current element.

Definition at line 48 of file RegAxisRange.h.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
RegAxisRange range 
)
friend

Allows cout << RegAxisRange.


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