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

A class for managing ranges of byte indices corresponding to registers in a register map. More...

#include <carma/szautil/RegRange.h>

Public Member Functions

ArrRegMap * currentArrRegMap ()
 Get a pointer to the current register map. More...
 
RegMapBlock * currentBlock ()
 Get a pointer to the current block. More...
 
unsigned currentByteOffset ()
 Get the current byte offset. More...
 
unsigned currentEl ()
 Get the current element. More...
 
int currentSlot ()
 Get the current slot in the register map. More...
 
void increment ()
 Increments to the next register element, regardless of whether or not it belongs to the version of the array map managed by this class. More...
 
bool isEnd ()
 Return true if we are at the end of our range. More...
 
const RegRangeoperator++ ()
 Prefix increment operator. More...
 
 RegRange (unsigned iByteStart, unsigned iByteStop, bool archivedOnly=false, ArrayMap *arrayMap=0)
 Constructor. More...
 
void reset ()
 Reset all iterators. More...
 
virtual ~RegRange ()
 Destructor. More...
 

Friends

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

Detailed Description

A class for managing ranges of byte indices corresponding to registers in a register map.

Definition at line 24 of file RegRange.h.

Constructor & Destructor Documentation

sza::util::RegRange::RegRange ( unsigned  iByteStart,
unsigned  iByteStop,
bool  archivedOnly = false,
ArrayMap *  arrayMap = 0 
)

Constructor.

virtual sza::util::RegRange::~RegRange ( )
virtual

Destructor.

Member Function Documentation

ArrRegMap* sza::util::RegRange::currentArrRegMap ( )

Get a pointer to the current register map.

RegMapBlock* sza::util::RegRange::currentBlock ( )

Get a pointer to the current block.

unsigned sza::util::RegRange::currentByteOffset ( )

Get the current byte offset.

unsigned sza::util::RegRange::currentEl ( )

Get the current element.

int sza::util::RegRange::currentSlot ( )

Get the current slot in the register map.

This is a symbolic index into a consecutive array of all register elements.

void sza::util::RegRange::increment ( )

Increments to the next register element, regardless of whether or not it belongs to the version of the array map managed by this class.

bool sza::util::RegRange::isEnd ( )

Return true if we are at the end of our range.

const RegRange& sza::util::RegRange::operator++ ( )

Prefix increment operator.

Increments to the next element which is part of the (archived or whole) array map.

void sza::util::RegRange::reset ( )

Reset all iterators.

Friends And Related Function Documentation

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

Allows cout << RegRange.


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