Public Member Functions
	RegDescription (bool archivedOnly_=false, ArrayMap *arrayMap=0)

	RegDescription (bool archivedOnly_, RegMapBlock *block)

	RegDescription (RegDescription &desc)

	RegDescription (const RegDescription &desc)

RegDescription &	operator= (RegDescription &desc)

RegDescription &	operator= (const RegDescription &desc)

void	clear ()

virtual	~RegDescription ()

void	initialize ()

void	reset ()

void	setTo (std::string regmap_name, std::string board_name, std::string block_name, RegAspect aspect, RegInteg integ, Coord *coord=0, unsigned n=0)

void	setTo (std::string regmap_name, std::string board_name, std::string block_name, RegAspect aspect, RegInteg integ, CoordRange &coordRange)

void	setCoord (Coord &coord)

void	setOutputMode (RegOutputMode mode)

void	output (OutputStream *stream, RegOutputMode mode)

bool	rangeIsValid (CoordRange &range)

bool	rangeIsValid (CoordRange *range)

unsigned	nEl (CoordRange *range=0)

unsigned	nByte (CoordRange *range=0)

unsigned	fastestNel ()

CoordRange	range ()

CoordRange *	getRangePtr ()

CoordAxes	axes ()

std::vector< Range< unsigned > >	getElementRanges (CoordRange *range=0)

std::vector< Range< unsigned > >	getSlotRanges (CoordRange *range=0)

std::vector< Range< unsigned > >	getByteRanges (CoordRange *range=0)

unsigned	nSlot (CoordRange *range=0)

int	startSlot (CoordRange *range=0)

int	stopSlot (CoordRange *range=0)

int	iSlot ()

int	iRegMap ()

int	iBoard ()

int	iBlock ()

ArrRegMap *	regMap ()

RegAspect	aspect ()

std::string	aspectName ()

void	setAspect (RegAspect aspect)

RegInteg	integ ()

std::string	integName ()

void	setInteg (RegInteg integ)

ArrayMap *	arrayMap ()

RegMapBlock *	block ()

std::string	blockName ()

std::string	boardName ()

std::string	regMapName ()

void	begin ()

bool	isEnd ()

const RegDescription &	operator++ ()

unsigned	currentSlot ()

unsigned	currentElement ()

Coord	currentCoord ()

bool	contains (RegDescription &desc)

long	oldestVisible ()

bool	isFirst ()

void	setFirst (bool first)

void	setOldestVisible (long oldest)

void	resetOldestVisible ()

void	decreaseOldestVisible (long oldest)

void	increaseOldestVisible (long oldest)

Public Attributes
CoordAxes	axes_

Friends
class	RegParser

std::ostream &	gcp::util::operator<< (std::ostream &os, RegDescription &desc)

Constructor & Destructor Documentation

RegDescription::RegDescription	(	bool	archivedOnly = `false`,
		ArrayMap *	arrayMap = `0`
	)

Constructor.

....................................................................... Constructor.

RegDescription::RegDescription	(	bool	archivedOnly,
		RegMapBlock *	block
	)

Constructor.

....................................................................... Constructor.

RegDescription::RegDescription ( RegDescription & desc )

Copy constructor

....................................................................... Copy constructor.

RegDescription::RegDescription ( const RegDescription & desc )

....................................................................... Copy constructor.

RegDescription::~RegDescription ( )

virtual

Destructor.

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

Member Function Documentation

CoordAxes gcp::util::RegDescription::axes ( )

inline

Return the axes

void RegDescription::begin ( )

Begin an iteration on this registers selected indices

......................................................................., Begin an iteration

RegMapBlock * RegDescription::block ( )

....................................................................... Return the block descriptor associated with this register

std::string RegDescription::blockName ( )

....................................................................... Return the block descriptor associated with this register

std::string RegDescription::boardName ( )

....................................................................... Return the board descriptor associated with this register

void RegDescription::clear ( )

Delete dynamic contents

Coord RegDescription::currentCoord ( )

Return the coordinate corresponding to the current element

....................................................................... Re-set the coordinate for this container

unsigned RegDescription::currentElement ( )

Return the current element

....................................................................... Return the current element

unsigned RegDescription::currentSlot ( )

Return the archive slot corresponding to the current element

....................................................................... Return the archive slot corresponding to the current element

unsigned RegDescription::fastestNel ( )

Return the number of elements in the fastest-changing dimension of this coordinate

vector< Range< unsigned > > RegDescription::getByteRanges ( CoordRange * coordRange = 0 )

Return a vector of byte ranges in the array map associated with this register description

....................................................................... Return a vector of byte ranges associated with this register description

vector< Range< unsigned > > RegDescription::getElementRanges ( CoordRange * range = 0 )

Return a vector of element ranges associated with this register description

....................................................................... Return a vector of element ranges associated with this register description

CoordRange* gcp::util::RegDescription::getRangePtr ( )

inline

Return the range

vector< Range< unsigned > > RegDescription::getSlotRanges ( CoordRange * range = 0 )

Return a vector of slot ranges in the array map associated with this register description

....................................................................... Return a vector of slot ranges associated with this register description

void RegDescription::initialize ( void )

Initialize class members

bool RegDescription::isEnd ( )

Check if we are at the end of our iteration

......................................................................., Return true if we are at the end of an iteration

int gcp::util::RegDescription::iSlot ( )

inline

Return the slot offset of this register in the array map

unsigned RegDescription::nByte ( CoordRange * range = 0 )

....................................................................... Return the total number of elements covered by the register in this object

unsigned RegDescription::nEl ( CoordRange * range = 0 )

Return the total number of elements covered by the register in this object

....................................................................... Return the total number of elements covered by the register in this object

unsigned RegDescription::nSlot ( CoordRange * range = 0 )

Return the total number of slots covered by this register

....................................................................... Return the total number of elements covered by the register in this object

const RegDescription & RegDescription::operator++ ( )

Prefix increment operator

....................................................................... Increment this object

RegDescription & RegDescription::operator= ( RegDescription & desc )

Assignment operator

void RegDescription::output	(	OutputStream *	stream,
		RegOutputMode	mode
	)

Old-style: write this register onto an output stream

....................................................................... Old-style: write this register onto an output stream

CoordRange gcp::util::RegDescription::range ( )

inline

Return the range

bool RegDescription::rangeIsValid ( CoordRange & range )

Check if a range is consistent with the axes in this register

....................................................................... Check if a range is consistent with the axes in this register

bool RegDescription::rangeIsValid ( CoordRange * range )

....................................................................... Check if a range is consistent with the axes in this register

ArrRegMap * RegDescription::regMap ( )

....................................................................... Return the regmap descriptor associated with this register

std::string RegDescription::regMapName ( )

....................................................................... Return the regmap descriptor associated with this register

void RegDescription::reset ( )

Reset members which should not be reused

....................................................................... Reset members which should not be reused

void RegDescription::setCoord ( Coord & coord )

Set a new coordinate for this description

....................................................................... Re-set the coordinate for this container

void RegDescription::setOutputMode ( RegOutputMode mode )

Set the output mode

....................................................................... Set the output mode of a register specification

void gcp::util::RegDescription::setTo	(	std::string	regmap_name,
		std::string	board_name,
		std::string	block_name,
		RegAspect	aspect,
		RegInteg	integ,
		Coord *	coord = `0`,
		unsigned	n = `0`
	)

Fill in with details of the specified register, with starting element specified by coord, and number of elements from the start given by n.

int RegDescription::startSlot ( CoordRange * range = 0 )

Return the start/stop slot in the array map corresponding to the passed range, or to the range in this descriptor if range==0

....................................................................... Return the start slot of this range in the array map

int RegDescription::stopSlot ( CoordRange * range = 0 )

....................................................................... Return the stop slot of this range in the array map

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

gcpCbass/util/common/RegDescription.h
gcpCbass/util/common/RegDescription.cc

Public Member Functions

Public Attributes

Friends

Constructor & Destructor Documentation

Member Function Documentation