MAKLogger::DtLgrPlaybackInterface Class Reference

The class responsible for interfacing with the logger playback functionality. More...

Inheritance diagram for MAKLogger::DtLgrPlaybackInterface:

Collaboration diagram for MAKLogger::DtLgrPlaybackInterface:

Public Types
typedef DtLgrPlaybackCommandFactory	Factory
typedef DtLgrPlaybackInterface	ThisClass
Public Types inherited from MAKLogger::DtLgrTimeInterface
typedef std::pair < DtAbsoluteTime, DtAbsoluteTime >	TimePair
typedef DtLgrTimeCommandFactory	Factory
typedef DtLgrTimeInterface	ThisClass
Public Types inherited from MAKLogger::DtLgrSystemInterface
typedef DtLgrSystemCommandFactory	Factory

Public Member Functions
virtual	~DtLgrPlaybackInterface ()
	DTOR.
virtual void	openFile (const DtString &filename) const
	Send the command to open a file.
virtual void	closeFile () const
	Send the command to close a file.
virtual void	saveFile () const
	Send the command to save the file.
virtual void	saveFileAs (const DtString &filename) const
	Send the command to save the file as a different filename.
virtual void	revertFile () const
	Send the command to revert the file.
virtual void	play () const
	Send the command to start playback.
virtual void	stop () const
	Send the command to stop playback.
virtual void	pause () const
	Send the command to pause playback.
virtual void	unpause () const
	Send the command to unpause playback.
virtual void	togglePlayPause () const
	Send the command to toggle playing / paused.
virtual void	restart () const
	Send the command to restart playing.
virtual void	jumpToTime (DtAbsoluteTime time) const
	Send the command to jump to a specific time.
virtual void	setPlaybackSpeed (double speedMultiplier, bool skipping) const
	Send the command to control the playback speed.
virtual void	setSkippingPlaybackThreshold (double skippingThreshold) const
	Send the command to set the threshold when skipping playback is used.
virtual void	setStartStopTimes (DtAbsoluteTime startTime, DtAbsoluteTime stopTime) const
	Send the command to control the start and stop times.
virtual void	setLoopAtEnd (bool enable) const
	Send the command to control loop at end of file.
virtual void	setPlayOnLoad (bool playOnLoad) const
	Send the command to control play on load.
virtual void	setBackupOnSave (bool backup) const
	Send the command to set if a backup file is created upon save.
virtual void	recoverLastPacket ()
	Recover the last packet of an incomplete file.
virtual bool	isFileLoaded () const
	Accessors.
virtual bool	isFileSaved () const
	Returns true if the file is saved, false if it is not.
virtual bool	isPlaying () const
	Returns true if logger is playing else false.
virtual bool	isStopped () const
	Return Inverse of isPlaying.
virtual bool	isPaused () const
	Return if logger is paused.
virtual bool	loopAtEnd () const
	Return if logger loops at the end of playback.
virtual bool	playOnLoad () const
	Return if logger will play after loading a file.
virtual const DtString &	filename () const
	Get the name of the file, or "" if no file is loaded.
virtual double	playbackSpeed () const
	Get the playback speed multiplier.
virtual bool	skippingPlayback () const
	Get the skipping playback flag.
virtual double	skippingPlaybackThreshold () const
	Get the skipping playback threshold.
virtual bool	isFileFormatCurrent () const
	Get if the file format is current. Assumes a file is open.
virtual bool	isFileIncomplete () const
	Get if the file is incomplete (missing eof metadata). Assumes a file is open.
virtual bool	hasLastPacket () const
	Get if the file has its last packet. Assumes a file is open.
virtual bool	lastPacketRecovered () const
	Get if the file has its last packet recovered. Assumes a file is open.
Public Member Functions inherited from MAKLogger::DtLgrTimeInterface
virtual	~DtLgrTimeInterface ()
	DTOR.
virtual const DtAbsoluteTime &	currentTime () const
	Current time in the tape.
virtual const DtAbsoluteTime &	startTime () const
	Time to start must be >= of firstTime && <= currentTime.
virtual const DtAbsoluteTime &	stopTime () const
	Time to stop, must be <= of lastTime && >= currentTime.
virtual const DtAbsoluteTime &	firstTime () const
	First valid time, start time must be greater or equal to this time.
virtual const DtAbsoluteTime &	lastTime () const
	Last valid time, stop time must be less than or equal to this time.
virtual bool	atStartTime () const
	Return if current time is the startTime of file;.
virtual bool	atStopTime () const
	Return if current time is the startTime of file;.
void	currentTimeChanged (DtResponse)
	Callback for currentTimeChanged.
void	startStopTimesChanged (DtResponse)
	Callback for startStopTimesChanged.
void	firstLastTimesChanged (DtResponse)
	Callback for firstLastTimesChanged.
Public Member Functions inherited from MAKLogger::DtLgrSystemInterface
virtual	~DtLgrSystemInterface ()
	Constructor takes logger ref the interface will be attached to.
virtual void	issueTextCommand (const DtString &commandString) const
	Issue a text command to the logger to parse and execute.
virtual void	cancelLongOperation () const
	Attempt to cancel a long operation.
virtual void	deleteFile (const DtString &filename) const
	Delete a file.
virtual void	setNotifyLevel (int vlLevel, int lgrLevel) const
	Change the notify level.
virtual void	shutdown () const
	Tell the logger to shut down.
virtual bool	timeToShutdown () const
	Is it time to shut down.
virtual const DtString &	operationName () const
	Get the current operation name.
virtual const DtString &	operationMessage () const
	Get the current operation message.
virtual int	operationProgress () const
	Get the current operation progress.
virtual bool	operationInterruptible () const
	Is the current operation interruptible.
virtual bool	wasOperationCanceled () const
	Check to see if the last operation was canceled.
virtual void	installOutputListener (std::auto_ptr< DtLgrMessageOutputListener > listener) const
	Install an output listener.
bool	basicGuiFlag () const
	get the current basic gui flag.
Public Member Functions inherited from MAKLogger::DtCommandInterface
virtual	~DtCommandInterface ()
	Virtual Constructor.
virtual bool	update ()
	Remove all all commands from response queue Update is responsible for updating all responses and synchronizing state.
void	disconnectFromDispatcher ()
	Disconnects the interface from its dispatcher, this is for temporarily removing itself from the message queue.
void	reconnectToDispatcher ()
	Reconnect the interface to its dispatcher.
void	addResponseHandler (const DtCommand &command, DtResponseFunctorSP)
virtual void	sendCommand (const DtCommand &) const
	Send a command to the interface's dispatcher.
bool	executeResponse (DtResponse command)
	Execute a response.

Static Public Member Functions
static DtLgrPlaybackInterface *	create (DtLogger &)
	Thread safe interface creator.
static DtLgrPlaybackInterface *	createNonThreadsafe (DtLogger &logger, const DtLgrPlaybackDriver &driver)
	NonThreadsafe creator should not be called by User, used internally by create.

Public Attributes
DtValueSignal< DtString >	fileOpenedSignal
	Response signal handlers.
DtValueSignal< bool >	playbackChangedSignal
	Response signal handlers.
DtValueSignal< double >	playbackSpeedChangedSignal
	Response signal handlers.
DtValueSignal< bool >	loopAtEndChangedSignal
	Response signal handlers.
DtValueSignal< bool >	playOnLoadChangedSignal
	Response signal handlers.
DtValueSignal< bool >	fileSaveChangedSignal
	Response signal handlers.
DtValueSignal< DtString >	fileInvalidSignal
	Errors signals all alias the Last Error Message string.
DtValueSignal< DtString >	fileDoesNotExistSignal
	Response signal handlers.
Public Attributes inherited from MAKLogger::DtLgrTimeInterface
DtValueSignal< DtAbsoluteTime >	currentTimeChangedSignal
	Response handlers.
DtValueSignal< TimePair >	startStopTimesChangedSignal
DtValueSignal< DtAbsoluteTime >	firstTimeChangedSignal
DtValueSignal< DtAbsoluteTime >	lastTimeChangedSignal
Public Attributes inherited from MAKLogger::DtLgrSystemInterface
DtValueSignal< DtString >	messageSignal
	Message Response signal.
DtValueSignal< DtString >	consoleMessageSignal
	Message Response for console message.
DtValueSignal< bool >	operationSignal
	Operation signal which changes when an operation starts and stops ( true and false accordingly)
DtValueSignal< bool >	shutdownSignal
	Operation signal that is sent when a shutdown is initiated.
DtValueSignal< DtString >	operationMessageSignal
	Operation message signal.
DtValueSignal< int >	operationProgressSignal
	Operation progress signal.

Protected Member Functions
	DtLgrPlaybackInterface (DtLogger &logger, const DtLgrPlaybackDriver &driver)
	Ctr with Logger and driver for initialization of state.
void	connectResponseHandlers ()
	Non-virtual since called in CTOR.
void	connectResponse (DtLgrCommandId, void(DtLgrPlaybackInterface::*)(DtResponse))
	Non-virtual since called in CTOR.
Response handlers
void	fileOpened (DtResponse)
	File opened response handler.
void	fileClosed (DtResponse)
	File opened response handler.
void	fileChanged (DtResponse)
	File change response handler.
void	fileSaved (DtResponse)
	File saved response handler.
void	playbackChanged (DtResponse)
	File playback changed response handler.
void	playbackSpeedChanged (DtResponse)
	File playback speed changed response handler.
void	skippingPlaybackChanged (DtResponse)
	Skipping playback changed response handler.
void	skippingPlaybackThresholdChanged (DtResponse)
	Skipping playback threshold changed response handler.
void	fileInvalid (DtResponse)
	File invalid response handler.
void	fileDoesNotExist (DtResponse)
	File does not exist response handler.
void	fileIncomplete (DtResponse)
	File incomplete response handler.
void	loopAtEndChanged (DtResponse)
	File loop at end changed response handler.
void	playOnLoadChanged (DtResponse)
	File play on load changed response handler.
void	fileFormatCurrent (DtResponse)
	File play on load changed response handler.
void	pausedChanged (DtResponse)
	File play on load changed response handler.
Protected Member Functions inherited from MAKLogger::DtLgrTimeInterface
	DtLgrTimeInterface (DtLogger &logger)
	Ctr with Logger and driver for initialization of state.
void	connectResponse (DtLgrCommandId, void(DtLgrTimeInterface::*)(DtResponse))
	Hooks up a DtResponse callback.
Protected Member Functions inherited from MAKLogger::DtLgrSystemInterface
void	connectResponseHandler (DtLgrCommandId id, void(DtLgrSystemInterface::*function)(DtResponse))
void	messageReceived (DtResponse)
void	consoleMessageReceived (DtResponse)
void	requestShutdown (DtResponse)
void	basicGuiFlagSet (DtResponse)
void	longOperationStarted (DtResponse)
void	longOperationFinished (DtResponse)
void	longOperationUpdated (DtResponse)

Protected Attributes
bool	myFileLoadedFlag
bool	myPlayingFlag
bool	myLoopAtEnd
bool	myPlayOnLoadFlag
bool	myFileSavedFlag
bool	myFileFormatCurrentFlag
bool	myPausedFlag
bool	myFileIncompleteFlag
bool	myHasLastPacketFlag
bool	myLastPacketRecovered
double	myPlaybackSpeed
bool	mySkippingPlayback
double	mySkippingPlaybackThreshold
DtString	myFilename
DtString	myLastErrorMessage
Protected Attributes inherited from MAKLogger::DtLgrTimeInterface
DtAbsoluteTime	myCurrentTime
DtAbsoluteTime	myFirstTime
DtAbsoluteTime	myLastTime
TimePair	myStartStopTimes
Protected Attributes inherited from MAKLogger::DtLgrSystemInterface
DtThreadSafe< bool > *	myCancelFlag
DtString	myMessage
DtString	myConsoleMessage
DtString	myOperationName
DtString	myOperationMessage
bool	myOperationRunningFlag
int	myOperationProgress
bool	myOperationInterruptible
bool	myOperationCanceledFlag
bool	myTimeToShutdown
bool	myBasicGuiFlag
Protected Attributes inherited from MAKLogger::DtCommandInterface
DtResponseMap	myResponseMap
DtResponseQueueSP	myResponseQueue
	The queue which stores commands sent to the interface from the dispatcher.
DtCommandDispatcherSP	myDispatcher
	A shared pointer to the interface's dispatcher.

Private Member Functions
	DtLgrPlaybackInterface (const DtLgrPlaybackInterface &)
	Not Implemented.
DtLgrPlaybackInterface &	operator= (const DtLgrPlaybackInterface &)
	Not Implemented.

Additional Inherited Members
Protected Types inherited from MAKLogger::DtCommandInterface
typedef std::map< DtCommand, DtResponseFunctorSP, std::less < DtCommand > >	DtResponseMap
	Callback types.

Detailed Description

The class responsible for interfacing with the logger playback functionality.

Member Typedef Documentation

typedef DtLgrPlaybackCommandFactory MAKLogger::DtLgrPlaybackInterface::Factory

typedef DtLgrPlaybackInterface MAKLogger::DtLgrPlaybackInterface::ThisClass

Constructor & Destructor Documentation

MAKLogger::DtLgrPlaybackInterface::DtLgrPlaybackInterface ( DtLogger &  logger, const DtLgrPlaybackDriver &  driver  )

protected

Ctr with Logger and driver for initialization of state.

virtual MAKLogger::DtLgrPlaybackInterface::~DtLgrPlaybackInterface ( )

virtual

DTOR.

MAKLogger::DtLgrPlaybackInterface::DtLgrPlaybackInterface ( const DtLgrPlaybackInterface &  )

private

Not Implemented.

Member Function Documentation

virtual void MAKLogger::DtLgrPlaybackInterface::closeFile ( ) const

virtual

Send the command to close a file.

void MAKLogger::DtLgrPlaybackInterface::connectResponse ( DtLgrCommandId  , void(DtLgrPlaybackInterface::*)(DtResponse)    )

protected

Non-virtual since called in CTOR.

void MAKLogger::DtLgrPlaybackInterface::connectResponseHandlers ( )

protected

Non-virtual since called in CTOR.

static DtLgrPlaybackInterface* MAKLogger::DtLgrPlaybackInterface::create ( DtLogger &  )

static

Thread safe interface creator.

static DtLgrPlaybackInterface* MAKLogger::DtLgrPlaybackInterface::createNonThreadsafe ( DtLogger &  logger, const DtLgrPlaybackDriver &  driver  )

static

NonThreadsafe creator should not be called by User, used internally by create.

void MAKLogger::DtLgrPlaybackInterface::fileChanged ( DtResponse  )

protected

File change response handler.

void MAKLogger::DtLgrPlaybackInterface::fileClosed ( DtResponse  )

protected

File opened response handler.

void MAKLogger::DtLgrPlaybackInterface::fileDoesNotExist ( DtResponse  )

protected

File does not exist response handler.

void MAKLogger::DtLgrPlaybackInterface::fileFormatCurrent ( DtResponse  )

protected

File play on load changed response handler.

void MAKLogger::DtLgrPlaybackInterface::fileIncomplete ( DtResponse  )

protected

File incomplete response handler.

void MAKLogger::DtLgrPlaybackInterface::fileInvalid ( DtResponse  )

protected

File invalid response handler.

virtual const DtString& MAKLogger::DtLgrPlaybackInterface::filename ( ) const

virtual

Get the name of the file, or "" if no file is loaded.

void MAKLogger::DtLgrPlaybackInterface::fileOpened ( DtResponse  )

protected

File opened response handler.

void MAKLogger::DtLgrPlaybackInterface::fileSaved ( DtResponse  )

protected

File saved response handler.

virtual bool MAKLogger::DtLgrPlaybackInterface::hasLastPacket ( ) const

virtual

Get if the file has its last packet. Assumes a file is open.

virtual bool MAKLogger::DtLgrPlaybackInterface::isFileFormatCurrent ( ) const

virtual

Get if the file format is current. Assumes a file is open.

virtual bool MAKLogger::DtLgrPlaybackInterface::isFileIncomplete ( ) const

virtual

Get if the file is incomplete (missing eof metadata). Assumes a file is open.

virtual bool MAKLogger::DtLgrPlaybackInterface::isFileLoaded ( ) const

virtual

Accessors.

Returns true if a file is loaded

virtual bool MAKLogger::DtLgrPlaybackInterface::isFileSaved ( ) const

virtual

Returns true if the file is saved, false if it is not.

virtual bool MAKLogger::DtLgrPlaybackInterface::isPaused ( ) const

virtual

Return if logger is paused.

virtual bool MAKLogger::DtLgrPlaybackInterface::isPlaying ( ) const

virtual

Returns true if logger is playing else false.

virtual bool MAKLogger::DtLgrPlaybackInterface::isStopped ( ) const

virtual

Return Inverse of isPlaying.

virtual void MAKLogger::DtLgrPlaybackInterface::jumpToTime ( DtAbsoluteTime  time ) const

virtual

Send the command to jump to a specific time.

virtual bool MAKLogger::DtLgrPlaybackInterface::lastPacketRecovered ( ) const

virtual

Get if the file has its last packet recovered. Assumes a file is open.

virtual bool MAKLogger::DtLgrPlaybackInterface::loopAtEnd ( ) const

virtual

Return if logger loops at the end of playback.

void MAKLogger::DtLgrPlaybackInterface::loopAtEndChanged ( DtResponse  )

protected

File loop at end changed response handler.

virtual void MAKLogger::DtLgrPlaybackInterface::openFile ( const DtString &  filename ) const

virtual

Send the command to open a file.

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

private

Not Implemented.

virtual void MAKLogger::DtLgrPlaybackInterface::pause ( ) const

virtual

Send the command to pause playback.

void MAKLogger::DtLgrPlaybackInterface::pausedChanged ( DtResponse  )

protected

File play on load changed response handler.

virtual void MAKLogger::DtLgrPlaybackInterface::play ( ) const

virtual

Send the command to start playback.

void MAKLogger::DtLgrPlaybackInterface::playbackChanged ( DtResponse  )

protected

File playback changed response handler.

virtual double MAKLogger::DtLgrPlaybackInterface::playbackSpeed ( ) const

virtual

Get the playback speed multiplier.

void MAKLogger::DtLgrPlaybackInterface::playbackSpeedChanged ( DtResponse  )

protected

File playback speed changed response handler.

virtual bool MAKLogger::DtLgrPlaybackInterface::playOnLoad ( ) const

virtual

Return if logger will play after loading a file.

void MAKLogger::DtLgrPlaybackInterface::playOnLoadChanged ( DtResponse  )

protected

File play on load changed response handler.

virtual void MAKLogger::DtLgrPlaybackInterface::recoverLastPacket ( )

virtual

Recover the last packet of an incomplete file.

virtual void MAKLogger::DtLgrPlaybackInterface::restart ( ) const

virtual

Send the command to restart playing.

virtual void MAKLogger::DtLgrPlaybackInterface::revertFile ( ) const

virtual

Send the command to revert the file.

virtual void MAKLogger::DtLgrPlaybackInterface::saveFile ( ) const

virtual

Send the command to save the file.

virtual void MAKLogger::DtLgrPlaybackInterface::saveFileAs ( const DtString &  filename ) const

virtual

Send the command to save the file as a different filename.

virtual void MAKLogger::DtLgrPlaybackInterface::setBackupOnSave ( bool  backup ) const

virtual

Send the command to set if a backup file is created upon save.

virtual void MAKLogger::DtLgrPlaybackInterface::setLoopAtEnd ( bool  enable ) const

virtual

Send the command to control loop at end of file.

virtual void MAKLogger::DtLgrPlaybackInterface::setPlaybackSpeed ( double  speedMultiplier, bool  skipping  ) const

virtual

Send the command to control the playback speed.

Skipping indicates that only the checkpoints should be played at the given speed.

virtual void MAKLogger::DtLgrPlaybackInterface::setPlayOnLoad ( bool  playOnLoad ) const

virtual

Send the command to control play on load.

virtual void MAKLogger::DtLgrPlaybackInterface::setSkippingPlaybackThreshold ( double  skippingThreshold ) const

virtual

Send the command to set the threshold when skipping playback is used.

Skipping indicates that only the checkpoints should be played at the given speed.

virtual void MAKLogger::DtLgrPlaybackInterface::setStartStopTimes ( DtAbsoluteTime  startTime, DtAbsoluteTime  stopTime  ) const

virtual

Send the command to control the start and stop times.

virtual bool MAKLogger::DtLgrPlaybackInterface::skippingPlayback ( ) const

virtual

Get the skipping playback flag.

void MAKLogger::DtLgrPlaybackInterface::skippingPlaybackChanged ( DtResponse  )

protected

Skipping playback changed response handler.

virtual double MAKLogger::DtLgrPlaybackInterface::skippingPlaybackThreshold ( ) const

virtual

Get the skipping playback threshold.

void MAKLogger::DtLgrPlaybackInterface::skippingPlaybackThresholdChanged ( DtResponse  )

protected

Skipping playback threshold changed response handler.

virtual void MAKLogger::DtLgrPlaybackInterface::stop ( ) const

virtual

Send the command to stop playback.

virtual void MAKLogger::DtLgrPlaybackInterface::togglePlayPause ( ) const

virtual

Send the command to toggle playing / paused.

virtual void MAKLogger::DtLgrPlaybackInterface::unpause ( ) const

virtual

Send the command to unpause playback.

Member Data Documentation

DtValueSignal<DtString> MAKLogger::DtLgrPlaybackInterface::fileDoesNotExistSignal

Response signal handlers.

DtValueSignal<DtString> MAKLogger::DtLgrPlaybackInterface::fileInvalidSignal

Errors signals all alias the Last Error Message string.

DtValueSignal<DtString> MAKLogger::DtLgrPlaybackInterface::fileOpenedSignal

Response signal handlers.

DtValueSignal<bool> MAKLogger::DtLgrPlaybackInterface::fileSaveChangedSignal

Response signal handlers.

DtValueSignal<bool> MAKLogger::DtLgrPlaybackInterface::loopAtEndChangedSignal

Response signal handlers.

bool MAKLogger::DtLgrPlaybackInterface::myFileFormatCurrentFlag

protected

bool MAKLogger::DtLgrPlaybackInterface::myFileIncompleteFlag

protected

bool MAKLogger::DtLgrPlaybackInterface::myFileLoadedFlag

protected

DtString MAKLogger::DtLgrPlaybackInterface::myFilename

protected

bool MAKLogger::DtLgrPlaybackInterface::myFileSavedFlag

protected

bool MAKLogger::DtLgrPlaybackInterface::myHasLastPacketFlag

protected

DtString MAKLogger::DtLgrPlaybackInterface::myLastErrorMessage

protected

bool MAKLogger::DtLgrPlaybackInterface::myLastPacketRecovered

protected

bool MAKLogger::DtLgrPlaybackInterface::myLoopAtEnd

protected

bool MAKLogger::DtLgrPlaybackInterface::myPausedFlag

protected

double MAKLogger::DtLgrPlaybackInterface::myPlaybackSpeed

protected

bool MAKLogger::DtLgrPlaybackInterface::myPlayingFlag

protected

bool MAKLogger::DtLgrPlaybackInterface::myPlayOnLoadFlag

protected

bool MAKLogger::DtLgrPlaybackInterface::mySkippingPlayback

protected

double MAKLogger::DtLgrPlaybackInterface::mySkippingPlaybackThreshold

protected

DtValueSignal<bool> MAKLogger::DtLgrPlaybackInterface::playbackChangedSignal

Response signal handlers.

DtValueSignal<double> MAKLogger::DtLgrPlaybackInterface::playbackSpeedChangedSignal

Response signal handlers.

DtValueSignal<bool> MAKLogger::DtLgrPlaybackInterface::playOnLoadChangedSignal

Response signal handlers.

---

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

• lgrPlaybackInterface.h