ArrayMap Struct Reference

Public Member Functions
	ArrayMap (void *vtmp, bool addDefaults=true)
	~ArrayMap ()
int	byteOffsetInArcArrayMapOf (std::string regmap, std::string board, std::string block, gcp::util::Coord *coord=0)
int	byteOffsetInWholeArrayMapOf (std::string regmap, std::string board, std::string block, gcp::util::Coord *coord=0)
int	byteOffsetOf (bool archivedOnly, std::string regmap, std::string board, std::string block, gcp::util::Coord *coord=0)
int	byteOffsetInArcArrayMapOf (ArrRegMap *aregmap, RegMapBlock *block, gcp::util::Coord *coord=0)
int	byteOffsetInWholeArrayMapOf (ArrRegMap *aregmap, RegMapBlock *block, gcp::util::Coord *coord=0)
int	byteOffsetOf (bool archivedOnly, ArrRegMap *aregmap, RegMapBlock *block, gcp::util::Coord *coord=0)
int	slotOffsetInArcArrayMapOf (ArrRegMap *aregmap, RegMapBlock *block, gcp::util::Coord *coord=0)
int	slotOffsetInWholeArrayMapOf (ArrRegMap *aregmap, RegMapBlock *block, gcp::util::Coord *coord=0)
int	slotOffsetOf (bool archivedOnly, ArrRegMap *aregmap, RegMapBlock *block, gcp::util::Coord *coord=0)
int	slotOffsetInArcArrayMapOf (std::string regmap, std::string board, std::string block, gcp::util::Coord *coord=0)
int	slotOffsetInWholeArrayMapOf (std::string regmap, std::string board, std::string block, gcp::util::Coord *coord=0)
int	slotOffsetOf (bool archivedOnly, std::string regmap, std::string board, std::string block, gcp::util::Coord *coord=0)
int	nByte (bool archivedOnly)
int	nReg (bool archivedOnly)
RegMapBlock *	findArrayMapBlock (std::string regmap_name, std::string board_name, std::string block_name, bool doThrow=false)
RegMapBoard *	findArrayMapBoard (std::string regmap_name, std::string board_name, bool doThrow=false)
RegMap *	findRegMap (std::string regmap_name, bool doThrow=false)
ArrRegMap *	findArrRegMap (RegMap *regmapPtr)
ArrRegMap *	findArrRegMap (std::string regmapName)
std::vector< ArrRegMap * >	matchArrRegMap (std::string regExpString)
void	print (bool archivedOnly)
std::vector< std::string >	getRegisters (bool archivedOnly)

Public Attributes
unsigned	ref_count
std::vector< ArrRegMap * >	regmaps
int	nregmap
HashTable *	hash
HashMemory *	hash_mem
unsigned	nreg
unsigned	narchive
unsigned	nByte_
unsigned	nArcByte_

Constructor & Destructor Documentation

ArrayMap::ArrayMap	(	void *	vtmp,
		bool	addDefaults = true
	)

....................................................................... Create a map of available register maps

Input: arrayTmp ArrayTemplate * The template for creating the array map Output: return ArrayMap * The new array map.

ArrayMap::~ArrayMap

(

)

....................................................................... Destructor for ArrayMap

Member Function Documentation

int ArrayMap::byteOffsetInArcArrayMapOf	(	ArrRegMap *	aregmap,
		RegMapBlock *	block,
		gcp::util::Coord *	coord = 0
	)

....................................................................... Return the offset, in bytes_ of the named register, board and block from the start of the archived array

int ArrayMap::byteOffsetInWholeArrayMapOf	(	ArrRegMap *	aregmap,
		RegMapBlock *	block,
		gcp::util::Coord *	coord = 0
	)

....................................................................... Return the offset, in bytes_ of the named board and block from the start of the archived array

RegMapBlock * ArrayMap::findArrayMapBlock	(	std::string	regmap_name,
		std::string	board_name,
		std::string	block_name,
		bool	doThrow = false
	)

....................................................................... Find the named block. If doThrow is true, throw an error if the register wasn't found.

RegMapBoard * ArrayMap::findArrayMapBoard	(	std::string	regmap_name,
		std::string	board_name,
		bool	doThrow = false
	)

....................................................................... Find the named board. If doThrow is true, throw an error if the register wasn't found.

ArrRegMap * ArrayMap::findArrRegMap

(

RegMap *

regmap

)

....................................................................... Find the named register map. If doThrow is true, throw an error if the register wasn't found.

RegMap * ArrayMap::findRegMap	(	std::string	regmap_name,
		bool	doThrow = false
	)

....................................................................... Find the named register map. If doThrow is true, throw an error if the register wasn't found.

std::vector< ArrRegMap * > ArrayMap::matchArrRegMap

(

std::string

regExpString

)

....................................................................... Lookup a named register map from a given array map

Input: arraymap ArrayMap * The array map to lookup the register map from. remgap_name char * The name of the register map Output: return RegMap * The named register map (see regmap.h), or NULL if not

int ArrayMap::slotOffsetInArcArrayMapOf	(	ArrRegMap *	aregmap,
		RegMapBlock *	block,
		gcp::util::Coord *	coord = 0
	)

....................................................................... Return the offset, in slots_ of the named board and block from the start of the archived array

int ArrayMap::slotOffsetInWholeArrayMapOf	(	ArrRegMap *	aregmap,
		RegMapBlock *	block,
		gcp::util::Coord *	coord = 0
	)

....................................................................... Return the offset, in slots_ of the named board and block from the start of the archived array

---

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

• gcpCbass/control/code/unix/libunix_src/common/arraymap.h
• gcpCbass/control/code/unix/libunix_src/common/arraymap.c