MAKLogger::DtRemoteControlDomainInterface Class Reference

Base class for handling commands and responses. More...

Inheritance diagram for MAKLogger::DtRemoteControlDomainInterface:

Collaboration diagram for MAKLogger::DtRemoteControlDomainInterface:

Public Member Functions
	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 void	processResponse (const DtLgrResponsePdu &responsePdu)=0
	Process a playback response PDU. More...
virtual DtLgrCommandId	lastSentCommand () const
	The last sent command ID. More...
virtual const DtEntityIdSet &	sourcesPendingResponse () 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 DtSequenceNumberSet &	pendingCommands () 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...

Protected Attributes
int	myDomainId
DtString	myDomainName
DtRemoteControlInterface *	myInterface
DtEntityIdSet	mySourcesPendingResponse
DtSequenceNumberSet	myPendingCommands
DtLgrCommandId	myLastSentCommand
const DtString	myTrueString
const DtString	myFalseString

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

Detailed Description

Base class for handling commands and responses.

Constructor & Destructor Documentation

MAKLogger::DtRemoteControlDomainInterface::DtRemoteControlDomainInterface	(	DtRemoteControlInterface *	remoteControlInterface,
		int	domainId
	)

Constructor.

virtual MAKLogger::DtRemoteControlDomainInterface::~DtRemoteControlDomainInterface ( )

virtual

Destructor.

MAKLogger::DtRemoteControlDomainInterface::DtRemoteControlDomainInterface ( const DtRemoteControlDomainInterface &  )

private

Not Implemented.

Member Function Documentation

virtual const DtString& MAKLogger::DtRemoteControlDomainInterface::boolToString ( bool  value ) const

virtual

Convert the bool value to a string.

virtual void MAKLogger::DtRemoteControlDomainInterface::clearPendingCommand ( DtSequenceNumber  number = 0 )

virtual

Clear pending command sequence number Clear all if number = 0.

virtual void MAKLogger::DtRemoteControlDomainInterface::commandAccepted ( DtSequenceNumber  sequenceNumber )

virtual

Command accepted.

virtual void MAKLogger::DtRemoteControlDomainInterface::commandRejected ( const DtEntityIdentifier &  source, DtSequenceNumber  sequenceNumber  )

virtual

Command rejected.

virtual void MAKLogger::DtRemoteControlDomainInterface::commandTimedOut ( DtSequenceNumber  sequenceNumber )

virtual

Command timedOut.

virtual bool MAKLogger::DtRemoteControlDomainInterface::isResponsePending ( ) const

virtual

At least one source is pending response.

virtual DtLgrCommandId MAKLogger::DtRemoteControlDomainInterface::lastSentCommand ( ) const

virtual

The last sent command ID.

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

private

Not Implemented.

virtual const DtSequenceNumberSet& MAKLogger::DtRemoteControlDomainInterface::pendingCommands ( ) const

virtual

Pending command sequence number Sequence number equal to 0 indicates command not pending.

Note: This value is stale for a rejected command unless manually cleared or replaced with a new command.

virtual void MAKLogger::DtRemoteControlDomainInterface::processResponse ( const DtLgrResponsePdu &  responsePdu )

pure virtual

Process a playback response PDU.

Implemented in MAKLogger::DtRemoteControlPlaybackInterface, MAKLogger::DtRemoteControlRecordInterface, MAKLogger::DtRemoteControlSystemInterface, MAKLogger::DtRemoteControlSharedInterface, MAKLogger::DtRemoteControlEditorInterface, and MAKLogger::DtRemoteControlSimulationInterface.

virtual void MAKLogger::DtRemoteControlDomainInterface::setSourcesPendingResponse ( const DtEntityIdSet &  sourceIds )

virtual

Set the sources whose response is pending.

virtual const DtEntityIdSet& MAKLogger::DtRemoteControlDomainInterface::sourcesPendingResponse ( ) const

virtual

Get the sources whose response is pending.

Member Data Documentation

int MAKLogger::DtRemoteControlDomainInterface::myDomainId

protected

DtString MAKLogger::DtRemoteControlDomainInterface::myDomainName

protected

const DtString MAKLogger::DtRemoteControlDomainInterface::myFalseString

protected

DtRemoteControlInterface* MAKLogger::DtRemoteControlDomainInterface::myInterface

protected

DtLgrCommandId MAKLogger::DtRemoteControlDomainInterface::myLastSentCommand

protected

DtSequenceNumberSet MAKLogger::DtRemoteControlDomainInterface::myPendingCommands

protected

DtEntityIdSet MAKLogger::DtRemoteControlDomainInterface::mySourcesPendingResponse

protected

const DtString MAKLogger::DtRemoteControlDomainInterface::myTrueString

protected

---

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

• remoteControlDomainInterface.h