gcp::util::ArchiveReader Class Reference

Classes
struct	ArchiveByteRange
struct	ArchiveFile
struct	ArchiveRegister
struct	Format

Public Types
enum	ArchiveTransposeType { NONE = 0x0, FIRST = 0x2, LAST = 0x4 }

Public Member Functions
void	initialize (bool memMap, bool convert, bool read)
	ArchiveReader (bool memMap=false, bool convert=true, bool read=false)
	ArchiveReader (std::string arcDir, std::string calFile, std::string startUtc, std::string stopUtc, bool memMap=false, bool convert=true, bool read=false)
	ArchiveReader (const ArchiveReader &objToBeCopied)
	ArchiveReader (ArchiveReader &objToBeCopied)
void	operator= (const ArchiveReader &objToBeAssigned)
void	operator= (ArchiveReader &objToBeAssigned)
virtual	~ArchiveReader ()
void	setArchiveDirectory (std::string arcDir)
void	getFileList ()
unsigned	countFrames ()
unsigned	readTimeStamps ()
void	setCalFile (std::string calFile)
void	setDates (std::string startUtc, std::string stopUtc)
bool	readNextFrame ()
bool	updateArrayMap ()
void	updateRegisterCalibration ()
void	updateRegSelection ()
void	updateRegBufPtrCache (unsigned nByteRanges)
void	readFirstArrayMap ()
void	printAddresses ()
void	printRegsSize ()
std::vector< ArchiveRegister > &	getRegs ()
std::vector< RegDescription > &	getRegDescs ()
void	addRegister (std::string regSpec)
void	addRegisterOnly (std::string regSpec)
bool	stageNextFile ()
void	resetToBeginning ()
bool	advanceFile ()
void	iterateFiles ()
void	readRegs ()
void	printRegs (std::ostringstream &os)
std::vector< RegDescription >	selectedRegs ()
std::vector< DataType::Type >	selectedFormats ()

Public Attributes
RegCal *	regCal_
std::vector< bool >	regSpecValid_
std::vector< std::string >	regSpecs_
std::vector< std::string >	formatSpecs_
std::vector< ArchiveTransposeType >	transposeTypes_
std::vector< int >	widths_
std::vector< int >	precs_
std::vector< ArchiveRegister >	regs_
std::vector< DataType::Type >	formatTypes_
std::vector< RegDescription >	regDescs_

Friends
std::ostream &	gcp::util::operator<< (std::ostream &os, ArchiveReader::ArchiveRegister &reg)
std::ostream &	operator<< (std::ostream &os, ArchiveReader &obj)

Constructor & Destructor Documentation

ArchiveReader::ArchiveReader	(	bool	memMap = false,
		bool	convert = true,
		bool	read = false
	)

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

ArchiveReader::ArchiveReader

(

const ArchiveReader &

objToBeCopied

)

Copy Constructor.

....................................................................... Const Copy Constructor.

ArchiveReader::ArchiveReader

(

ArchiveReader &

objToBeCopied

)

Copy Constructor.

....................................................................... Copy Constructor.

ArchiveReader::~ArchiveReader ( )

virtual

Destructor.

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

Member Function Documentation

void ArchiveReader::addRegister

(

std::string

regSpec

)

....................................................................... Add a register to the list of registers to be read

void ArchiveReader::addRegisterOnly

(

std::string

regSpec

)

....................................................................... Add a register to the list of registers to be read

bool ArchiveReader::advanceFile

(

)

....................................................................... Advance to the next file in the list.

Return true if ths arraymap was updated on this call, false if not

unsigned ArchiveReader::countFrames

(

)

....................................................................... Count the number of frames spanned by the date range

void ArchiveReader::getFileList

(

)

....................................................................... Construct a sorted list of archive files from a given directory

void ArchiveReader::initialize	(	bool	memMap,
		bool	convert,
		bool	read
	)

Constructor.

void ArchiveReader::operator=

(

const ArchiveReader &

objToBeAssigned

)

Const Assignment Operator.

....................................................................... Const Assignment Operator.

void ArchiveReader::operator=

(

ArchiveReader &

objToBeAssigned

)

Assignment Operator.

....................................................................... Assignment Operator.

void ArchiveReader::printRegs

(

std::ostringstream &

os

)

....................................................................... Read register values from the current frame. The data stream should be positioned at the head of the current frame when this method is called

void ArchiveReader::readFirstArrayMap

(

)

....................................................................... When a new array map is encountered, this function is called to update our internal members that depend on the array map

bool ArchiveReader::readNextFrame

(

)

....................................................................... Read the next frame of registers

void ArchiveReader::readRegs

(

)

....................................................................... Read register values from the current frame. The data stream should be positioned at the head of the current frame when this method is called

unsigned ArchiveReader::readTimeStamps

(

)

....................................................................... Iterate through files, reading the date

void ArchiveReader::resetToBeginning

(

)

....................................................................... Reset to the first file in the list

void ArchiveReader::setArchiveDirectory

(

std::string

arcDir

)

....................................................................... Set the top-level archive directory. Note that this class will read files in subdirectories below the top-level

bool ArchiveReader::stageNextFile

(

)

....................................................................... Stage the next file for reading.

Return true if the array map was updated on this call, false if not.

bool ArchiveReader::updateArrayMap

(

)

....................................................................... When a new array map is encountered, this function is called to update internal members that depend on the array map

Return true if the array map was updated on this call. False if not

void ArchiveReader::updateRegBufPtrCache

(

unsigned

nByteRanges

)

....................................................................... Iterate through all distinct byte ranges in the current register selection

void ArchiveReader::updateRegisterCalibration

(

)

....................................................................... If the array map changed, update the register calibration

void ArchiveReader::updateRegSelection

(

)

....................................................................... If the array map changed, update the register selection

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, ArchiveReader &  obj  )

friend

Output Operator.

---

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

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