Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
MAKLogger::DtMessagePipeline Class Reference

The message pipeline which takes messages from the input, passes them through the state and ultimately sends the to the output. More...

+ Collaboration diagram for MAKLogger::DtMessagePipeline:

List of all members.

Public Member Functions

 DtMessagePipeline ()
 CTOR.
virtual ~DtMessagePipeline ()
 DTOR.
virtual void tick ()
 Tick the pipeline moving packets from the input to the output.
virtual void bufferInputAndDiff (const DtAbsoluteTime &time, bool inclusive)
 Compound operation which stores the current state, compiles a new state up to the given time and sends the differences between the current state and new state.
virtual void reset ()
 Resets the pipeline.
virtual void activate ()
 Activate the pipeline.
virtual void deactivate ()
 Deactivate the pipeline.
virtual bool inputFlag () const
 Return the input flag.
virtual bool outputFlag () const
 Return the output flag.
virtual bool stateFlag () const
 Return the state flag.
virtual void setInputFlag (bool onOff)
 Set the input flag.
virtual void setOutputFlag (bool onOff)
 Set the output flag.
virtual void setStateFlag (bool onOff)
 Set the state flag.
virtual const DtMessageInputinput () const
 Return the input.
virtual DtMessageInputinput ()
 Return the input.
virtual const DtMessageOutputoutput () const
 Return the output.
virtual DtMessageOutputoutput ()
 Return the output.
virtual const DtMessageStatestate () const
 Return the state.
virtual DtMessageStatestate ()
 Return the state.
virtual void setInput (DtMessageInput *input)
 Set the input.
virtual void setOutput (DtMessageOutput *output)
 Set the output.
virtual void setState (DtMessageState *state)
 Set the state.
virtual void addOutputListener (DtLgrMessageOutputListener *listener)
 Add an output listener.
virtual void removeOutputListener (DtLgrMessageOutputListener *listener)
 Remove an output listener, the caller is responsible for deallocating the listener.
virtual void setPlaybackReadTimeLimit (double limit)
 Set the time limit on reads during playback.
virtual double playbackReadTimeLimit () const
 Get the time limit on reads during playback.

Protected Types

typedef std::list
< DtLgrMessageOutputListener * > 
OutputListeners

Protected Member Functions

 DtMessagePipeline (const DtMessagePipeline &)
 CopyCTOR not implemented.
DtMessagePipelineoperator= (const DtMessagePipeline &)
 Assignment operator not implemented.

Protected Attributes

bool myInputFlag
 Controls if the Message Controller reads Messages from the Input.
bool myOutputFlag
 Controls if the Message Controller sends Messages to Output.
bool myStateFlag
 Controls if the Message Controller sends Messages to State.
bool myModifierFlag
 Controls if the Message Controller sends Messages to Modifier.
bool myFilterFlag
 Controls if the Message Controller sends Messages to Filter.
DtMessageInputmyInput
 The message input source which the Message Controller gets Messages from.
DtMessageOutputmyOutput
 The message output source which the Message Controller sends Messages to.
DtMessageStatemyState
 The state which the Message Controller maintains.
OutputListeners myListeners
double myPlaybackReadTimeLimit
DtClock myLimitClock

Detailed Description

The message pipeline which takes messages from the input, passes them through the state and ultimately sends the to the output.


Member Function Documentation

virtual void MAKLogger::DtMessagePipeline::addOutputListener ( DtLgrMessageOutputListener listener) [virtual]

Add an output listener.

If there is a valid output the listener will attach to it. The listener is owned by the pipeline unless removed.

virtual void MAKLogger::DtMessagePipeline::bufferInputAndDiff ( const DtAbsoluteTime time,
bool  inclusive 
) [virtual]

Compound operation which stores the current state, compiles a new state up to the given time and sends the differences between the current state and new state.

New state will include changes from the given time or not based on provided flag.

Warning:
Stage flags are still respected.
virtual double MAKLogger::DtMessagePipeline::playbackReadTimeLimit ( ) const [virtual]

Get the time limit on reads during playback.

Units are seconds. A value less than zero indicates no limit.

virtual void MAKLogger::DtMessagePipeline::removeOutputListener ( DtLgrMessageOutputListener listener) [virtual]

Remove an output listener, the caller is responsible for deallocating the listener.

virtual void MAKLogger::DtMessagePipeline::reset ( ) [virtual]

Resets the pipeline.

This call is used internally when different drivers what to have control over the pipeline.

virtual void MAKLogger::DtMessagePipeline::setPlaybackReadTimeLimit ( double  limit) [virtual]

Set the time limit on reads during playback.

Units are seconds. A value less than zero indicates no limit.


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

Document ID: Generated on Tue Oct 11 19:41:03 EDT 2011 from SVN revision 107422
Copyright © 2005-2011 VT MÄK Inc. All Rights Reserved (www.mak.com)