Home Libraries Author Links

stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT > Class Template Reference
[BinMsg: Abstract Binary Message Model]

Inheritance diagram for stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >:

Inheritance graph
[legend]

List of all members.


Detailed Description

template<class DataT, class InputRangeT, class ContextT>
class stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >

Base message context type which shall be a direct or indirect public base class of its template parameter ContextT.

ContextT shall have a constructor taking a DataT reference as its first and an InputRangeT reference as its second and last parameter, where InputRangeT shall be a specialization of stm::inputrange or be publicly derived therefrom.

Definition at line 110 of file binmsg.hpp.


Public Types

typedef DataT data_type
 Type modelling the specialities of the kind of messages to be scanned.
typedef InputRangeT inputrange_type
 Type representing a range of input files containing the messages to be scanned.
typedef ContextT context_type
 Context type of the messages to be scanned.
typedef MsgTimestamp Timestamp
 Timestamp type.

Public Member Functions

 BaseMessageContext (data_type &data, inputrange_type &input)
 Constructs a BaseMessageContext object storing the data and input of the messages to be scanned.
const std::string & type () const
 Return the message context's type string.
void setType (const std::string &type)
 Set the message context's type string.
const Timestamptimestamp () const
 Returns the message context's timestamp reference.
void setTimestamp (const Timestamp &timestamp)
 Set the message context's timestamp.
data_typedata ()
 Returns the the message context's data reference.
inputrange_typeinput ()
 Returns the the message context's input range reference.

Member Typedef Documentation

template<class DataT, class InputRangeT, class ContextT>
typedef DataT stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >::data_type

Type modelling the specialities of the kind of messages to be scanned.

Reimplemented in stm::tools::BinMessageContext< DataT, InputRangeT, ContextT >.

Definition at line 123 of file binmsg.hpp.

template<class DataT, class InputRangeT, class ContextT>
typedef InputRangeT stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >::inputrange_type

Type representing a range of input files containing the messages to be scanned.

Reimplemented in stm::tools::BinMessageContext< DataT, InputRangeT, ContextT >.

Definition at line 127 of file binmsg.hpp.

template<class DataT, class InputRangeT, class ContextT>
typedef ContextT stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >::context_type

Context type of the messages to be scanned.

Reimplemented in stm::tools::BinMessageContext< DataT, InputRangeT, ContextT >.

Definition at line 130 of file binmsg.hpp.

template<class DataT, class InputRangeT, class ContextT>
typedef MsgTimestamp stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >::Timestamp

Timestamp type.

Definition at line 133 of file binmsg.hpp.


Constructor & Destructor Documentation

template<class DataT, class InputRangeT, class ContextT>
stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >::BaseMessageContext ( data_type data,
inputrange_type input 
)

Constructs a BaseMessageContext object storing the data and input of the messages to be scanned.


Member Function Documentation

template<class DataT, class InputRangeT, class ContextT>
const std::string& stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >::type (  )  const

Return the message context's type string.

This is a neutral string before any message has been read or the type string of the last successfully read message.

template<class DataT, class InputRangeT, class ContextT>
void stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >::setType ( const std::string &  type  ) 

Set the message context's type string.

template<class DataT, class InputRangeT, class ContextT>
const Timestamp& stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >::timestamp (  )  const

Returns the message context's timestamp reference.

This is an invalid timestamp before any message has been read or the timestamp of the last sucessfully read message.

template<class DataT, class InputRangeT, class ContextT>
void stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >::setTimestamp ( const Timestamp timestamp  ) 

Set the message context's timestamp.

template<class DataT, class InputRangeT, class ContextT>
data_type& stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >::data (  ) 

Returns the the message context's data reference.

template<class DataT, class InputRangeT, class ContextT>
inputrange_type& stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >::input (  ) 

Returns the the message context's input range reference.


© Copyright Tom Michaelis 2002-2007

Distributed under the SysToMath Software License (See the accompanying file license.txt or a copy at www.SysToMath.com).