orcalog Namespace Reference

Basic definitions for Orca logging facilities. More...

Classes
class	AutoLogger
	An AutoLogger simply logs continuously once it's started. More...
class	GenericAutoLogger
class	AutoLoggerFactory
	Factory of AutoLogger instances. More...
class	DummyReplayer
	This one can be used for unsupported or disabled interfaces. More...
class	Exception
	Base class for exceptions coming from libOrcaLog. More...
class	FileException
	Raised when something is wrong with reading the definition file. More...
class	ParseException
	Raised when something is wrong with parsing log file. More...
class	FormatNotSupportedException
	Raised when a format is specified which the slave logger does not support. More...
class	Factory
class	LogReader
class	LogReaderInfo
class	LogWriter
	Base class for all interface slaves Sets up a data file and registers with the MasterFileWriter. The individual log writers (e.g. LaserLogWriter) inherit from this class. More...
class	LogWriterInfo
class	MasterFileReader
	Knows how to parse a master file. More...
class	MasterFileWriteHandler
class	MasterFileWriter
	Maintains the master file. More...
class	Replayer
class	ReplayerFactory
	Factory of log replayers. More...
class	SnapshotLogBuffer
	A fixed-length (in time) circular buffer. More...
class	SnapshotLogger
class	GenericSnapshotLogger
class	SnapshotLoggerFactory
	Factory of SnapshotLogger instances. More...
Functions
std::ifstream *	openAsciiFileForReading (const std::string &filename)
std::ifstream *	openBinaryFileForReading (const std::string &filename)
std::ofstream *	openAsciiFileForWriting (const std::string &filename)
std::ofstream *	openBinaryFileForWriting (const std::string &filename)
void	parseRequiredTag (const std::string &tag, std::string &type, std::string &suffix)
std::string	headerLine (const std::string &filename, const std::string &interfaceType, const std::string &format, bool enabled)
	Convert log parameters to a master file header line.
void	parseHeaderLine (const std::string &line, std::string &filename, std::string &interfaceType, std::string &format, bool &enabled)
	Parse a master file header line to log parameters.
std::string	endOfHeader ()
	Special string to mark the end of the header (start of data).
bool	isEndOfHeader (const std::string &line)
	Test master file line for special string marking the end of the header (start of data).
std::string	dataLine (int seconds, int useconds, int id, int index)
	Convert data parameters to a master file data line.
void	parseDataLine (const std::string &line, int &seconds, int &useconds, int &id, int &index)
IceUtil::Time	iceUtilTime (int sec, int usec)
	Convenience function for constructing IceUtil times.

---

Detailed Description

Basic definitions for Orca logging facilities.

This namespace is part of a library which contains basic definitions for Orca logging facilities.

See also:

libOrcaLog

LogRecorder

libOrcaLogFactory

---

Function Documentation

std::ifstream * orcalog::openAsciiFileForReading

(

const std::string &

filename

)

Optional utility, which allocates space for opened file. Raises FileException if something is wrong.

Referenced by orcalog::LogReader::openLogFile().

std::ofstream * orcalog::openAsciiFileForWriting

(

const std::string &

filename

)

Allocates memory for file and opens Raises FileException if something is wrong.

Referenced by orcalog::LogWriter::createLogFile().

std::ifstream * orcalog::openBinaryFileForReading

(

const std::string &

filename

)

Optional utility, which allocates space for opened file. Raises FileException if something is wrong.

Referenced by orcalog::LogReader::openLogFile().

std::ofstream * orcalog::openBinaryFileForWriting

(

const std::string &

filename

)

Allocates memory for file and opens Raises FileException if something is wrong.

Referenced by orcalog::LogWriter::createLogFile().

void orcalog::parseDataLine	(	const std::string &	line,
		int &	seconds,
		int &	useconds,
		int &	id,
		int &	index
	)

Parse a master file data line to data parameters. Throws orcalog::Exception if the data line has wrong format.

void orcalog::parseRequiredTag	(	const std::string &	tag,
		std::string &	type,
		std::string &	suffix
	)

Parse required interface tag into interface type and suffix. The suffix is a number,e.g. '0', '1', '99', etc. Raises orcalog::Exception if parsing error is encountered.