gcp::util::DirfileWriter Class Reference

Classes
struct	Register

Public Member Functions
	DirfileWriter (unsigned nBuffer=1, bool writeIndex=true)
void	initialize (unsigned nBuffer, bool writeIndex)
void	addRegister (std::string name, unsigned char *base, Register::Type, unsigned startEl=0, unsigned nEl=1)
void	addFloatRegister (std::string name, unsigned char *base, unsigned startEl=0, unsigned nEl=1)
	DirfileWriter (const DirfileWriter &objToBeCopied)
	DirfileWriter (DirfileWriter &objToBeCopied)
void	operator= (const DirfileWriter &objToBeAssigned)
void	operator= (DirfileWriter &objToBeAssigned)
virtual	~DirfileWriter ()
int	openArcfile (std::string dir)
void	closeArcfile ()
void	flushArcfile ()
int	writeIntegration ()
bool	isOpen ()

Protected Member Functions
void	insertReg (std::string name, unsigned char *basePtr, unsigned startEl, unsigned nEl, Register::Type type)
int	createDir (char *dir)
int	outputFormatFile (char *dir)

Protected Attributes
unsigned	nBuffer_
unsigned	maxlen_
bool	writeIndex_
bool	isOpen_
std::list< Register >	registers_
std::string	dirname_

Constructor & Destructor Documentation

DirfileWriter::DirfileWriter	(	unsigned	nBuffer = 1,
		bool	writeIndex = true
	)

Constructor.

nBuffer specifies the number of data values to be buffered for each register before writing to disk

writeIndex specfies whether or not to write separatae indices of multi-dimensional registers as separate files, ie:

bolo.channel[0-1] 

would be written as bolo.channel0 and bolo.channel1

....................................................................... Constructor with no archiver parent

DirfileWriter::DirfileWriter

(

const DirfileWriter &

objToBeCopied

)

Copy Constructor.

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

DirfileWriter::DirfileWriter

(

DirfileWriter &

objToBeCopied

)

Copy Constructor.

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

DirfileWriter::~DirfileWriter ( )

virtual

Destructor.

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

Member Function Documentation

void DirfileWriter::addFloatRegister	(	std::string	name,
		unsigned char *	base,
		unsigned	startEl = 0,
		unsigned	nEl = 1
	)

....................................................................... Add a floating-point register to the list of registers this object will maintain

void DirfileWriter::addRegister	(	std::string	name,
		unsigned char *	base,
		Register::Type	type,
		unsigned	startEl = 0,
		unsigned	nEl = 1
	)

....................................................................... Add an arbitrary type of register to the list of registers maintained by this object

void DirfileWriter::closeArcfile

(

)

....................................................................... Close all open files

int DirfileWriter::createDir ( char *  path )

protected

....................................................................... Create the named directory

void DirfileWriter::flushArcfile

(

)

....................................................................... Flush all open files

void DirfileWriter::initialize	(	unsigned	nBuffer,
		bool	writeIndex
	)

....................................................................... Generic initialize method

void DirfileWriter::insertReg ( std::string  name, unsigned char *  base, unsigned  startEl, unsigned  nEl, Register::Type  type  )

protected

....................................................................... Insert a block of register elements into the list

bool DirfileWriter::isOpen

(

)

....................................................................... Return true if an archive "file" is currently open

int DirfileWriter::openArcfile

(

std::string

dirname

)

....................................................................... Open dir files for all archived registers

void DirfileWriter::operator=

(

const DirfileWriter &

objToBeAssigned

)

Const Assignment Operator.

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

void DirfileWriter::operator=

(

DirfileWriter &

objToBeAssigned

)

Assignment Operator.

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

int DirfileWriter::outputFormatFile ( char *  dir )

protected

....................................................................... Output the dirfile format file needed by things like KST

int DirfileWriter::writeIntegration

(

)

....................................................................... Write the latest integration

---

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

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