MAK Data Logger API Documentation for DIS
List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions
DtRecordInterfacePrinter Class Reference

Prints message for received record responses. More...

+ Inheritance diagram for DtRecordInterfacePrinter:
+ Collaboration diagram for DtRecordInterfacePrinter:

Public Member Functions

 DtRecordInterfacePrinter (MAKLogger::DtRemoteControlInterface *rci)
 Constructor.
virtual ~DtRecordInterfacePrinter ()
 Destructor.
- Public Member Functions inherited from MAKLogger::DtRemoteControlRecordInterface
virtual ~DtRemoteControlRecordInterface ()
 Destructor.
virtual void processResponse (const DtLgrResponsePdu &responsePdu)
 Process a record response PDU.
virtual void clearReceivedResponseCounts ()
 Clear received responses counts.
virtual bool isFileOpened () const
 Check if file is opened.
virtual void resetIsFileOpened (bool fileOpened)
 Check if file is opened.
virtual bool isRecording () const
 Check if file is recording.
virtual void resetIsRecording (bool recording)
 Check if file is recording.
virtual bool isPaused () const
 Check if record is paused.
virtual void resetIsPaused (bool paused)
 Check if record is paused.
virtual bool isPauseOnRecord () const
 Check if pause on record is enabled.
virtual void resetIsPauseOnRecord (bool pauseOnRecord)
 Check if pause on record is enabled.
virtual DtSequenceNumber newFile (const DtFilename &filename, bool overwrite, bool constructFileNameAndPath, const DtEntityIdentifier &destination=DtRemoteControlInterface::wildcardAddress())
 Open new file for recording.
virtual DtSequenceNumber closeFile (const DtEntityIdentifier &destination=DtRemoteControlInterface::wildcardAddress())
 Close file Command guard: isFileOpen()
virtual DtSequenceNumber record (bool multipleFiles, const DtEntityIdentifier &destination=DtRemoteControlInterface::wildcardAddress())
 Start recording Command guard: isFileOpened() && (!isRecording() || isPaused())
virtual DtSequenceNumber cancel (const DtEntityIdentifier &destination=DtRemoteControlInterface::wildcardAddress())
 Cancel recording Command guard: isFileOpen()
virtual DtSequenceNumber stop (bool closeAndOpenForPlayback, const DtEntityIdentifier &destination=DtRemoteControlInterface::wildcardAddress())
 Stop recording Command guard: isRecording()
virtual DtSequenceNumber pause (const DtEntityIdentifier &destination=DtRemoteControlInterface::wildcardAddress())
 Pause recording Command guard: isRecording() && !isPaused()
virtual DtSequenceNumber unpause (const DtEntityIdentifier &destination=DtRemoteControlInterface::wildcardAddress())
 Unpause recording Command guard: isRecording()&& isPaused()
virtual DtSequenceNumber setPauseOnRecord (bool enable, const DtEntityIdentifier &destination=DtRemoteControlInterface::wildcardAddress())
 Set pause on record state.
- Public Member Functions inherited from MAKLogger::DtRemoteControlDomainInterface
 DtRemoteControlDomainInterface (DtRemoteControlInterface *remoteControlInterface, int domainId)
 Constructor.
virtual ~DtRemoteControlDomainInterface ()
 Destructor.
virtual void commandAccepted (DtSequenceNumber sequenceNumber)
 Command accepted.
virtual void commandRejected (const DtEntityIdentifier &source, DtSequenceNumber sequenceNumber)
 Command rejected.
virtual void commandTimedOut (DtSequenceNumber sequenceNumber)
 Command timedOut.
virtual DtLgrCommandId lastSentCommand () const
 The last sent command ID.
virtual const DtEntityIdSetsourcesPendingResponse () const
 Get the sources whose response is pending.
virtual void setSourcesPendingResponse (const DtEntityIdSet &sourceIds)
 Set the sources whose response is pending.
virtual bool isResponsePending () const
 At least one source is pending response.
virtual const DtSequenceNumberSetpendingCommands () const
 Pending command sequence number Sequence number equal to 0 indicates command not pending.
virtual void clearPendingCommand (DtSequenceNumber number=0)
 Clear pending command sequence number Clear all if number = 0.
virtual const DtString & boolToString (bool value) const
 Convert the bool value to a string.

Static Public Member Functions

static
MAKLogger::DtRemoteControlRecordInterface
create (MAKLogger::DtRemoteControlInterface *rci)
- Static Public Member Functions inherited from MAKLogger::DtRemoteControlRecordInterface
static const char * commandToString (int command)
 Convert the command/response identifier to a string.

Protected Member Functions

Process record response
virtual void newFileOpened (const DtString &fileName)
 The specified file was opened by all connected loggers Called after all connected loggers have responded individually.
virtual void newFileFailed (const DtEntityIdentifier &source, const DtString &reason)
 The specified file failed to create by the logger with the specified source ID This response short circuits the newFileOpened response, preventing it from being called until another new file is invoked.
virtual void fileClosed ()
 The record file was closed by all connected loggers.
virtual void recordingChanged (bool currentlyRecording)
 The recording state has changed for all connected loggers Called after all connected loggers have responded individually.
virtual void recordingPausedChanged (bool paused)
 The paused state has changed for all connected loggers Called after all connected loggers have responded individually.
virtual void fileEmptyChanged ()
 The empty file status has changed for all connected loggers.
virtual void pauseOnRecordAsChanged (bool enable)
 The pause on record state has changed for all connected loggers Called after all connected loggers have responded individually.
- Protected Member Functions inherited from MAKLogger::DtRemoteControlRecordInterface
virtual void newFileOpened (const DtEntityIdentifier &source, const DtString &filename)
 The specified file was opened by the logger with the specified source ID.
virtual void fileClosed (const DtEntityIdentifier &source)
 The record file was closed by the logger with the specified source ID.
virtual void recordingChanged (const DtEntityIdentifier &source, bool recordingState)
 The recording state changed for the logger with the specified source ID.
virtual void recordingPausedChanged (const DtEntityIdentifier &source, bool paused)
 The recording paused state changed for the logger with the specified source ID.
virtual void fileEmptyChanged (const DtEntityIdentifier &source)
 The empty file status has changed for the logger with the specified source ID.
virtual void pauseOnRecordAsChanged (const DtEntityIdentifier &source, bool enable)
 The pause on record state changed for the logger with the specified source ID.

Private Member Functions

 DtRecordInterfacePrinter (const DtRecordInterfacePrinter &)
 Not Implemented.
DtRecordInterfacePrinteroperator= (const DtRecordInterfacePrinter &)
 Not Implemented.

Additional Inherited Members

- Protected Attributes inherited from MAKLogger::DtRemoteControlRecordInterface
DtFilename myFileName
bool myIsFileOpened
bool myPendingIsFileOpened
bool myIsFileRecording
bool myPendingIsFileRecording
bool myIsPaused
bool myPendingIsPaused
bool myIsPauseOnRecord
bool myPendingIsPauseOnRecord
int myReceivedNewFileOpened
int myReceivedFileClosed
int myReceivedNewFileFailed
int myReceivedRecordingChanged
int myReceivedRecordingPausedChanged
int myReceivedFileEmptyChanged
int myReceivedPauseOnRecordAsChanged

Detailed Description

Prints message for received record responses.

Constructor & Destructor Documentation

DtRecordInterfacePrinter::DtRecordInterfacePrinter ( MAKLogger::DtRemoteControlInterface rci)

Constructor.

virtual DtRecordInterfacePrinter::~DtRecordInterfacePrinter ( )
virtual

Destructor.

DtRecordInterfacePrinter::DtRecordInterfacePrinter ( const DtRecordInterfacePrinter )
private

Not Implemented.

Member Function Documentation

static MAKLogger::DtRemoteControlRecordInterface* DtRecordInterfacePrinter::create ( MAKLogger::DtRemoteControlInterface rci)
static
virtual void DtRecordInterfacePrinter::fileClosed ( )
protectedvirtual

The record file was closed by all connected loggers.

Called after all connected loggers have responded individually

Reimplemented from MAKLogger::DtRemoteControlRecordInterface.

virtual void DtRecordInterfacePrinter::fileEmptyChanged ( )
protectedvirtual

The empty file status has changed for all connected loggers.

Called after all connected loggers have responded individually

Reimplemented from MAKLogger::DtRemoteControlRecordInterface.

virtual void DtRecordInterfacePrinter::newFileFailed ( const DtEntityIdentifier &  source,
const DtString &  reason 
)
protectedvirtual

The specified file failed to create by the logger with the specified source ID This response short circuits the newFileOpened response, preventing it from being called until another new file is invoked.

Reimplemented from MAKLogger::DtRemoteControlRecordInterface.

virtual void DtRecordInterfacePrinter::newFileOpened ( const DtString &  filename)
protectedvirtual

The specified file was opened by all connected loggers Called after all connected loggers have responded individually.

Reimplemented from MAKLogger::DtRemoteControlRecordInterface.

DtRecordInterfacePrinter& DtRecordInterfacePrinter::operator= ( const DtRecordInterfacePrinter )
private

Not Implemented.

virtual void DtRecordInterfacePrinter::pauseOnRecordAsChanged ( bool  enable)
protectedvirtual

The pause on record state has changed for all connected loggers Called after all connected loggers have responded individually.

Reimplemented from MAKLogger::DtRemoteControlRecordInterface.

virtual void DtRecordInterfacePrinter::recordingChanged ( bool  currentlyRecording)
protectedvirtual

The recording state has changed for all connected loggers Called after all connected loggers have responded individually.

Reimplemented from MAKLogger::DtRemoteControlRecordInterface.

virtual void DtRecordInterfacePrinter::recordingPausedChanged ( bool  paused)
protectedvirtual

The paused state has changed for all connected loggers Called after all connected loggers have responded individually.

Reimplemented from MAKLogger::DtRemoteControlRecordInterface.


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

Document ID: Generated on Thu Apr 11 12:13:00 EDT 2013 from SVN revision 126011
Copyright © 2005-2012 VT MÄK. All Rights Reserved (www.mak.com)