MAK Data Logger API Documentation for HLA
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
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. More...
 
virtual void openFile (const DtString &filename, bool checkMediaFile) const
 Send Commands. More...
 
virtual void closeFile () const
 Send the command to close a file. More...
 
virtual void saveFile (const bool reopenAfterSave=true) const
 Send the command to save the file. More...
 
virtual void saveFileAs (const DtString &filename, const DtString &description, const bool writeDescription, const bool reopenAfterSave=true) const
 Send the command to save the file as a different filename, passing the current description. More...
 
virtual void revertFile () const
 Send the command to revert the file. More...
 
virtual void updateTapeDescription (const DtString description)
 Send the command to set the description to be written out to file on the next Save or Save As. More...
 
virtual void play () const
 Send the command to start playback. More...
 
virtual void stop () const
 Send the command to stop playback. More...
 
virtual void pause () const
 Send the command to pause playback. More...
 
virtual void unpause () const
 Send the command to unpause playback. More...
 
virtual void togglePlayPause () const
 Send the command to toggle playing / paused. More...
 
virtual void restart () const
 Send the command to restart playing. More...
 
virtual void jumpToTime (DtAbsoluteTime time) const
 Send the command to jump to a specific time. More...
 
virtual void setPlaybackSpeed (double speedMultiplier, bool skipping) const
 Send the command to control the playback speed. More...
 
virtual void setSkippingPlaybackThreshold (double skippingThreshold) const
 Send the command to set the threshold when skipping playback is used. More...
 
virtual void setSkippingPlaybackInteractions (bool skippingInteractions) const
 Send the command to set flag to send checkpointed interactions when skipping playback. More...
 
virtual void setPacketViewInterval (double viewInterval) const
 Send the command to control the packet view tick interval. More...
 
virtual void setFollowingInterval (double interval) const
 Send the command to change the following interval. More...
 
virtual void setFollowingExportInterval (double interval) const
 Send the command to change the following export interval. More...
 
virtual void setStartStopTimes (DtAbsoluteTime startTime, DtAbsoluteTime stopTime) const
 Send the command to control the start and stop times. More...
 
virtual void setLoopAtEnd (bool enable) const
 Send the command to control loop at end of file. More...
 
virtual void setPlayOnLoad (bool playOnLoad) const
 Send the command to control play on load. More...
 
virtual void setBackupOnSave (bool backup) const
 Send the command to set if a backup file is created upon save. More...
 
virtual void recoverLastPacket ()
 Recover the last packet of an incomplete file. More...
 
virtual void setMediaPlaybackAdjustments (double speedFactor, DtRelativeTime offset) const
 Set the playback media speed factor. More...
 
virtual void setMediaWindowHandle (void *windowHandle)
 Set the media playback window handle. More...
 
virtual void setMediaStreamConfiguration (const DtString &streamConfiguration) const
 Add a playback media to stream configuration. More...
 
virtual void setMediaWindowConfiguration (const DtString &streamConfiguration) const
 Add a playback media in window configuration. More...
 
virtual void setMediaStreamPipeline (const DtString &pipelines, const DtString &mediaFile)
 Set the playback media stream pipelines. More...
 
virtual void setMediaWindowPipeline (const DtString &pipelines, const DtString &mediaFile)
 Set the playback media window pipelines. More...
 
virtual void setMediaPlayByDefault (bool window, bool stream) const
 Set the playback video default values. More...
 
virtual void setMediaPlayToStreamParameters (const DtString &, int) const
 Set the playback streaming video host IP and port. More...
 
virtual void exposePlaybackMedia ()
 Signal to media playback to window needs to be exposed. More...
 
virtual bool isFileLoaded () const
 Accessors. More...
 
virtual bool isFileSaved () const
 Returns true if the file is saved, false if it is not. More...
 
virtual bool isPlaying () const
 Returns true if logger is playing else false. More...
 
virtual bool isStopped () const
 Return Inverse of isPlaying. More...
 
virtual bool isPaused () const
 Return if logger is paused. More...
 
virtual bool loopAtEnd () const
 Return if logger loops at the end of playback. More...
 
virtual bool playOnLoad () const
 Return if logger will play after loading a file. More...
 
virtual const DtStringfilename () const
 Get the name of the file, or "" if no file is loaded. More...
 
virtual double playbackSpeed () const
 Get the playback speed multiplier. More...
 
virtual bool skippingPlayback () const
 Get the skipping playback flag. More...
 
virtual double skippingPlaybackThreshold () const
 Get the skipping playback threshold. More...
 
virtual bool skippingPlaybackInteractions () const
 Get the skipping playback interactions flag. More...
 
virtual double packetViewInterval () const
 Get the packet view tick interval. More...
 
virtual double followingInterval () const
 Get the packet view tick interval. More...
 
virtual double followingExportInterval () const
 Get the packet view tick interval. More...
 
virtual bool isFileFormatCurrent () const
 Get if the file format is current. Assumes a file is open. More...
 
virtual bool isFileIncomplete () const
 Get if the file is incomplete (missing eof metadata). Assumes a file is open. More...
 
virtual bool hasLastPacket () const
 Get if the file has its last packet. Assumes a file is open. More...
 
virtual bool lastPacketRecovered () const
 Get if the file has its last packet recovered. Assumes a file is open. More...
 
virtual bool tapeDescriptionUpdated () const
 Whether there is an update of the description text pending to be written to file. More...
 
virtual const DtStringtapeDescription () const
 Retrieve the updated description text if exists. More...
 
virtual int fileVersion () const
 Retrieve the version number for the currently loaded file. More...
 
virtual bool isFileExpanding () const
 Get if the file has expanded. Assumes a file is open. More...
 
virtual double mediaSpeedFactor () const
 Get the speed adjustment factor applied to media playback. More...
 
virtual DtRelativeTime mediaOffset () const
 Get the offset applied to media playback. More...
 
virtual const DtStringmediaStreamConfiguration () const
 Get the playback media to stream configurations. More...
 
virtual const DtStringmediaWindowConfiguration () const
 Get the playback media in window configurations. More...
 
virtual bool mediaPlayInWindowByDefault () const
 Get the playback video default value. More...
 
virtual bool mediaPlayToStreamByDefault () const
 Get the playback video to stream default value. More...
 
virtual bool mediaPlayInWindowActive () const
 Get the playback video in window active value. More...
 
virtual DtPlayToStreamStatus mediaPlayToStreamStatus () const
 Get the playback video to stream status. More...
 
virtual const DtStringmediaPlayHost () const
 Get the playback streaming video host IP. More...
 
virtual int mediaPlayPort () const
 Get the playback streaming video Port. More...
 
- Public Member Functions inherited from MAKLogger::DtLgrTimeInterface
virtual ~DtLgrTimeInterface ()
 DTOR. More...
 
virtual const DtAbsoluteTimecurrentTime () const
 Current time in the tape. More...
 
virtual const DtAbsoluteTimestartTime () const
 Time to start must be >= of firstTime && <= currentTime. More...
 
virtual const DtAbsoluteTimestopTime () const
 Time to stop, must be <= of lastTime && >= currentTime. More...
 
virtual const DtAbsoluteTimefirstTime () const
 First valid time, start time must be greater or equal to this time. More...
 
virtual const DtAbsoluteTimelastTime () const
 Last valid time, stop time must be less than or equal to this time. More...
 
virtual bool atStartTime () const
 Return if current time is the startTime of file. More...
 
virtual bool atStopTime () const
 Return if current time is the stopTime of file. More...
 
void currentTimeChanged (DtResponse)
 Callback for currentTimeChanged. More...
 
void startStopTimesChanged (DtResponse)
 Callback for startStopTimesChanged. More...
 
void firstLastTimesChanged (DtResponse)
 Callback for firstLastTimesChanged. More...
 
- Public Member Functions inherited from MAKLogger::DtLgrSystemInterface
virtual ~DtLgrSystemInterface ()
 Constructor takes logger ref the interface will be attached to. More...
 
virtual void issueTextCommand (const DtString &commandString) const
 Issue a text command to the logger to parse and execute. More...
 
virtual void cancelLongOperation () const
 Attempt to cancel a long operation. More...
 
virtual void deleteFile (const DtString &filename) const
 Delete a file. More...
 
virtual void setNotifyLevel (int vlLevel, int lgrLevel) const
 Change the notify level. More...
 
virtual void shutdown () const
 Tell the logger to shut down. More...
 
virtual bool timeToShutdown () const
 Is it time to shut down. More...
 
virtual const DtStringoperationName () const
 Get the current operation name. More...
 
virtual const DtStringoperationMessage () const
 Get the current operation message. More...
 
virtual int operationProgress () const
 Get the current operation progress. More...
 
virtual bool operationInterruptible () const
 Is the current operation interruptible. More...
 
virtual bool wasOperationCanceled () const
 Check to see if the last operation was canceled. More...
 
virtual void installOutputListener (std::auto_ptr< DtLgrMessageOutputListener > listener) const
 Install an output listener. More...
 
bool basicGuiFlag () const
 get the current basic gui flag. More...
 
void setGuiConfigFilename (DtString guiConfigFilename)
 set name of GUI configuration file More...
 
DtString guiConfigFilename () const
 get name of GUI configuration file More...
 
void setPerformanceWarning (bool behind, DtTime amountBehind)
 set performance warning More...
 
bool isPerformanceWarningEnabled () const
 check if performance warning is enabled More...
 
DtTime tickOverheadTime () const
 returns amount of time logger has overrun its tick period More...
 
- Public Member Functions inherited from MAKLogger::DtCommandInterface
virtual ~DtCommandInterface ()
 Virtual Constructor. More...
 
virtual bool update ()
 Remove all all commands from response queue Update is responsible for updating all responses and synchronizing state. More...
 
void disconnectFromDispatcher ()
 Disconnects the interface from its dispatcher, this is for temporarily removing itself from the message queue. More...
 
void reconnectToDispatcher ()
 Reconnect the interface to its dispatcher. More...
 
void addResponseHandler (const DtCommand &command, DtResponseFunctorSP)
 
virtual void sendCommand (const DtCommand &) const
 Send a command to the interface's dispatcher. More...
 
bool executeResponse (DtResponse command)
 Execute a response. More...
 

Static Public Member Functions

static DtLgrPlaybackInterfacecreate (DtLogger &)
 Thread safe interface creator. More...
 
static DtLgrPlaybackInterfacecreateNonThreadsafe (DtLogger &logger, const DtLgrPlaybackDriver &driver)
 NonThreadsafe creator should not be called by User, used internally by create. More...
 

Public Attributes

DtValueSignal< DtStringfileOpenedSignal
 Response signal handlers. More...
 
DtValueSignal< bool > playbackChangedSignal
 Response signal handlers. More...
 
DtValueSignal< bool > pausedChangedSignal
 Response signal handlers. More...
 
DtValueSignal< double > playbackSpeedChangedSignal
 Response signal handlers. More...
 
DtValueSignal< bool > loopAtEndChangedSignal
 Response signal handlers. More...
 
DtValueSignal< bool > playOnLoadChangedSignal
 Response signal handlers. More...
 
DtValueSignal< bool > fileSaveChangedSignal
 Response signal handlers. More...
 
DtValueSignal< bool > fileExpandingSignal
 Response signal handlers. More...
 
DtValueSignal< DtAbsoluteTimejumpTimeChangedSignal
 Response signal handlers. More...
 
DtValueSignal< double > followIntervalChangedSignal
 Response signal handlers. More...
 
DtValueSignal< double > followExportIntervalChangedSignal
 Response signal handlers. More...
 
DtValueSignal< double > mediaSpeedFactorChangedSignal
 Response signal handlers. More...
 
DtValueSignal< DtRelativeTimemediaOffsetChangedSignal
 Response signal handlers. More...
 
DtValueSignal< DtStringmediaStreamConfigurationChangedSignal
 Response signal handlers. More...
 
DtValueSignal< DtStringmediaWindowConfigurationChangedSignal
 Response signal handlers. More...
 
DtValueSignal< bool > mediaPlayInWindowByDefaultChangedSignal
 Response signal handlers. More...
 
DtValueSignal< bool > mediaPlayToStreamByDefaultChangedSignal
 Response signal handlers. More...
 
DtValueSignal< DtStringmediaPlayHostChangedSignal
 Response signal handlers. More...
 
DtValueSignal< int > mediaPlayPortChangedSignal
 Response signal handlers. More...
 
DtValueSignal< bool > mediaPlayInWindowOperationSignal
 Response signal handlers. More...
 
DtValueSignal
< DtPlayToStreamStatus
mediaPlayToStreamOperationSignal
 Response signal handlers. More...
 
DtValueSignal< DtStringfileInvalidSignal
 Errors signals all alias the Last Error Message string. More...
 
DtValueSignal< DtStringfileDoesNotExistSignal
 Response signal handlers. More...
 
- Public Attributes inherited from MAKLogger::DtLgrTimeInterface
DtValueSignal< DtAbsoluteTimecurrentTimeChangedSignal
 Response handlers. More...
 
DtValueSignal< TimePairstartStopTimesChangedSignal
 
DtValueSignal< DtAbsoluteTimefirstTimeChangedSignal
 
DtValueSignal< DtAbsoluteTimelastTimeChangedSignal
 
- Public Attributes inherited from MAKLogger::DtLgrSystemInterface
DtValueSignal< DtStringmessageSignal
 Message Response signal. More...
 
DtValueSignal< DtStringconsoleMessageSignal
 Message Response for console message. More...
 
DtValueSignal< bool > operationSignal
 Operation signal which changes when an operation starts and stops ( true and false accordingly) More...
 
DtValueSignal< bool > shutdownSignal
 Operation signal that is sent when a shutdown is initiated. More...
 
DtValueSignal< DtStringoperationMessageSignal
 Operation message signal. More...
 
DtValueSignal< int > operationProgressSignal
 Operation progress signal. More...
 
DtValueSignal< bool > performanceWarningSignal
 Performance warning signal. More...
 

Protected Member Functions

 DtLgrPlaybackInterface (DtLogger &logger, const DtLgrPlaybackDriver &driver)
 Ctr with Logger and driver for initialization of state. More...
 
void connectResponseHandlers ()
 Non-virtual since called in CTOR. More...
 
void connectResponse (DtLgrCommandId, void(DtLgrPlaybackInterface::*)(DtResponse))
 Non-virtual since called in CTOR. More...
 
void fileOpened (DtResponse)
 Response handlers. More...
 
void fileClosed (DtResponse)
 File opened response handler. More...
 
void fileChanged (DtResponse)
 File change response handler. More...
 
void fileSaved (DtResponse)
 File saved response handler. More...
 
void playbackChanged (DtResponse)
 File playback changed response handler. More...
 
void playbackSpeedChanged (DtResponse)
 File playback speed changed response handler. More...
 
void skippingPlaybackChanged (DtResponse)
 Skipping playback changed response handler. More...
 
void skippingPlaybackThresholdChanged (DtResponse)
 Skipping playback threshold changed response handler. More...
 
void skippingPlaybackInteractionsChanged (DtResponse)
 Skipping playback changed response handler. More...
 
void packetViewIntervalChanged (DtResponse)
 File packet view tick interval changed response handler. More...
 
void followingIntervalChanged (DtResponse)
 Following interval changed response handler. More...
 
void followingExportIntervalChanged (DtResponse)
 Following export interval changed response handler. More...
 
void fileInvalid (DtResponse)
 File invalid response handler. More...
 
void fileDoesNotExist (DtResponse)
 File does not exist response handler. More...
 
void fileIncomplete (DtResponse)
 File incomplete response handler. More...
 
void loopAtEndChanged (DtResponse)
 File loop at end changed response handler. More...
 
void playOnLoadChanged (DtResponse)
 File play on load changed response handler. More...
 
void fileFormatCurrent (DtResponse)
 File play on load changed response handler. More...
 
void pausedChanged (DtResponse)
 File play on load changed response handler. More...
 
void tapeDescriptionChanged (DtResponse)
 Logger file description changed response handler. More...
 
void fileExpandingChanged (DtResponse)
 File opened response handler. More...
 
void jumpTimeChanged (DtResponse response)
 Jump in time occurred. More...
 
void mediaPlaybackAdjustmentsChanged (DtResponse response)
 Playback media speed factor changed. More...
 
void mediaPlayToStreamConfigurationChanged (DtResponse response)
 The media play to stream configuration has changed. More...
 
void mediaPlayInWindowConfigurationChanged (DtResponse response)
 Playback media window configuration added. More...
 
void mediaPlayByDefaultChanged (DtResponse response)
 video default settings changed. More...
 
void mediaPlayToStreamParametersChanged (DtResponse response)
 video streaming options changed. More...
 
void mediaPlayInWindowOperationActive (DtResponse response)
 video play in window active changed. More...
 
void mediaPlayToStreamOperationStatus (DtResponse response)
 video play to stream staus changed. More...
 
- Protected Member Functions inherited from MAKLogger::DtLgrTimeInterface
 DtLgrTimeInterface (DtLogger &logger)
 Ctr with Logger and driver for initialization of state. More...
 
void connectResponse (DtLgrCommandId, void(DtLgrTimeInterface::*)(DtResponse))
 Hooks up a DtResponse callback. More...
 
- 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)
 
void setGuiConfigFilename (DtResponse)
 
void performanceWarningReceived (DtResponse)
 

Protected Attributes

bool myFileLoadedFlag
 
bool myPlayingFlag
 
bool myLoopAtEnd
 
bool myPlayOnLoadFlag
 
bool myFileSavedFlag
 
bool myFileFormatCurrentFlag
 
bool myPausedFlag
 
bool myFileIncompleteFlag
 
bool myHasLastPacketFlag
 
bool myLastPacketRecovered
 
bool mySkippingPlayback
 
bool mySkippingPlaybackInteractions
 
bool myTapeDescriptionUpdated
 
bool myFileExpanding
 
bool myMediaWindowOperationFlag
 
DtPlayToStreamStatus myMediaStreamOperationStatus
 
int myFileVersion
 
double myPlaybackSpeed
 
double mySkippingPlaybackThreshold
 
double myPacketViewInterval
 
double myFollowingInterval
 
double myFollowingExportInterval
 
DtString myFilename
 
DtString myLastErrorMessage
 
DtString myTapeDescription
 
DtAbsoluteTime myJumpTime
 
double myMediaSpeedFactor
 
DtRelativeTime myMediaOffset
 
DtString myMediaStreamConfiguration
 
DtString myMediaWindowConfiguration
 
bool myMediaPlayInWindowByDefault
 
bool myMediaPlayToStreamByDefault
 
DtString myMediaPlayHost
 
int myMediaPlayPort
 
- 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
 
bool myPerformanceWarning
 
DtString myGuiConfigFilename
 
DtTime myTickOverheadTime
 
- Protected Attributes inherited from MAKLogger::DtCommandInterface
DtResponseMap myResponseMap
 
DtResponseQueueSP myResponseQueue
 The queue which stores commands sent to the interface from the dispatcher. More...
 
DtCommandDispatcherSP myDispatcher
 A shared pointer to the interface's dispatcher. More...
 

Private Member Functions

 DtLgrPlaybackInterface (const DtLgrPlaybackInterface &)
 Not Implemented. More...
 
DtLgrPlaybackInterfaceoperator= (const DtLgrPlaybackInterface &)
 Not Implemented. More...
 

Additional Inherited Members

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

Detailed Description

The class responsible for interfacing with the logger playback functionality.

Member Typedef Documentation

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.

virtual void MAKLogger::DtLgrPlaybackInterface::exposePlaybackMedia ( )
virtual

Signal to media playback to window needs to be exposed.

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::fileExpandingChanged ( DtResponse  )
protected

File opened 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

Response handlers.

File opened response handler.

void MAKLogger::DtLgrPlaybackInterface::fileSaved ( DtResponse  )
protected

File saved response handler.

virtual int MAKLogger::DtLgrPlaybackInterface::fileVersion ( ) const
virtual

Retrieve the version number for the currently loaded file.

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

Get the packet view tick interval.

void MAKLogger::DtLgrPlaybackInterface::followingExportIntervalChanged ( DtResponse  )
protected

Following export interval changed response handler.

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

Get the packet view tick interval.

void MAKLogger::DtLgrPlaybackInterface::followingIntervalChanged ( DtResponse  )
protected

Following interval changed 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::isFileExpanding ( ) const
virtual

Get if the file has expanded. 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.

void MAKLogger::DtLgrPlaybackInterface::jumpTimeChanged ( DtResponse  response)
protected

Jump in time occurred.

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 DtRelativeTime MAKLogger::DtLgrPlaybackInterface::mediaOffset ( ) const
virtual

Get the offset applied to media playback.

void MAKLogger::DtLgrPlaybackInterface::mediaPlaybackAdjustmentsChanged ( DtResponse  response)
protected

Playback media speed factor changed.

void MAKLogger::DtLgrPlaybackInterface::mediaPlayByDefaultChanged ( DtResponse  response)
protected

video default settings changed.

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

Get the playback streaming video host IP.

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

Get the playback video in window active value.

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

Get the playback video default value.

void MAKLogger::DtLgrPlaybackInterface::mediaPlayInWindowConfigurationChanged ( DtResponse  response)
protected

Playback media window configuration added.

void MAKLogger::DtLgrPlaybackInterface::mediaPlayInWindowOperationActive ( DtResponse  response)
protected

video play in window active changed.

virtual int MAKLogger::DtLgrPlaybackInterface::mediaPlayPort ( ) const
virtual

Get the playback streaming video Port.

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

Get the playback video to stream default value.

void MAKLogger::DtLgrPlaybackInterface::mediaPlayToStreamConfigurationChanged ( DtResponse  response)
protected

The media play to stream configuration has changed.

void MAKLogger::DtLgrPlaybackInterface::mediaPlayToStreamOperationStatus ( DtResponse  response)
protected

video play to stream staus changed.

void MAKLogger::DtLgrPlaybackInterface::mediaPlayToStreamParametersChanged ( DtResponse  response)
protected

video streaming options changed.

virtual DtPlayToStreamStatus MAKLogger::DtLgrPlaybackInterface::mediaPlayToStreamStatus ( ) const
virtual

Get the playback video to stream status.

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

Get the speed adjustment factor applied to media playback.

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

Get the playback media to stream configurations.

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

Get the playback media in window configurations.

virtual void MAKLogger::DtLgrPlaybackInterface::openFile ( const DtString filename,
bool  checkMediaFile 
) const
virtual

Send Commands.

Send the command to open a file.

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

Not Implemented.

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

Get the packet view tick interval.

void MAKLogger::DtLgrPlaybackInterface::packetViewIntervalChanged ( DtResponse  )
protected

File packet view tick interval changed response handler.

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 bool  reopenAfterSave = true) const
virtual

Send the command to save the file.

virtual void MAKLogger::DtLgrPlaybackInterface::saveFileAs ( const DtString filename,
const DtString description,
const bool  writeDescription,
const bool  reopenAfterSave = true 
) const
virtual

Send the command to save the file as a different filename, passing the current description.

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::setFollowingExportInterval ( double  interval) const
virtual

Send the command to change the following export interval.

virtual void MAKLogger::DtLgrPlaybackInterface::setFollowingInterval ( double  interval) const
virtual

Send the command to change the following interval.

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

Send the command to control loop at end of file.

virtual void MAKLogger::DtLgrPlaybackInterface::setMediaPlaybackAdjustments ( double  speedFactor,
DtRelativeTime  offset 
) const
virtual

Set the playback media speed factor.

virtual void MAKLogger::DtLgrPlaybackInterface::setMediaPlayByDefault ( bool  window,
bool  stream 
) const
virtual

Set the playback video default values.

virtual void MAKLogger::DtLgrPlaybackInterface::setMediaPlayToStreamParameters ( const DtString ,
int   
) const
virtual

Set the playback streaming video host IP and port.

virtual void MAKLogger::DtLgrPlaybackInterface::setMediaStreamConfiguration ( const DtString streamConfiguration) const
virtual

Add a playback media to stream configuration.

virtual void MAKLogger::DtLgrPlaybackInterface::setMediaStreamPipeline ( const DtString pipelines,
const DtString mediaFile 
)
virtual

Set the playback media stream pipelines.

virtual void MAKLogger::DtLgrPlaybackInterface::setMediaWindowConfiguration ( const DtString streamConfiguration) const
virtual

Add a playback media in window configuration.

virtual void MAKLogger::DtLgrPlaybackInterface::setMediaWindowHandle ( void *  windowHandle)
virtual

Set the media playback window handle.

virtual void MAKLogger::DtLgrPlaybackInterface::setMediaWindowPipeline ( const DtString pipelines,
const DtString mediaFile 
)
virtual

Set the playback media window pipelines.

virtual void MAKLogger::DtLgrPlaybackInterface::setPacketViewInterval ( double  viewInterval) const
virtual

Send the command to control the packet view tick interval.

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::setSkippingPlaybackInteractions ( bool  skippingInteractions) const
virtual

Send the command to set flag to send checkpointed interactions when skipping playback.

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 bool MAKLogger::DtLgrPlaybackInterface::skippingPlaybackInteractions ( ) const
virtual

Get the skipping playback interactions flag.

void MAKLogger::DtLgrPlaybackInterface::skippingPlaybackInteractionsChanged ( 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 const DtString& MAKLogger::DtLgrPlaybackInterface::tapeDescription ( ) const
virtual

Retrieve the updated description text if exists.

void MAKLogger::DtLgrPlaybackInterface::tapeDescriptionChanged ( DtResponse  )
protected

Logger file description changed response handler.

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

Whether there is an update of the description text pending to be written to file.

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.

virtual void MAKLogger::DtLgrPlaybackInterface::updateTapeDescription ( const DtString  description)
virtual

Send the command to set the description to be written out to file on the next Save or Save As.

This description write can be overridden by the next Save or Save As.

Member Data Documentation

DtValueSignal<DtString> MAKLogger::DtLgrPlaybackInterface::fileDoesNotExistSignal

Response signal handlers.

DtValueSignal<bool> MAKLogger::DtLgrPlaybackInterface::fileExpandingSignal

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<double> MAKLogger::DtLgrPlaybackInterface::followExportIntervalChangedSignal

Response signal handlers.

DtValueSignal<double> MAKLogger::DtLgrPlaybackInterface::followIntervalChangedSignal

Response signal handlers.

DtValueSignal<DtAbsoluteTime> MAKLogger::DtLgrPlaybackInterface::jumpTimeChangedSignal

Response signal handlers.

DtValueSignal<bool> MAKLogger::DtLgrPlaybackInterface::loopAtEndChangedSignal

Response signal handlers.

DtValueSignal<DtRelativeTime> MAKLogger::DtLgrPlaybackInterface::mediaOffsetChangedSignal

Response signal handlers.

DtValueSignal<DtString> MAKLogger::DtLgrPlaybackInterface::mediaPlayHostChangedSignal

Response signal handlers.

DtValueSignal<bool> MAKLogger::DtLgrPlaybackInterface::mediaPlayInWindowByDefaultChangedSignal

Response signal handlers.

DtValueSignal<bool> MAKLogger::DtLgrPlaybackInterface::mediaPlayInWindowOperationSignal

Response signal handlers.

DtValueSignal<int> MAKLogger::DtLgrPlaybackInterface::mediaPlayPortChangedSignal

Response signal handlers.

DtValueSignal<bool> MAKLogger::DtLgrPlaybackInterface::mediaPlayToStreamByDefaultChangedSignal

Response signal handlers.

DtValueSignal<DtPlayToStreamStatus> MAKLogger::DtLgrPlaybackInterface::mediaPlayToStreamOperationSignal

Response signal handlers.

DtValueSignal<double> MAKLogger::DtLgrPlaybackInterface::mediaSpeedFactorChangedSignal

Response signal handlers.

DtValueSignal<DtString> MAKLogger::DtLgrPlaybackInterface::mediaStreamConfigurationChangedSignal

Response signal handlers.

DtValueSignal<DtString> MAKLogger::DtLgrPlaybackInterface::mediaWindowConfigurationChangedSignal

Response signal handlers.

bool MAKLogger::DtLgrPlaybackInterface::myFileExpanding
protected
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
int MAKLogger::DtLgrPlaybackInterface::myFileVersion
protected
double MAKLogger::DtLgrPlaybackInterface::myFollowingExportInterval
protected
double MAKLogger::DtLgrPlaybackInterface::myFollowingInterval
protected
bool MAKLogger::DtLgrPlaybackInterface::myHasLastPacketFlag
protected
DtAbsoluteTime MAKLogger::DtLgrPlaybackInterface::myJumpTime
protected
DtString MAKLogger::DtLgrPlaybackInterface::myLastErrorMessage
protected
bool MAKLogger::DtLgrPlaybackInterface::myLastPacketRecovered
protected
bool MAKLogger::DtLgrPlaybackInterface::myLoopAtEnd
protected
DtRelativeTime MAKLogger::DtLgrPlaybackInterface::myMediaOffset
protected
DtString MAKLogger::DtLgrPlaybackInterface::myMediaPlayHost
protected
bool MAKLogger::DtLgrPlaybackInterface::myMediaPlayInWindowByDefault
protected
int MAKLogger::DtLgrPlaybackInterface::myMediaPlayPort
protected
bool MAKLogger::DtLgrPlaybackInterface::myMediaPlayToStreamByDefault
protected
double MAKLogger::DtLgrPlaybackInterface::myMediaSpeedFactor
protected
DtString MAKLogger::DtLgrPlaybackInterface::myMediaStreamConfiguration
protected
DtPlayToStreamStatus MAKLogger::DtLgrPlaybackInterface::myMediaStreamOperationStatus
protected
DtString MAKLogger::DtLgrPlaybackInterface::myMediaWindowConfiguration
protected
bool MAKLogger::DtLgrPlaybackInterface::myMediaWindowOperationFlag
protected
double MAKLogger::DtLgrPlaybackInterface::myPacketViewInterval
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
bool MAKLogger::DtLgrPlaybackInterface::mySkippingPlaybackInteractions
protected
double MAKLogger::DtLgrPlaybackInterface::mySkippingPlaybackThreshold
protected
DtString MAKLogger::DtLgrPlaybackInterface::myTapeDescription
protected
bool MAKLogger::DtLgrPlaybackInterface::myTapeDescriptionUpdated
protected
DtValueSignal<bool> MAKLogger::DtLgrPlaybackInterface::pausedChangedSignal

Response signal handlers.

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:

Document ID: Generated on Thu Jul 14 15:45:33 EDT 2022 from SVN revision 244827
Copyright © 2021 MAK Technologies. All Rights Reserved (www.mak.com)