MAKLogger::DtCommandInterface Class Reference

The base class for command interface which allows an interface to send and receive commands. More...

Inheritance diagram for MAKLogger::DtCommandInterface:

Collaboration diagram for MAKLogger::DtCommandInterface:

Public Member Functions
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...

Protected Types
typedef std::map< DtCommand, DtResponseFunctorSP, std::less < DtCommand > >	DtResponseMap
	Callback types. More...

Protected Attributes
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
	DtCommandInterface (const DtCommandInterface &src)
	Makes non-copyable. More...
DtCommandInterface &	operator= (const DtCommandInterface &src)

Detailed Description

The base class for command interface which allows an interface to send and receive commands.

Member Typedef Documentation

typedef std::map<DtCommand,DtResponseFunctorSP,std::less<DtCommand> > MAKLogger::DtCommandInterface::DtResponseMap

protected

Callback types.

Constructor & Destructor Documentation

virtual MAKLogger::DtCommandInterface::~DtCommandInterface ( )

virtual

Virtual Constructor.

Destructor

MAKLogger::DtCommandInterface::DtCommandInterface ( const DtCommandInterface &  src )

private

Makes non-copyable.

Member Function Documentation

void MAKLogger::DtCommandInterface::addResponseHandler	(	const DtCommand &	command,
		DtResponseFunctorSP
	)

void MAKLogger::DtCommandInterface::disconnectFromDispatcher

(

)

Disconnects the interface from its dispatcher, this is for temporarily removing itself from the message queue.

bool MAKLogger::DtCommandInterface::executeResponse

(

DtResponse

command

)

Execute a response.

This function is not virtual since it should not be extended and for performance reasons.

DtCommandInterface& MAKLogger::DtCommandInterface::operator= ( const DtCommandInterface &  src )

private

void MAKLogger::DtCommandInterface::reconnectToDispatcher

(

)

Reconnect the interface to its dispatcher.

virtual void MAKLogger::DtCommandInterface::sendCommand ( const DtCommand &  ) const

virtual

Send a command to the interface's dispatcher.

virtual bool MAKLogger::DtCommandInterface::update ( )

virtual

Remove all all commands from response queue Update is responsible for updating all responses and synchronizing state.

Thus it will be called before all state queries (but need not be called for each individual call), since each state call will call update behind the scenes.

Reimplemented in MAKLogger::DtLgrFullInterface.

Member Data Documentation

DtCommandDispatcherSP MAKLogger::DtCommandInterface::myDispatcher

protected

A shared pointer to the interface's dispatcher.

DtResponseMap MAKLogger::DtCommandInterface::myResponseMap

protected

DtResponseQueueSP MAKLogger::DtCommandInterface::myResponseQueue

protected

The queue which stores commands sent to the interface from the dispatcher.

---

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

• lgrInterface.h