Home Libraries Author Links

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

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

Inheritance graph
[legend]
Collaboration diagram for stm::tools::BinMessageContext< DataT, InputRangeT, ContextT >:

Collaboration graph
[legend]

List of all members.


Detailed Description

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

Binary message context type.

BinMessageContext<DataT, InputRangeT> is a BinMessage<ContextT> factory for which class templates Message can be registered as binary message types known to that factory where Message<class> shall be publicly derived from BaseMessage<ContextT>. InputRangeT shall be a specialization of stm::inputrange or be publicly derived therefrom.

Definition at line 332 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 BaseMessage< ContextT > basemessage_type
 Common base type of all message types registered for the factory.

Public Member Functions

 BinMessageContext (data_type &data, inputrange_type &input)
 Constructs a BinMessageContext object for data and input.
const Gapgap () const
 Returns a reference to the gap consisting of those bytes recently read while out of sync.
template<template< class > class Message>
bool registerMessageType ()
 Registers the binary message type MessageT to be known to the factory of this BinMessageContext.

Friends

class local::xBinMessage< ContextT >
 Implementation.

Classes

class  Gap
 Characterization of the gap, i.e. More...

Member Typedef Documentation

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

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

Reimplemented from stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >.

Definition at line 344 of file binmsg.hpp.

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

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

It shall shall be a specialization of stm::inputrange or be publicly derived therefrom.

Reimplemented from stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >.

Definition at line 350 of file binmsg.hpp.

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

Context type of the messages to be scanned.

Reimplemented from stm::tools::BaseMessageContext< DataT, InputRangeT, ContextT >.

Definition at line 353 of file binmsg.hpp.

template<class DataT, class InputRangeT, class ContextT>
typedef BaseMessage<ContextT> stm::tools::BinMessageContext< DataT, InputRangeT, ContextT >::basemessage_type

Common base type of all message types registered for the factory.

Definition at line 356 of file binmsg.hpp.


Constructor & Destructor Documentation

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

Constructs a BinMessageContext object for data and input.


Member Function Documentation

template<class DataT, class InputRangeT, class ContextT>
const Gap& stm::tools::BinMessageContext< DataT, InputRangeT, ContextT >::gap (  )  const

Returns a reference to the gap consisting of those bytes recently read while out of sync.

template<class DataT, class InputRangeT, class ContextT>
template<template< class > class Message>
bool stm::tools::BinMessageContext< DataT, InputRangeT, ContextT >::registerMessageType (  ) 

Registers the binary message type MessageT to be known to the factory of this BinMessageContext.

Message<class> shall be publicly derived from basemessage_type.


Friends And Related Function Documentation

template<class DataT, class InputRangeT, class ContextT>
friend class local::xBinMessage< ContextT > [friend]

Implementation.

Definition at line 340 of file binmsg.hpp.


© Copyright Tom Michaelis 2002-2007

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