gcp::util::RegParser Class Reference

Public Member Functions
	RegParser (bool archivedOnly_=false)
virtual	~RegParser ()
std::vector< RegDescription >	inputRegs (std::string regStr, RegInputMode mode=REG_INPUT_RANGE, bool tell=true, bool extend=true, bool splitIndices=false)
std::vector< RegDescription >	inputRegs (std::string regStr, ArrayMap *arrayMap, RegInputMode mode, bool tell, bool extend, bool splitIndices=false, bool doThrow=true)
std::vector< RegDescription >	inputRegs (InputStream *stream, bool tell, ArrayMap *arraymap, RegInputMode mode, bool extend, bool splitIndices=false, bool doThrow=true)
RegDescription	inputReg (std::string regStr, RegInputMode mode=REG_INPUT_RANGE, bool tell=true, bool extend=true)
RegDescription	inputReg (InputStream *stream, bool tell, RegInputMode mode, bool extend, ArrayMap *arraymap=0)
RegValidity	validity ()

Static Public Member Functions
static unsigned	getSize (RegMapBlock *block, RegAspect aspect, bool extend)

Constructor & Destructor Documentation

RegParser::RegParser

(

bool

archivedOnly = false

)

Constructor.

If archivedOnly = true, byte offset calculations, etc. will be done wrt the archived array map. If false, they will be done wrt the whole array map.

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

RegParser::~RegParser ( )

virtual

Destructor.

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

Member Function Documentation

unsigned RegParser::getSize ( RegMapBlock *  block, RegAspect  aspect, bool  extend  )

static

Return the size in slots of each register element

....................................................................... Return the size in slots of each register element

RegDescription RegParser::inputReg	(	std::string	regStr,
		RegInputMode	mode = REG_INPUT_RANGE,
		bool	tell = true,
		bool	extend = true
	)

Parse a single register block description

....................................................................... Convenience method that uses an internal arraymap and constructs the stream for an input string.

RegDescription RegParser::inputReg	(	InputStream *	stream,
		bool	tell,
		RegInputMode	mode,
		bool	extend,
		ArrayMap *	arrayMap = 0
	)

Parse a single register block description

....................................................................... Parse a single reg

vector< RegDescription > RegParser::inputRegs	(	std::string	regStr,
		RegInputMode	mode = REG_INPUT_RANGE,
		bool	tell = true,
		bool	extend = true,
		bool	split = false
	)

Parse a register block description

....................................................................... Convenience method that uses internal arraymap and constructs the stream for an input string.

vector< RegDescription > RegParser::inputRegs	(	std::string	regStr,
		ArrayMap *	arrayMap,
		RegInputMode	mode,
		bool	tell,
		bool	extend,
		bool	split = false,
		bool	doThrow = true
	)

Convenience method that uses external arraymap and constructs the stream for an input string.

....................................................................... Convenience method that uses external arraymap and constructs the stream for an input string.

std::vector< RegDescription > RegParser::inputRegs	(	InputStream *	stream,
		bool	tell,
		ArrayMap *	arraymap,
		RegInputMode	mode,
		bool	extend,
		bool	splitIndices = false,
		bool	doThrow = true
	)

Parse a register block description.

If splitIndices = true, and multiple indices are specified for all but the fastest-changing index, this will return separate descriptors for each index specified. ie:

receiver.bolometers.ac[0-3][0-99]

would return 4 descriptors instead of one.

RegValidity gcp::util::RegParser::validity ( )

inline

Return the validity flag for the last register read

---

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

• gcpCbass/util/common/RegParser.h
• gcpCbass/util/common/RegParser.cc