TapeVisitor::iterator Class Reference

Iterator to iterate over all messages in all tapes visited by the visitor. More...

#include <fw/TapeVisitor.h>

Public Member Functions
	iterator ()
	iterator (TapeVisitor *visitor, MessageMap::iterator message)
iterator &	operator= (const iterator &other)
iterator &	operator++ ()
iterator &	operator-- ()
const MessageInstance &	operator* () const
	Instantiates the message by loading it from the underlying tape file. More...
const MessageInstance *	operator-> () const
	Instantiates the message by loading it from the underlying tape file. More...
template<typename T >
void	read (Stamped< T > &oData)
	Instantiates the message by loading it from the underlying tape file and deserializes its content into oData. More...
void	readJSON (Stamped< JSONValue > &oData)
	Instantiates the message by loading it from the underlying tape file and deserializes its content as JSONValue into oData. More...
bool	operator== (const iterator &other) const
bool	operator!= (const iterator &other) const
Duration	getTimeOffset () const
	Get the offset of the recording time for this message. More...
const Tape::ChannelInfo *	getChannelInfo () const
	Get the information object about the channel this message belongs to. More...
Duration	getTZOffset () const
	Get the time zone offset of the tape containing this message. More...

Protected Member Functions
void	validate () const

Protected Attributes
MessageInstance	mInstance
TapeVisitor *	mVisitor
MessageMap::iterator	mMessage

Friends
class	TapeVisitor

Detailed Description

Iterator to iterate over all messages in all tapes visited by the visitor.

Constructor & Destructor Documentation

iterator() [1/2]

iterator ( )

inline

iterator() [2/2]

iterator ( TapeVisitor *  visitor, MessageMap::iterator  message  )

inline

Member Function Documentation

operator=()

iterator& operator= ( const iterator &  other )

inline

operator++()

iterator& operator++ ( )

inline

operator--()

iterator& operator-- ( )

inline

operator*()

const MessageInstance& operator* ( ) const

inline

Instantiates the message by loading it from the underlying tape file.

operator->()

const MessageInstance* operator-> ( ) const

inline

Instantiates the message by loading it from the underlying tape file.

read()

void read ( Stamped< T > &  oData )

inline

Instantiates the message by loading it from the underlying tape file and deserializes its content into oData.

This method is provided for convenience.

Exceptions

XIO	If the type of the message does not match T

readJSON()

void readJSON

(

Stamped< JSONValue > &

oData

)

Instantiates the message by loading it from the underlying tape file and deserializes its content as JSONValue into oData.

This method is provided for convenience.

operator==()

bool operator== ( const iterator &  other ) const

inline

operator!=()

bool operator!= ( const iterator &  other ) const

inline

getTimeOffset()

Duration getTimeOffset ( ) const

inline

Get the offset of the recording time for this message.

Note if the message is not loaded from file calling this function will NOT load it. Calling this is fast!

getChannelInfo()

const Tape::ChannelInfo* getChannelInfo ( ) const

inline

Get the information object about the channel this message belongs to.

Note if the message is not loaded from file calling this function will NOT load it. Calling this is fast!

getTZOffset()

Duration getTZOffset ( ) const

inline

Get the time zone offset of the tape containing this message.

validate()

void validate ( ) const

inlineprotected

Friends And Related Function Documentation

TapeVisitor

friend class TapeVisitor

friend

Member Data Documentation

mInstance

MessageInstance mInstance

mutableprotected

mVisitor

TapeVisitor* mVisitor

protected

mMessage

MessageMap::iterator mMessage

protected

---

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

• framework/include/fw/TapeVisitor.h