MAK Data Logger API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
MAKLogger::DtRemoteControlSystemInterface Class Reference

Responsible for invoking system commands and processing system responses. More...

+ Inheritance diagram for MAKLogger::DtRemoteControlSystemInterface:
+ Collaboration diagram for MAKLogger::DtRemoteControlSystemInterface:

Public Member Functions

virtual ~DtRemoteControlSystemInterface ()
 Destructor. More...
 
virtual void processResponse (const DtLgrResponsePdu &responsePdu)
 Process a playback response PDU. More...
 
virtual void clearReceivedResponseCounts ()
 Clear received responses counts. More...
 
System Commands
virtual DtSequenceNumber shutdown (const DtEntityIdentifier &destination=DtRemoteControlInterface::wildcardAddress())
 Shutdown the logger execution. More...
 
virtual DtSequenceNumber deleteFile (const DtFilename &filename, const DtEntityIdentifier &destination=DtRemoteControlInterface::wildcardAddress())
 Remote logger will delete specified file Note: No response provided. More...
 
virtual DtSequenceNumber requestStateUpdate (const DtEntityIdentifier &id=DtRemoteControlInterface::wildcardAddress())
 Request a total state update. More...
 
virtual DtSequenceNumber requestToggleFlag (DtLgrCtrlFlagStates flag, const DtEntityIdentifier &id)
 Toggle the given flag. More...
 
- Public Member Functions inherited from MAKLogger::DtRemoteControlDomainInterface
 DtRemoteControlDomainInterface (DtRemoteControlInterface *remoteControlInterface, int domainId)
 Constructor. More...
 
virtual ~DtRemoteControlDomainInterface ()
 Destructor. More...
 
virtual void commandAccepted (DtSequenceNumber sequenceNumber)
 Command accepted. More...
 
virtual void commandRejected (const DtEntityIdentifier &source, DtSequenceNumber sequenceNumber)
 Command rejected. More...
 
virtual void commandTimedOut (DtSequenceNumber sequenceNumber)
 Command timedOut. More...
 
virtual DtLgrCommandId lastSentCommand () const
 The last sent command ID. More...
 
virtual const DtEntityIdSetsourcesPendingResponse () const
 Get the sources whose response is pending. More...
 
virtual void setSourcesPendingResponse (const DtEntityIdSet &sourceIds)
 Set the sources whose response is pending. More...
 
virtual bool isResponsePending () const
 At least one source is pending response. More...
 
virtual const DtSequenceNumberSetpendingCommands () const
 Pending command sequence number Sequence number equal to 0 indicates command not pending. More...
 
virtual void clearPendingCommand (DtSequenceNumber number=0)
 Clear pending command sequence number Clear all if number = 0. More...
 
virtual const DtString & boolToString (bool value) const
 Convert the bool value to a string. More...
 

Static Public Member Functions

static const char * commandToString (int command)
 Convert the command/response identifier to a string. More...
 
static void processTotalState (DtLgrTotalStatePdu *totalStatePdu, void *usr)
 Callback for total state. More...
 

Protected Member Functions

virtual void processTotalState (DtLgrTotalStatePdu *totalStatePdu)
 Total state info. More...
 
virtual void receivedTotalState ()
 Total state info Called after all connected loggers have responded individually. More...
 
virtual void fileDeleted (const DtString &fileName)
 The specified file was deleted from all loggers. More...
 
virtual void fileDeletionResult (const DtEntityIdentifier &source, const DtString &fileName, int deleteResult)
 The deletion of the specified file was not successful. More...
 
Process system response
virtual void message (const DtEntityIdentifier &source, const DtString &message)
 Text message. More...
 
virtual void consoleMessage (const DtEntityIdentifier &source, const DtString &message)
 Text message for console. More...
 
virtual void startLongOperation (const DtEntityIdentifier &source, const DtString &name, bool interruptable)
 A long operation was started. Indicate if it is interruptable. More...
 
virtual void finishLongOperation (const DtEntityIdentifier &source, bool canceled)
 A long operation has completed. Indicate if it finished because it was canceled. More...
 
virtual void fileDelete (const DtEntityIdentifier &source, const DtString &fileName, int deleteResult)
 The specified file was deleted from all loggers. More...
 

Protected Attributes

bool myPendingFileDelete
 
DtString myDeleteFileName
 
int myReceivedTotalState
 
int myReceivedFileDelete
 
- Protected Attributes inherited from MAKLogger::DtRemoteControlDomainInterface
int myDomainId
 
DtString myDomainName
 
DtRemoteControlInterfacemyInterface
 
DtEntityIdSet mySourcesPendingResponse
 
DtSequenceNumberSet myPendingCommands
 
DtLgrCommandId myLastSentCommand
 
const DtString myTrueString
 
const DtString myFalseString
 

Private Member Functions

 DtRemoteControlSystemInterface (const DtRemoteControlSystemInterface &)
 Not Implemented. More...
 
DtRemoteControlSystemInterfaceoperator= (const DtRemoteControlSystemInterface &)
 Not Implemented. More...
 

Detailed Description

Responsible for invoking system commands and processing system responses.

Constructor & Destructor Documentation

virtual MAKLogger::DtRemoteControlSystemInterface::~DtRemoteControlSystemInterface ( )
virtual

Destructor.

MAKLogger::DtRemoteControlSystemInterface::DtRemoteControlSystemInterface ( const DtRemoteControlSystemInterface )
private

Not Implemented.

Member Function Documentation

virtual void MAKLogger::DtRemoteControlSystemInterface::clearReceivedResponseCounts ( )
virtual

Clear received responses counts.

static const char* MAKLogger::DtRemoteControlSystemInterface::commandToString ( int  command)
static

Convert the command/response identifier to a string.

virtual void MAKLogger::DtRemoteControlSystemInterface::consoleMessage ( const DtEntityIdentifier &  source,
const DtString &  message 
)
protectedvirtual

Text message for console.

virtual DtSequenceNumber MAKLogger::DtRemoteControlSystemInterface::deleteFile ( const DtFilename &  filename,
const DtEntityIdentifier &  destination = DtRemoteControlInterface::wildcardAddress() 
)
virtual

Remote logger will delete specified file Note: No response provided.

virtual void MAKLogger::DtRemoteControlSystemInterface::fileDelete ( const DtEntityIdentifier &  source,
const DtString &  fileName,
int  deleteResult 
)
protectedvirtual

The specified file was deleted from all loggers.

virtual void MAKLogger::DtRemoteControlSystemInterface::fileDeleted ( const DtString &  fileName)
protectedvirtual

The specified file was deleted from all loggers.

Reimplemented in DtSystemInterfacePrinter.

virtual void MAKLogger::DtRemoteControlSystemInterface::fileDeletionResult ( const DtEntityIdentifier &  source,
const DtString &  fileName,
int  deleteResult 
)
protectedvirtual

The deletion of the specified file was not successful.

Reimplemented in DtSystemInterfacePrinter.

virtual void MAKLogger::DtRemoteControlSystemInterface::finishLongOperation ( const DtEntityIdentifier &  source,
bool  canceled 
)
protectedvirtual

A long operation has completed. Indicate if it finished because it was canceled.

virtual void MAKLogger::DtRemoteControlSystemInterface::message ( const DtEntityIdentifier &  source,
const DtString &  message 
)
protectedvirtual

Text message.

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

Not Implemented.

virtual void MAKLogger::DtRemoteControlSystemInterface::processResponse ( const DtLgrResponsePdu responsePdu)
virtual

Process a playback response PDU.

Implements MAKLogger::DtRemoteControlDomainInterface.

static void MAKLogger::DtRemoteControlSystemInterface::processTotalState ( DtLgrTotalStatePdu totalStatePdu,
void *  usr 
)
static

Callback for total state.

virtual void MAKLogger::DtRemoteControlSystemInterface::processTotalState ( DtLgrTotalStatePdu totalStatePdu)
protectedvirtual

Total state info.

virtual void MAKLogger::DtRemoteControlSystemInterface::receivedTotalState ( )
protectedvirtual

Total state info Called after all connected loggers have responded individually.

Reimplemented in DtSystemInterfacePrinter.

virtual DtSequenceNumber MAKLogger::DtRemoteControlSystemInterface::requestStateUpdate ( const DtEntityIdentifier &  id = DtRemoteControlInterface::wildcardAddress())
virtual

Request a total state update.

virtual DtSequenceNumber MAKLogger::DtRemoteControlSystemInterface::requestToggleFlag ( DtLgrCtrlFlagStates  flag,
const DtEntityIdentifier &  id 
)
virtual

Toggle the given flag.

virtual DtSequenceNumber MAKLogger::DtRemoteControlSystemInterface::shutdown ( const DtEntityIdentifier &  destination = DtRemoteControlInterface::wildcardAddress())
virtual

Shutdown the logger execution.

virtual void MAKLogger::DtRemoteControlSystemInterface::startLongOperation ( const DtEntityIdentifier &  source,
const DtString &  name,
bool  interruptable 
)
protectedvirtual

A long operation was started. Indicate if it is interruptable.

Member Data Documentation

DtString MAKLogger::DtRemoteControlSystemInterface::myDeleteFileName
protected
bool MAKLogger::DtRemoteControlSystemInterface::myPendingFileDelete
protected
int MAKLogger::DtRemoteControlSystemInterface::myReceivedFileDelete
protected
int MAKLogger::DtRemoteControlSystemInterface::myReceivedTotalState
protected

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

Document ID: Generated on Thu Dec 18 15:35:09 EST 2025 from SVN revision 282494
Copyright © 2024 MAK Technologies. All Rights Reserved (www.mak.com)