A tape is a binary file that contains recorded/serialized data of one or multiple channels. More...

#include <fw/Tape.h>

Classes
struct	ChannelInfo
	Information about a channel in a tape. More...

struct	FileInfo
	Information about a tape file. More...

struct	Header
	Header containing type and size of the following packet. More...

struct	Message
	Struct for message data in a tape. More...

struct	MessageBlock
	Struct for a message block in a tape. More...

struct	MessageIndex
	Index entry for a message in the tape. More...

Public Types
enum	OpenMode { READ, WRITE, INFO }
	The open mode for a tape. More...

enum	HeaderType { MESSAGEBLOCK = 0x0A, CHANNELINFO = 0x0B, MESSAGE = 0x0C, INDEX = 0x0D }
	The type of the header specifying the following packet. More...

typedef std::map< std::string, ChannelInfo >	ChannelMap
	maps channel information to a channel names More...

typedef std::map< uint64, MessageBlock >	MessageBlockMap
	maps a message block to an offset More...

typedef std::multimap< Duration, Message >	MessageMap
	maps a message to an time offset More...

Public Member Functions
	Tape ()

	~Tape ()

void	open (const Path &file, OpenMode mode)
	Open the tape for reading or writing. More...

void	close ()
	Close the tape. More...

void	repair (const Path &file, const Path &outFile)
	Try to repair the tape given by file and store repaired version in outFile. More...

void	waitForAlteredStartTime ()
	If this method is called in write mode (must be called before writing the first message to the tape) all recorded data is written to file after setting the start time of the tape by calling alterStartTime(). More...

void	alterStartTime (const Time &startTime)
	Alters the start time of a tape in write mode. More...

template<typename T >
	MIRA_DEPRECATED ("Please use int compressionLevel(=0/-1) instead of bool compress(=false/true)", std::size_t write(ChannelRead< T > value, bool compress, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase()))
	Write the content of a channel into the tape. More...

template<typename T >
std::size_t	write (ChannelRead< T > value, int compressionLevel=0, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase())
	Write the content of a channel into the tape. More...

template<typename T >
	MIRA_DEPRECATED ("Please use int compressionLevel(=0/-1) instead of bool compress(=false/true)", std::size_t write(ChannelRead< T > value, std::list< BinarySerializerCodecPtr > &codecs, bool compress, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase()))
	Write the content of a channel into the tape. More...

template<typename T >
std::size_t	write (ChannelRead< T > value, std::list< BinarySerializerCodecPtr > &codecs, int compressionLevel=0, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase())
	Write the content of a channel into the tape. More...

template<typename T >
	MIRA_DEPRECATED ("Please use int compressionLevel(=0/-1) instead of bool compress(=false/true)", std::size_t write(const std::string &channelID, const Stamped< T > &value, bool compress, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase()))
	Write the stamped data into the tape. More...

template<typename T >
std::size_t	write (const std::string &channelID, const Stamped< T > &value, int compressionLevel=0, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase())
	Write the stamped data into the tape. More...

	MIRA_DEPRECATED ("Please use int compressionLevel(=0/-1) instead of bool compress(=false/true)", std::size_t write(const std::string &channelID, const std::string &typeName, const StampedHeader &header, const Buffer< uint8 > &data, bool compress, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase()))
	Write the serialized data into the tape. More...

std::size_t	write (const std::string &channelID, const std::string &typeName, const StampedHeader &header, const Buffer< uint8 > &data, int compressionLevel=0, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase())
	Write the serialized data into the tape. More...

	MIRA_DEPRECATED ("Please use int compressionLevel(=0/-1) instead of bool compress(=false/true)", std::size_t write(const std::string &channelID, const std::string &typeName, const Time &time, const std::string &frameID, uint32 sequenceID, const Buffer< uint8 > &data, bool compress, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase()))
	Low level write method to write serialized binary data to the tape. More...

std::size_t	write (const std::string &channelID, const std::string &typeName, const Time &time, const std::string &frameID, uint32 sequenceID, const Buffer< uint8 > &data, int compressionLevel=0, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase())
	Low level write method to write serialized binary data to the tape. More...

void	setMaxMessageBlockSize (uint32 size)
	Set the maximum size of the chunks. More...

void	setSortWindowSize (const Duration &interval)
	Messages get sorted before they are written to a tape to guarantee a correct temporal order. More...

void	setStartTime (Time time)
	Set an alternative start time for recording. More...

Time	getStartTime () const
	Get the time when the recording started. More...

Time	getLocalStartTime () const
	Get the time when the recording started in the local timezone of the machine the recording took place (Time at place of recording). More...

Time	getEndTime () const
	Get the time of the last entry. More...

Duration	getTZOffset () const
	Get the time zone offset. More...

const Tape::ChannelMap &	getChannels () const
	Get a list of channels in the tape. More...

const Tape::MessageBlockMap &	getMessageBlocks () const
	Get a list of the tapes message blocks. More...

uint32	getVersion () const
	Get the version of the tape. More...

void	readMessage (const MessageIndex &index, std::string &frameID, uint32 &sequenceID, Buffer< uint8 > &oData, Duration &oTime)
	Read a message from tape at the given index. More...

void	readMessage (const MessageIndex &index, std::string &frameID, uint32 &sequenceID, Buffer< uint8 > &oData, Duration &oTime, bool &oCompressed)
	Same as above but allows to obtain additional information whether the data was compressed within the tape or not. More...

Static Public Member Functions
static uint32	getCurrentVersion ()
	Returns the tape version that is supported by the local implementation. More...

Static Public Attributes
static const uint32	sHeaderSize
	size of the header packet More...

static const uint32	sMessageBlockSize

Protected Member Functions
uint64	getFileHeaderSize () const

void	openInfo (const Path &file)

void	openRead (const Path &file)

void	closeRead ()

void	openWrite (const Path &file)

void	closeWrite ()

void	openRepair (const Path &file)

void	write (Duration time, const Message &message)

void	readFileHeader ()

void	readChannelInfo ()

void	readMessageBlocks ()

void	readMessageBlock (uint64 offset)

void	writeFileHeader ()

Tape::Header	readHeader ()

void	writeHeader (HeaderType type, uint32 size)

void	writeChannelInfo (ChannelInfo &info)

void	startMessageBlock (Duration time)

void	finishMessageBlock ()

Protected Attributes
bool	mIsOpen

bool	mWaitForAlteredStartTime

OpenMode	mMode

ChannelMap	mChannels

std::set< std::string >	mWrittenChannels

boost::optional< MessageBlock >	mCurrentMessageBlock

boost::mutex	mMutex

boost::mutex	mMessageMutex

MessageBlockMap	mMessageBlocks
	Pairs of offset - message block. More...

FileInfo	mFile
	File informations. More...

uint64	mLastInfo
	Offset to the last written info field. More...

uint32	mMaxMessageBlockSize
	Maximum size of a message block. More...

MessageMap	mMessages
	Messages we have not yet written to file (in the sort window) More...

Duration	mSortWindowSize
	Size of the window used for sorting messages in a tape. More...

Detailed Description

A tape is a binary file that contains recorded/serialized data of one or multiple channels.

The tape file can be played back later to review and analyze the recorded data e.g. for testing algorithms. The format of a tape (in the current version, see version history below) is as follows: (numbers in () list the size in bytes)

There is one file header at the start of the tape:

<FileHeader>
 -version (4)
 -time of recording in nanoseconds since 00:00:00 01.01.1970 (8)
 -time difference of recording machine to UTC time in nanoseconds (8)
 -number of message blocks (4)
 -offset to first channel info field (8)

All other field types start with a 5 byte header:

<FieldHeader>
 -type of field (1)
 -size (4)

There are 4 types of data fields, storing data and offsets to other fields:

<MessageBlockField>
 -number of messages (4)
 -block size (4)
 -time of first message in nanoseconds, relative to time of recording (8)
 -time of last message in nanoseconds, relative to time of recording (8)

<ChannelInfoField>
 -offset to next channel info field (8)
 -time of first message in nanoseconds, relative to time of recording (8)
 -time of last message in nanoseconds, relative to time of recording (8)
 -name (size (4) + size bytes)
 -type (size (4) + size bytes)
 -meta data (size (8) + size bytes)
 -total message data size (8)
 -offset to index table (8)

<MessageField>
 -time of message in nanoseconds, relative to time of recording (8)
 -name (size (4) + size bytes)
 -frameID (size(4) + size bytes)
 -sequenceID (4)
 -size of (compressed) data (4)
 -compression flag tells us if message is compressed (1)
 -if compression flag is set size of uncompressed data (4)
 -data (size of (compressed) data bytes)

<IndexField>
 -number of messages (4)
 for each message:
  -offset to block field (8)
  -relative offset in message block to message (8)
  -time of message in nanoseconds, relative to time of recording (8)

History of Tape versions:

6.0 (0x00060000) current
- added size information to channel info
5.0 (0x00050000)
- message header now contains frame id and sequence id of the data
- the real message data now only contains the serialized value
4.0 (0x00040000)
- added time zone offset to file header
3.0 (0x00030000)
- added meta data to channel informations
2.0 (0x00020000)
- using 64bit instead of 32bit for all sizes and offsets in tape files
1.1 (0x00010001)
- using nanosecond instead of microsecond resolution for all time offsets and values in tapes
1.0 (0x00010000)
- initial version

Member Typedef Documentation

◆ ChannelMap

typedef std::map<std::string, ChannelInfo> ChannelMap

maps channel information to a channel names

◆ MessageBlockMap

typedef std::map<uint64, MessageBlock> MessageBlockMap

maps a message block to an offset

◆ MessageMap

typedef std::multimap<Duration, Message> MessageMap

maps a message to an time offset

Member Enumeration Documentation

◆ OpenMode

enum OpenMode

The open mode for a tape.

Enumerator
READ
WRITE
INFO

◆ HeaderType

enum HeaderType

The type of the header specifying the following packet.

Enumerator
MESSAGEBLOCK
CHANNELINFO
MESSAGE
INDEX

Constructor & Destructor Documentation

◆ Tape()

Tape ( )

inline

◆ ~Tape()

~Tape ( )

Member Function Documentation

◆ open()

void open	(	const Path &	file,
		OpenMode	mode
	)

Open the tape for reading or writing.

Parameters

[in]	file	The filename of the tape
[in]	mode	The opening mode (read or write)

◆ close()

void close ( )

Close the tape.

◆ repair()

void repair	(	const Path &	file,
		const Path &	outFile
	)

Try to repair the tape given by file and store repaired version in outFile.

Parameters

[in]	file	The filename of the tape to be repaired
[in]	outFile	The filename of the repaired tape

◆ waitForAlteredStartTime()

void waitForAlteredStartTime ( )

If this method is called in write mode (must be called before writing the first message to the tape) all recorded data is written to file after setting the start time of the tape by calling alterStartTime().

Time offsets of all message written until alterStartTime() is called will be corrected relative to the new start time. This can be used to write "old" data to the tape first and specify the start time of recording later.

Exceptions

XIO	if the tape is not opened in write mode
XInvalidConfig	if data was already written to the tape.

◆ alterStartTime()

void alterStartTime ( const Time & startTime )

Alters the start time of a tape in write mode.

Can only be called if waitForAlteredStartTime() was called before or no data has been written to the tape yet.

Exceptions

XIO	if the tape is not opened in write mode
XInvalidConfig	if waitForAlteredStartTime() was not called before or data was already written to the tape.

◆ MIRA_DEPRECATED() [1/5]

MIRA_DEPRECATED	(	"Please use int compressionLevel(=0/-1) instead of bool compress(=false/true)"	,
		std::size_t	writeChannelRead< T > value, bool compress, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase()
	)

inline

Write the content of a channel into the tape.

Exceptions

XIO	if the tape is not opened in write mode

Parameters

value	The channel that data gets serialized and written to tape
compress	If true, compress data using zip compression (default compression level)
meta	meta information about the type of the data
meta	database that contains meta information about the types used by the data type itself (e.g. class members)

Returns: Returns the number of bytes of data, added to the tape

◆ write() [1/6]

std::size_t write	(	ChannelRead< T >	value,
		int	compressionLevel = `0`,
		TypeMetaPtr	meta = `TypeMetaPtr()`,
		const MetaTypeDatabase &	metaDB = `MetaTypeDatabase()`
	)

inline

Write the content of a channel into the tape.

Exceptions

XIO	if the tape is not opened in write mode

Parameters

value	The channel that data gets serialized and written to tape
compressionLevel	libzip compression level (0=none, 1..9=best speed to best compression, -1=default compression)
meta	meta information about the type of the data
meta	database that contains meta information about the types used by the data type itself (e.g. class members)

Returns: Returns the number of bytes of data, added to the tape

◆ MIRA_DEPRECATED() [2/5]

MIRA_DEPRECATED	(	"Please use int compressionLevel(=0/-1) instead of bool compress(=false/true)"	,
		std::size_t	writeChannelRead< T > value, std::list< BinarySerializerCodecPtr > &codecs, bool compress, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase()
	)

inline

Write the content of a channel into the tape.

Exceptions

XIO	if the tape is not opened in write mode

Parameters

value	The channel that data gets serialized and written to tape
codecs	A list of codecs. If this list contains a codec that matches the type of the channel it is used to encode its value.
compress	If true, compress data using zip compression (default compression level)
meta	meta information about the type of the data
meta	database that contains meta information about the types used by the data type itself (e.g. class members)

Returns: Returns the number of bytes of data, added to the tape

◆ write() [2/6]

std::size_t write	(	ChannelRead< T >	value,
		std::list< BinarySerializerCodecPtr > &	codecs,
		int	compressionLevel = `0`,
		TypeMetaPtr	meta = `TypeMetaPtr()`,
		const MetaTypeDatabase &	metaDB = `MetaTypeDatabase()`
	)

inline

Write the content of a channel into the tape.

Exceptions

XIO	if the tape is not opened in write mode

Parameters

value	The channel that data gets serialized and written to tape
codecs	A list of codecs. If this list contains a codec that matches the type of the channel it is used to encode its value.
compressionLevel	libzip compression level (0=none, 1..9=best speed to best compression, -1=default compression)
meta	meta information about the type of the data
meta	database that contains meta information about the types used by the data type itself (e.g. class members)

Returns: Returns the number of bytes of data, added to the tape

◆ MIRA_DEPRECATED() [3/5]

MIRA_DEPRECATED	(	"Please use int compressionLevel(=0/-1) instead of bool compress(=false/true)"	,
		std::size_t	writeconst std::string &channelID, const Stamped< T > &value, bool compress, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase()
	)

inline

Write the stamped data into the tape.

Exceptions

XIO	if the tape is not opened in write mode

Parameters

channelID	The name of the channel
value	The value that contains the stamped header information and the data that gets serialized and written to tape
compress	If true, compress data using zip compression (default compression level)
meta	meta information about the type of the data
meta	database that contains meta information about the types used by the data type itself (e.g. class members)

Returns: Returns the number of bytes of data, added to the tape

◆ write() [3/6]

std::size_t write	(	const std::string &	channelID,
		const Stamped< T > &	value,
		int	compressionLevel = `0`,
		TypeMetaPtr	meta = `TypeMetaPtr()`,
		const MetaTypeDatabase &	metaDB = `MetaTypeDatabase()`
	)

inline

Write the stamped data into the tape.

Exceptions

XIO	if the tape is not opened in write mode

Parameters

channelID	The name of the channel
value	The value that contains the stamped header information and the data that gets serialized and written to tape
compressionLevel	libzip compression level (0=none, 1..9=best speed to best compression, -1=default compression)
meta	meta information about the type of the data
meta	database that contains meta information about the types used by the data type itself (e.g. class members)

Returns: Returns the number of bytes of data, added to the tape

◆ MIRA_DEPRECATED() [4/5]

MIRA_DEPRECATED	(	"Please use int compressionLevel(=0/-1) instead of bool compress(=false/true)"	,
		std::size_t	writeconst std::string &channelID, const std::string &typeName, const StampedHeader &header, const Buffer< uint8 > &data, bool compress, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase()
	)

inline

Write the serialized data into the tape.

The stamped information is passed via the stamped header parameter.

Exceptions

XIO	if the tape is not opened in write mode

Parameters

channelID	The name of the channel
typeName	The typename of the data
header	The stamped information for the data
data	The serialized data that gets written to tape
compress	If true, compress data using zip compression (default compression level)
meta	meta information about the type of the data
metaDB	database that contains meta information about the types used by the data type itself (e.g. class members)

Returns: Returns the number of bytes of data, added to the tape

◆ write() [4/6]

std::size_t write	(	const std::string &	channelID,
		const std::string &	typeName,
		const StampedHeader &	header,
		const Buffer< uint8 > &	data,
		int	compressionLevel = `0`,
		TypeMetaPtr	meta = `TypeMetaPtr()`,
		const MetaTypeDatabase &	metaDB = `MetaTypeDatabase()`
	)

inline

Write the serialized data into the tape.

The stamped information is passed via the stamped header parameter.

Exceptions

XIO	if the tape is not opened in write mode

Parameters

channelID	The name of the channel
typeName	The typename of the data
header	The stamped information for the data
data	The serialized data that gets written to tape
compressionLevel	libzip compression level (0=none, 1..9=best speed to best compression, -1=default compression)
meta	meta information about the type of the data
metaDB	database that contains meta information about the types used by the data type itself (e.g. class members)

Returns: Returns the number of bytes of data, added to the tape

◆ MIRA_DEPRECATED() [5/5]

MIRA_DEPRECATED	(	"Please use int compressionLevel(=0/-1) instead of bool compress(=false/true)"	,
		std::size_t	writeconst std::string &channelID, const std::string &typeName, const Time &time, const std::string &frameID, uint32 sequenceID, const Buffer< uint8 > &data, bool compress, TypeMetaPtr meta=TypeMetaPtr(), const MetaTypeDatabase &metaDB=MetaTypeDatabase()
	)

inline

Low level write method to write serialized binary data to the tape.

Exceptions

XIO	if the tape is not opened in write mode

Parameters

channelID	The name of the channel
typeName	The typename of the data
time	Timestamp of the data
frameID	Frame ID of the data
sequenceID	Sequence ID of the data
data	The serialized data that gets written to tape
compress	If true, compress data using zip compression (default compression level)
meta	meta information about the type of the data
metaDB	database that contains meta information about the types used by the data type itself (e.g. class members)

Returns: Returns the number of bytes of data, added to the tape

◆ write() [5/6]

std::size_t write	(	const std::string &	channelID,
		const std::string &	typeName,
		const Time &	time,
		const std::string &	frameID,
		uint32	sequenceID,
		const Buffer< uint8 > &	data,
		int	compressionLevel = `0`,
		TypeMetaPtr	meta = `TypeMetaPtr()`,
		const MetaTypeDatabase &	metaDB = `MetaTypeDatabase()`
	)

Low level write method to write serialized binary data to the tape.

Exceptions

XIO	if the tape is not opened in write mode

Parameters

channelID	The name of the channel
typeName	The typename of the data
time	Timestamp of the data
frameID	Frame ID of the data
sequenceID	Sequence ID of the data
data	The serialized data that gets written to tape
compressionLevel	libzip compression level (0=none, 1..9=best speed to best compression, -1=default compression)
meta	meta information about the type of the data
metaDB	database that contains meta information about the types used by the data type itself (e.g. class members)

Returns: Returns the number of bytes of data, added to the tape

◆ setMaxMessageBlockSize()

void setMaxMessageBlockSize ( uint32 size )

inline

Set the maximum size of the chunks.

Parameters

[in] size Size of a chunk in bytes

◆ setSortWindowSize()

void setSortWindowSize ( const Duration & interval )

inline

Messages get sorted before they are written to a tape to guarantee a correct temporal order.

Messages are collected in a sorted temporary list. While new messages arrive older messages get written to file when they move out of the sort window. One can specify the size of the sorting window by calling this function.

◆ setStartTime()

void setStartTime ( Time time )

inline

Set an alternative start time for recording.

This is used when creating new tapes out of existing ones to use their start time instead of now.

Parameters

[in] time Start time of recording

◆ getStartTime()

Time getStartTime ( ) const

inline

Get the time when the recording started.

Exceptions

XIO	if the tape is not opened

Returns: The time when recording was started.

◆ getLocalStartTime()

Time getLocalStartTime ( ) const

inline

Get the time when the recording started in the local timezone of the machine the recording took place (Time at place of recording).

Exceptions

XIO	if the tape is not opened

◆ getEndTime()

Time getEndTime ( ) const

inline

Get the time of the last entry.

Exceptions

XIO	if the tape is not opened

Returns: The time of the last entry in the tape

◆ getTZOffset()

Duration getTZOffset ( ) const

inline

Get the time zone offset.

Exceptions

XIO	if the tape is not opened

Returns: The time zone offset of the recording (can be used later to determine the local time at time of recording a message).

Note: The time zone offset is stored when the tape's start time is set. Time zone changes during tape recording (e.g. summer/winter time) are ignored!

◆ getChannels()

const Tape::ChannelMap& getChannels ( ) const

inline

Get a list of channels in the tape.

Exceptions

XIO	if the tape is not opened

Returns: A list of all channels in the tape

◆ getMessageBlocks()

const Tape::MessageBlockMap& getMessageBlocks ( ) const

inline

Get a list of the tapes message blocks.

Exceptions

XIO	if the tape is not opened

Returns: A map containing information about each chunk in the tape.

◆ getVersion()

uint32 getVersion ( ) const

inline

Get the version of the tape.

Exceptions

XIO	if the tape is not opened

Returns: The version of the tape

◆ getCurrentVersion()

static uint32 getCurrentVersion ( )

static

Returns the tape version that is supported by the local implementation.

Note, that this is the version that is used to generate new tape files. In contrast the getVersion() method returns the version of the opened tape file that may differ from that of the local implementation.

◆ readMessage() [1/2]

void readMessage	(	const MessageIndex &	index,
		std::string &	frameID,
		uint32 &	sequenceID,
		Buffer< uint8 > &	oData,
		Duration &	oTime
	)

Read a message from tape at the given index.

An index can be obtained from the ChannelMaps messages member

Exceptions

XIO	if the tape is not opened in read mode

Parameters

	index	Read message at that index
	frameID	Frame id of the message
	sequenceID	Sequence id of the message
[out]	oData	Buffer to the data. Is resized and filled with the serialized data from the tape at index position
[out]	oTime	The time offset to the start of recording when that message was recorded.

◆ readMessage() [2/2]

void readMessage	(	const MessageIndex &	index,
		std::string &	frameID,
		uint32 &	sequenceID,
		Buffer< uint8 > &	oData,
		Duration &	oTime,
		bool &	oCompressed
	)

Same as above but allows to obtain additional information whether the data was compressed within the tape or not.

Exceptions

XIO	if the tape is not opened in read mode

◆ getFileHeaderSize()

uint64 getFileHeaderSize ( ) const

protected

◆ openInfo()

void openInfo ( const Path & file )

protected

◆ openRead()

void openRead ( const Path & file )

protected

◆ closeRead()

void closeRead ( )

protected

◆ openWrite()

void openWrite ( const Path & file )

protected

◆ closeWrite()

void closeWrite ( )

protected

◆ openRepair()

void openRepair ( const Path & file )

protected

◆ write() [6/6]

void write	(	Duration	time,
		const Message &	message
	)

protected

◆ readFileHeader()

void readFileHeader ( )

protected

◆ readChannelInfo()

void readChannelInfo ( )

protected

◆ readMessageBlocks()

void readMessageBlocks ( )

protected

◆ readMessageBlock()

void readMessageBlock ( uint64 offset )

protected

◆ writeFileHeader()

void writeFileHeader ( )

protected

◆ readHeader()

Tape::Header readHeader ( )

protected

◆ writeHeader()

void writeHeader	(	HeaderType	type,
		uint32	size
	)

protected

◆ writeChannelInfo()

void writeChannelInfo ( ChannelInfo & info )

protected

◆ startMessageBlock()

void startMessageBlock ( Duration time )

protected

◆ finishMessageBlock()

void finishMessageBlock ( )

protected

Member Data Documentation

◆ sHeaderSize

const uint32 sHeaderSize

static

size of the header packet

◆ sMessageBlockSize

const uint32 sMessageBlockSize

static

◆ mIsOpen

bool mIsOpen

protected

◆ mWaitForAlteredStartTime

bool mWaitForAlteredStartTime

protected

◆ mMode

OpenMode mMode

protected

◆ mChannels

ChannelMap mChannels

protected

◆ mWrittenChannels

std::set<std::string> mWrittenChannels

protected

◆ mCurrentMessageBlock

boost::optional<MessageBlock> mCurrentMessageBlock

protected

◆ mMutex

boost::mutex mMutex

protected

◆ mMessageMutex

boost::mutex mMessageMutex

protected

◆ mMessageBlocks

MessageBlockMap mMessageBlocks

protected

Pairs of offset - message block.

◆ mFile

FileInfo mFile

protected

File informations.

◆ mLastInfo

uint64 mLastInfo

protected

Offset to the last written info field.

◆ mMaxMessageBlockSize

uint32 mMaxMessageBlockSize

protected

Maximum size of a message block.

◆ mMessages

MessageMap mMessages

protected

Messages we have not yet written to file (in the sort window)

◆ mSortWindowSize

Duration mSortWindowSize

protected

Size of the window used for sorting messages in a tape.

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

framework/include/fw/Tape.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ChannelMap

◆ MessageBlockMap

◆ MessageMap

Member Enumeration Documentation

◆ OpenMode

◆ HeaderType

Constructor & Destructor Documentation

◆ Tape()

◆ ~Tape()

Member Function Documentation

◆ open()

◆ close()

◆ repair()

◆ waitForAlteredStartTime()

◆ alterStartTime()

◆ MIRA_DEPRECATED() [1/5]

◆ write() [1/6]

◆ MIRA_DEPRECATED() [2/5]

◆ write() [2/6]

◆ MIRA_DEPRECATED() [3/5]

◆ write() [3/6]

◆ MIRA_DEPRECATED() [4/5]

◆ write() [4/6]

◆ MIRA_DEPRECATED() [5/5]

◆ write() [5/6]

◆ setMaxMessageBlockSize()

◆ setSortWindowSize()

◆ setStartTime()

◆ getStartTime()

◆ getLocalStartTime()

◆ getEndTime()

◆ getTZOffset()

◆ getChannels()

◆ getMessageBlocks()

◆ getVersion()

◆ getCurrentVersion()

◆ readMessage() [1/2]

◆ readMessage() [2/2]

◆ getFileHeaderSize()

◆ openInfo()

◆ openRead()

◆ closeRead()

◆ openWrite()

◆ closeWrite()

◆ openRepair()

◆ write() [6/6]

◆ readFileHeader()

◆ readChannelInfo()

◆ readMessageBlocks()

◆ readMessageBlock()

◆ writeFileHeader()

◆ readHeader()

◆ writeHeader()

◆ writeChannelInfo()

◆ startMessageBlock()

◆ finishMessageBlock()

Member Data Documentation

◆ sHeaderSize

◆ sMessageBlockSize

◆ mIsOpen

◆ mWaitForAlteredStartTime

◆ mMode

◆ mChannels

◆ mWrittenChannels

◆ mCurrentMessageBlock

◆ mMutex

◆ mMessageMutex

◆ mMessageBlocks

◆ mFile

◆ mLastInfo

◆ mMaxMessageBlockSize