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:

Public Member Functions
	DtMessagePipeline ()
	CTOR. More...
virtual	~DtMessagePipeline ()
	DTOR. More...
virtual void	tick ()
	Tick the pipeline moving packets from the input to the output. More...
virtual void	bufferInputAndDiff (const DtAbsoluteTime &time, bool inclusive, bool includeInteractions)
	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. More...
virtual void	reset ()
	Resets the pipeline. More...
virtual void	activate ()
	Activate the pipeline. More...
virtual void	deactivate ()
	Deactivate the pipeline. More...
virtual void	activateOutput ()
	Activate the output in the pipeline (assumes input and state already active) More...
virtual void	deactivateOutput ()
	Deactivate the output in the pipeline (assumes input and state remain active) More...
virtual bool	wasListeningOnIdle ()
	Return true if pipeline was listening on idle when reset (had input and state but no output) More...
virtual bool	isListeningOnIdle ()
	Return true if pipeline is listening on idle (has input and state but no output) More...
virtual bool	inputFlag () const
	Return the input flag. More...
virtual bool	outputFlag () const
	Return the output flag. More...
virtual bool	stateFlag () const
	Return the state flag. More...
virtual void	setInputFlag (bool onOff)
	Set the input flag. More...
virtual void	setOutputFlag (bool onOff)
	Set the output flag. More...
virtual void	setStateFlag (bool onOff)
	Set the state flag. More...
virtual const DtMessageInput *	input () const
	Return the input. More...
virtual DtMessageInput *	input ()
	Return the input. More...
virtual const DtMessageOutput *	output () const
	Return the output. More...
virtual DtMessageOutput *	output ()
	Return the output. More...
virtual const DtMessageState *	state () const
	Return the state. More...
virtual DtMessageState *	state ()
	Return the state. More...
virtual DtRelativeTime	startTime ()
	Return the time of the first packet received. More...
virtual DtRelativeTime	endTime ()
	Return the time of the last packet received. More...
virtual void	setInput (DtMessageInput *input)
	Set the input. More...
virtual void	setOutput (DtMessageOutput *output)
	Set the output. More...
virtual void	setState (DtMessageState *state)
	Set the state. More...
virtual void	addOutputListener (DtLgrMessageOutputListener *listener)
	Add an output listener. More...
virtual void	removeOutputListener (DtLgrMessageOutputListener *listener)
	Remove an output listener, the caller is responsible for deallocating the listener. More...
virtual void	setPlaybackReadTimeLimit (double limit)
	Set the time limit on reads during playback. More...
virtual double	playbackReadTimeLimit () const
	Get the time limit on reads during playback. More...

Protected Types
typedef std::list < DtLgrMessageOutputListener * >	OutputListeners

Protected Member Functions
	DtMessagePipeline (const DtMessagePipeline &)
	CopyCTOR not implemented. More...
DtMessagePipeline &	operator= (const DtMessagePipeline &)
	Assignment operator not implemented. More...

Protected Attributes
bool	myInputFlag
	Controls if the Message Controller reads Messages from the Input. More...
bool	myOutputFlag
	Controls if the Message Controller sends Messages to Output. More...
bool	myStateFlag
	Controls if the Message Controller sends Messages to State. More...
DtMessageInput *	myInput
	The message input source which the Message Controller gets Messages from. More...
DtMessageOutput *	myOutput
	The message output source which the Message Controller sends Messages to. More...
DtMessageState *	myState
	The state which the Message Controller maintains. More...
OutputListeners	myListeners
double	myPlaybackReadTimeLimit
DtClock	myLimitClock
DtRelativeTime	myStartTime
DtRelativeTime	myEndTime
bool	myPriorInputFlag
	Maintains flags status prior to reset. More...
bool	myPriorOutputFlag
	Maintains flags status prior to reset. More...
bool	myPriorStateFlag
	Maintains flags status prior to reset. More...

Detailed Description

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

Member Typedef Documentation

typedef std::list<DtLgrMessageOutputListener*> MAKLogger::DtMessagePipeline::OutputListeners

protected

Constructor & Destructor Documentation

MAKLogger::DtMessagePipeline::DtMessagePipeline

(

)

CTOR.

virtual MAKLogger::DtMessagePipeline::~DtMessagePipeline ( )

virtual

DTOR.

MAKLogger::DtMessagePipeline::DtMessagePipeline ( const DtMessagePipeline &  )

protected

CopyCTOR not implemented.

Member Function Documentation

virtual void MAKLogger::DtMessagePipeline::activate ( )

virtual

Activate the pipeline.

virtual void MAKLogger::DtMessagePipeline::activateOutput ( )

virtual

Activate the output in the pipeline (assumes input and state already active)

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, bool  includeInteractions  )

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 void MAKLogger::DtMessagePipeline::deactivate ( )

virtual

Deactivate the pipeline.

virtual void MAKLogger::DtMessagePipeline::deactivateOutput ( )

virtual

Deactivate the output in the pipeline (assumes input and state remain active)

virtual DtRelativeTime MAKLogger::DtMessagePipeline::endTime ( )

virtual

Return the time of the last packet received.

virtual const DtMessageInput* MAKLogger::DtMessagePipeline::input ( ) const

virtual

Return the input.

virtual DtMessageInput* MAKLogger::DtMessagePipeline::input ( )

virtual

Return the input.

virtual bool MAKLogger::DtMessagePipeline::inputFlag ( ) const

virtual

Return the input flag.

virtual bool MAKLogger::DtMessagePipeline::isListeningOnIdle ( )

virtual

Return true if pipeline is listening on idle (has input and state but no output)

DtMessagePipeline& MAKLogger::DtMessagePipeline::operator= ( const DtMessagePipeline &  )

protected

Assignment operator not implemented.

virtual const DtMessageOutput* MAKLogger::DtMessagePipeline::output ( ) const

virtual

Return the output.

virtual DtMessageOutput* MAKLogger::DtMessagePipeline::output ( )

virtual

Return the output.

virtual bool MAKLogger::DtMessagePipeline::outputFlag ( ) const

virtual

Return the output flag.

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::setInput ( DtMessageInput *  input )

virtual

Set the input.

virtual void MAKLogger::DtMessagePipeline::setInputFlag ( bool  onOff )

virtual

Set the input flag.

virtual void MAKLogger::DtMessagePipeline::setOutput ( DtMessageOutput *  output )

virtual

Set the output.

virtual void MAKLogger::DtMessagePipeline::setOutputFlag ( bool  onOff )

virtual

Set the output flag.

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.

virtual void MAKLogger::DtMessagePipeline::setState ( DtMessageState *  state )

virtual

Set the state.

virtual void MAKLogger::DtMessagePipeline::setStateFlag ( bool  onOff )

virtual

Set the state flag.

virtual DtRelativeTime MAKLogger::DtMessagePipeline::startTime ( )

virtual

Return the time of the first packet received.

virtual const DtMessageState* MAKLogger::DtMessagePipeline::state ( ) const

virtual

Return the state.

virtual DtMessageState* MAKLogger::DtMessagePipeline::state ( )

virtual

Return the state.

virtual bool MAKLogger::DtMessagePipeline::stateFlag ( ) const

virtual

Return the state flag.

virtual void MAKLogger::DtMessagePipeline::tick ( )

virtual

Tick the pipeline moving packets from the input to the output.

virtual bool MAKLogger::DtMessagePipeline::wasListeningOnIdle ( )

virtual

Return true if pipeline was listening on idle when reset (had input and state but no output)

Member Data Documentation

DtRelativeTime MAKLogger::DtMessagePipeline::myEndTime

protected

DtMessageInput* MAKLogger::DtMessagePipeline::myInput

protected

The message input source which the Message Controller gets Messages from.

bool MAKLogger::DtMessagePipeline::myInputFlag

protected

Controls if the Message Controller reads Messages from the Input.

DtClock MAKLogger::DtMessagePipeline::myLimitClock

protected

OutputListeners MAKLogger::DtMessagePipeline::myListeners

protected

DtMessageOutput* MAKLogger::DtMessagePipeline::myOutput

protected

The message output source which the Message Controller sends Messages to.

bool MAKLogger::DtMessagePipeline::myOutputFlag

protected

Controls if the Message Controller sends Messages to Output.

double MAKLogger::DtMessagePipeline::myPlaybackReadTimeLimit

protected

bool MAKLogger::DtMessagePipeline::myPriorInputFlag

protected

Maintains flags status prior to reset.

bool MAKLogger::DtMessagePipeline::myPriorOutputFlag

protected

Maintains flags status prior to reset.

bool MAKLogger::DtMessagePipeline::myPriorStateFlag

protected

Maintains flags status prior to reset.

DtRelativeTime MAKLogger::DtMessagePipeline::myStartTime

protected

DtMessageState* MAKLogger::DtMessagePipeline::myState

protected

The state which the Message Controller maintains.

bool MAKLogger::DtMessagePipeline::myStateFlag

protected

Controls if the Message Controller sends Messages to State.

---

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

• messagePipeline.h