Home Libraries Author Links

stm::tools::DspMessage< ContextT > Class Template Reference
[DspMsg: DSP Message Model]

List of all members.


Detailed Description

template<class ContextT>
class stm::tools::DspMessage< ContextT >

DSP message contained in a binary message.

Definition at line 106 of file dspmsg.hpp.


Public Types

enum  
 Error status. More...
typedef ContextT context_type
 Context type of the messages to be scanned.
typedef BinMessage< ContextT > parent_type
 Type of the binary message wrapping this DspMessage.

Public Member Functions

 DspMessage (const parent_type &parent)
 Construct a DspMessage object contained in the binary message parent.
virtual ~DspMessage ()
 Virtual destructor to allow polymorphic class hierarchies.
dword status () const
 Returns the status of the DSP message.
bool hasTraceHeader () const
 Returns true, if the message has a trace header.
const TraceHeadertraceHeader () const
 Returns a reference to the message's trace header.
const byte_iterator_rangebody () const
 Returns the byte range consisting of the message's body.
const parent_typeparent ()
 Returns the message's parent.

Classes

class  TraceHeader
 Type representing a trace header. More...

Member Typedef Documentation

template<class ContextT>
typedef ContextT stm::tools::DspMessage< ContextT >::context_type

Context type of the messages to be scanned.

Definition at line 114 of file dspmsg.hpp.

template<class ContextT>
typedef BinMessage<ContextT> stm::tools::DspMessage< ContextT >::parent_type

Type of the binary message wrapping this DspMessage.

Definition at line 117 of file dspmsg.hpp.


Member Enumeration Documentation

template<class ContextT>
anonymous enum

Error status.

Definition at line 120 of file dspmsg.hpp.


Constructor & Destructor Documentation

template<class ContextT>
stm::tools::DspMessage< ContextT >::DspMessage ( const parent_type parent  ) 

Construct a DspMessage object contained in the binary message parent.

template<class ContextT>
virtual stm::tools::DspMessage< ContextT >::~DspMessage (  )  [virtual]

Virtual destructor to allow polymorphic class hierarchies.


Member Function Documentation

template<class ContextT>
dword stm::tools::DspMessage< ContextT >::status (  )  const

Returns the status of the DSP message.

template<class ContextT>
bool stm::tools::DspMessage< ContextT >::hasTraceHeader (  )  const

Returns true, if the message has a trace header.

If traceHeader ().size () > 0, a trace header belongs to the message, else not.

template<class ContextT>
const TraceHeader& stm::tools::DspMessage< ContextT >::traceHeader (  )  const

Returns a reference to the message's trace header.

If traceHeader ().size () > 0, a trace header belongs to the message, else not.

template<class ContextT>
const byte_iterator_range& stm::tools::DspMessage< ContextT >::body (  )  const

Returns the byte range consisting of the message's body.

template<class ContextT>
const parent_type& stm::tools::DspMessage< ContextT >::parent (  ) 

Returns the message's parent.


© Copyright Tom Michaelis 2002-2007

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