pocolog_cpp Namespace Reference

Namespaces
	details

Classes
class	BadBlockType
struct	BadDataSize
struct	BadMagic
class	BadStream
struct	BadStreamType
struct	BlockHeader
struct	buffer_reader
class	ControlStream
class	DataBlockException
class	DataInputIterator
struct	DataSizeMismatch
class	DataStream
class	FileException
class	FileStream
class	Index
class	IndexFile
class	Input
class	InputDataStream
class	LogFile
class	MultiFileIndex
struct	NoSuchStream
class	Output
struct	Prologue
struct	SampleHeader
struct	SampleHeaderData
class	Stream
class	StreamDescription
struct	StreamMetadata
class	StreamWriter
struct	Truncated

Enumerations
enum	BlockType { UnknownBlockType = 0, StreamBlockType = 1, DataBlockType = 2, ControlBlockType = 3 }
enum	StreamType { UnknownStreamType = 0, DataStreamType = 1, ControlStreamType = 2 }
enum	CommandType { SetTimeBase = 0, SetTimeOffset = 1 }

Functions
struct pocolog_cpp::Prologue	__attribute__ ((packed))
void	writePrologue (std::ostream &stream)
template<class T >
Output &	operator<< (Output &output, const T &value)
template<>
Output &	operator<< (Output &output, const uint8_t &value)
template<>
Output &	operator<< (Output &output, const uint16_t &value)
template<>
Output &	operator<< (Output &output, const uint32_t &value)
template<>
Output &	operator<< (Output &output, const std::string &value)
template<>
Output &	operator<< (Output &output, const base::Time &time)
template<>
Output &	operator<< (Output &output, const BlockHeader &header)
template<>
Output &	operator<< (Output &output, const SampleHeader &header)
template<>
Output &	operator<< (Output &output, const BlockType &type)
template<>
Output &	operator<< (Output &output, const StreamType &type)
template<>
Output &	operator<< (Output &output, const CommandType &type)

Variables
const char	FORMAT_MAGIC [] = "POCOSIM"
struct pocolog_cpp::SampleHeader	__attribute__

Detailed Description

Log files are made of blocks. Each block begins with a common block header. Block are organized in streams, which all begin with a data stream declaration. Data blocks begin with a data stream declaration block, which includes the stream name, the stream type name and (optionally) a type registry which defines the type, in Typelib XML format. If no registry is available, the type registry is of zero size.

All pocosim-defined values are saved in little endian. Only the data payload in data blocks is saved in native endian. The log reader, pocosim-log, is able to swap endianness if needed.

Prologue (12 bytes)

Offset	Size	Field
+0	7	POCOSIM (see Logging::FORMAT_MAGIC)
+7	4	Format version (currently 2, see Logging::FORMAT_VERSION)
+11	1	Endianness (1 = big, 0 = little)

Block Header (8 bytes)

Offset	Size	Field
+0	1	block type (Logging::BlockType)
+1	1	padding
+2	2	stream index
+4	4	data size

Control Stream Declaration Block

Offset	Size	Field
+0	1	Logging::ControlStreamType

Data Stream Declaration Block

Offset	Size	Field
+0	1	Logging::DataStreamType
+1	4	stream name size
+3	i	stream name
	4	stream type name size
		stream type name
	4	type registry size
		type registry

Sample Block (25 bytes)

Offset	Size	Field
+4	4	real time (sec)
+8	4	real time (usec)
+20	4	logical time (sec)
+24	4	logical time (usec)
+32	4	data size
+36	1	compression flag
+37	data_size	data

Enumeration Type Documentation

BlockType

enum pocolog_cpp::BlockType

Enumerator
UnknownBlockType
StreamBlockType
DataBlockType	stream declaration block
ControlBlockType	a data block in an already declared stream

CommandType

enum pocolog_cpp::CommandType

Enumerator
SetTimeBase
SetTimeOffset

StreamType

enum pocolog_cpp::StreamType

Enumerator
UnknownStreamType
DataStreamType
ControlStreamType

Function Documentation

__attribute__()

struct pocolog_cpp::Prologue pocolog_cpp::__attribute__

(

(packed)

)

operator<<() [1/11]

template<class T >

Output& pocolog_cpp::operator<<	(	Output &	output,
		const T &	value
	)

operator<<() [2/11]

template<>

Output& pocolog_cpp::operator<< ( Output &  output, const uint8_t &  value  )

inline

operator<<() [3/11]

template<>

Output& pocolog_cpp::operator<< ( Output &  output, const uint16_t &  value  )

inline

operator<<() [4/11]

template<>

Output& pocolog_cpp::operator<< ( Output &  output, const uint32_t &  value  )

inline

operator<<() [5/11]

template<>

Output& pocolog_cpp::operator<< ( Output &  output, const std::string &  value  )

inline

operator<<() [6/11]

template<>

Output& pocolog_cpp::operator<< ( Output &  output, const base::Time &  time  )

inline

operator<<() [7/11]

template<>

Output& pocolog_cpp::operator<< ( Output &  output, const BlockHeader &  header  )

inline

operator<<() [8/11]

template<>

Output& pocolog_cpp::operator<< ( Output &  output, const SampleHeader &  header  )

inline

operator<<() [9/11]

template<>

Output& pocolog_cpp::operator<< ( Output &  output, const BlockType &  type  )

inline

operator<<() [10/11]

template<>

Output& pocolog_cpp::operator<< ( Output &  output, const StreamType &  type  )

inline

operator<<() [11/11]

template<>

Output& pocolog_cpp::operator<< ( Output &  output, const CommandType &  type  )

inline

writePrologue()

void pocolog_cpp::writePrologue

(

std::ostream &

stream

)

Writes the file prologue

Variable Documentation

__attribute__

pocolog_cpp::InputDataStream pocolog_cpp::__attribute__

FORMAT_MAGIC

const char pocolog_cpp::FORMAT_MAGIC = "POCOSIM"