MAKLogger::DtLgrPublisherInterface Class Reference

Responsible for defining the interface that Object publishers must have. More...

Inheritance diagram for MAKLogger::DtLgrPublisherInterface:

Collaboration diagram for MAKLogger::DtLgrPublisherInterface:

Public Member Functions
	DtLgrPublisherInterface ()
virtual	~DtLgrPublisherInterface ()
	DTOR.
virtual void	update (const DtStateMsg &msg, double scaling, bool isStatic)=0
virtual void	setExerciseId (unsigned char exerciseId)
	Set the exercise id.
virtual unsigned char	exerciseId () const
	Get the associated exercise id.
virtual void	sendUpdateAtScaleChangePoint (double oldScale, double newScale, bool wasStatic, bool isStatic)=0
	Sends an update when scaling changes.
virtual void	tick (double scaling, bool isStatic)=0
	Tick the publisher with a scaling value.
virtual bool	updateRegion (const DtStateMsg &msg)
	The given message has been decoded into the state repository of the publisher.
virtual void	setRegion (const DtDDMRegionSet &region)=0
	Set the DtDDMRegionSet to play back to.
virtual const DtDDMRegionSet &	publishingRegions () const =0
	Get the publishing regions.
virtual void	setStaticRegionFlag (bool enabled)
	Set status of static region.
virtual bool	staticRegionFlag () const
	Return bool: are regions static?
virtual bool	publishingToRegion (DtDDMRegionSP region)=0
	Determine if the publisher is already playing back to the region provided.
virtual void	setWaitingForRegionData (bool waitForData)
	In some cases, regions are set based on values from attribute updates.
virtual bool	waitingForRegionData ()
	Return bool: waiting for data required to set regions.

Protected Attributes
unsigned char	myExerciseId
bool	myWaitingForRegionData
bool	myStaticRegionFlag

Detailed Description

Responsible for defining the interface that Object publishers must have.

Constructor & Destructor Documentation

MAKLogger::DtLgrPublisherInterface::DtLgrPublisherInterface

(

)

virtual MAKLogger::DtLgrPublisherInterface::~DtLgrPublisherInterface ( )

virtual

DTOR.

Member Function Documentation

virtual unsigned char MAKLogger::DtLgrPublisherInterface::exerciseId ( ) const

virtual

Get the associated exercise id.

virtual const DtDDMRegionSet& MAKLogger::DtLgrPublisherInterface::publishingRegions ( ) const

pure virtual

Get the publishing regions.

Implemented in MAKLogger::DtHLAGenericPublisher, MAKLogger::DtLgrHlaAggregatePublisher, and MAKLogger::DtLgrHlaEntityPublisher.

virtual bool MAKLogger::DtLgrPublisherInterface::publishingToRegion ( DtDDMRegionSP  region )

pure virtual

Determine if the publisher is already playing back to the region provided.

Implemented in MAKLogger::DtHLAGenericPublisher, MAKLogger::DtLgrHlaAggregatePublisher, and MAKLogger::DtLgrHlaEntityPublisher.

virtual void MAKLogger::DtLgrPublisherInterface::sendUpdateAtScaleChangePoint ( double  oldScale, double  newScale, bool  wasStatic, bool  isStatic  )

pure virtual

Sends an update when scaling changes.

Implemented in MAKLogger::DtHLAGenericPublisher, MAKLogger::DtLgrHlaAggregatePublisher, and MAKLogger::DtLgrHlaEntityPublisher.

virtual void MAKLogger::DtLgrPublisherInterface::setExerciseId ( unsigned char  exerciseId )

virtual

Set the exercise id.

virtual void MAKLogger::DtLgrPublisherInterface::setRegion ( const DtDDMRegionSet &  region )

pure virtual

Set the DtDDMRegionSet to play back to.

Implemented in MAKLogger::DtHLAGenericPublisher, MAKLogger::DtLgrHlaAggregatePublisher, and MAKLogger::DtLgrHlaEntityPublisher.

virtual void MAKLogger::DtLgrPublisherInterface::setStaticRegionFlag ( bool  enabled )

virtual

Set status of static region.

When regions are static, region updates are not performed

virtual void MAKLogger::DtLgrPublisherInterface::setWaitingForRegionData ( bool  waitForData )

virtual

In some cases, regions are set based on values from attribute updates.

Set the status to indicate if the required attributes have been updated. When waiting for region data, updates may not be sent even when update is called.

virtual bool MAKLogger::DtLgrPublisherInterface::staticRegionFlag ( ) const

virtual

Return bool: are regions static?

virtual void MAKLogger::DtLgrPublisherInterface::tick ( double  scaling, bool  isStatic  )

pure virtual

Tick the publisher with a scaling value.

Implemented in MAKLogger::DtHLAGenericPublisher, MAKLogger::DtLgrHlaAggregatePublisher, and MAKLogger::DtLgrHlaEntityPublisher.

virtual void MAKLogger::DtLgrPublisherInterface::update ( const DtStateMsg &  msg, double  scaling, bool  isStatic  )

pure virtual

Implemented in MAKLogger::DtHLAGenericPublisher, MAKLogger::DtLgrHlaAggregatePublisher, and MAKLogger::DtLgrHlaEntityPublisher.

virtual bool MAKLogger::DtLgrPublisherInterface::updateRegion ( const DtStateMsg &  msg )

virtual

The given message has been decoded into the state repository of the publisher.

Called immediately after decoding the message so that no other state should have changed other than the state repository. Update the region if appropriate. Return boolean: region has changed?

Reimplemented in MAKLogger::DtLgrHlaDdmEntityPublisher.

virtual bool MAKLogger::DtLgrPublisherInterface::waitingForRegionData ( )

virtual

Return bool: waiting for data required to set regions.

When waiting for region data, updates may not be sent even when update is called.

Member Data Documentation

unsigned char MAKLogger::DtLgrPublisherInterface::myExerciseId

protected

bool MAKLogger::DtLgrPublisherInterface::myStaticRegionFlag

protected

bool MAKLogger::DtLgrPublisherInterface::myWaitingForRegionData

protected

---

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

• lgrPublisherInterface.h