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 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 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. | |
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. | |
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 Attributes | |
| bool | myFileLoadedFlag |
| bool | myPlayingFlag |
| bool | myLoopAtEnd |
| bool | myPlayOnLoadFlag |
| bool | myFileSavedFlag |
| bool | myFileFormatCurrentFlag |
| bool | myPausedFlag |
| bool | myFileIncompleteFlag |
| double | myPlaybackSpeed |
| bool | mySkippingPlayback |
| double | mySkippingPlaybackThreshold |
| DtString | myFilename |
| DtString | myLastErrorMessage |
Private Member Functions | |
| DtLgrPlaybackInterface (const DtLgrPlaybackInterface &) | |
| Not Implemented. | |
| DtLgrPlaybackInterface & | operator= (const DtLgrPlaybackInterface &) |
| Not Implemented. | |
Detailed Description
The class responsible for interfacing with the logger playback functionality.
Member Function Documentation
| static DtLgrPlaybackInterface* MAKLogger::DtLgrPlaybackInterface::createNonThreadsafe | ( | DtLogger & | logger, |
| const DtLgrPlaybackDriver & | driver | ||
| ) | [static] |
NonThreadsafe creator should not be called by User, used internally by create.
| virtual bool MAKLogger::DtLgrPlaybackInterface::isFileLoaded | ( | ) | const [virtual] |
Accessors.
Returns true if a file is loaded
| 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::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.
The documentation for this class was generated from the following file: