MAKLogger::DtLgrSystemInterface Class Reference

The class responsible for interfacing with the low level logger system functions. More...

Inheritance diagram for MAKLogger::DtLgrSystemInterface:

Collaboration diagram for MAKLogger::DtLgrSystemInterface:

Public Types
typedef DtLgrSystemCommandFactory	Factory

Public Member Functions
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 DtString &	operationName () const
	Get the current operation name. More...
virtual const DtString &	operationMessage () 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...

Public Attributes
DtValueSignal< DtString >	messageSignal
	Message Response signal. More...
DtValueSignal< DtString >	consoleMessageSignal
	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< DtString >	operationMessageSignal
	Operation message signal. More...
DtValueSignal< int >	operationProgressSignal
	Operation progress signal. More...
DtValueSignal< bool >	performanceWarningSignal
	Performance warning signal. More...

Protected Member Functions
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
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
	DtLgrSystemInterface (const DtLgrSystemInterface &)
	Not Implemented. More...
DtLgrSystemInterface &	operator= (const DtLgrSystemInterface &)
	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 low level logger system functions.

Member Typedef Documentation

typedef DtLgrSystemCommandFactory MAKLogger::DtLgrSystemInterface::Factory

Constructor & Destructor Documentation

virtual MAKLogger::DtLgrSystemInterface::~DtLgrSystemInterface ( )

virtual

Constructor takes logger ref the interface will be attached to.

DTOR.

MAKLogger::DtLgrSystemInterface::DtLgrSystemInterface ( const DtLgrSystemInterface &  )

private

Not Implemented.

Member Function Documentation

bool MAKLogger::DtLgrSystemInterface::basicGuiFlag

(

)

const

get the current basic gui flag.

void MAKLogger::DtLgrSystemInterface::basicGuiFlagSet ( DtResponse  )

protected

virtual void MAKLogger::DtLgrSystemInterface::cancelLongOperation ( ) const

virtual

Attempt to cancel a long operation.

void MAKLogger::DtLgrSystemInterface::connectResponseHandler ( DtLgrCommandId  id, void(DtLgrSystemInterface::*)(DtResponse)  function  )

protected

void MAKLogger::DtLgrSystemInterface::consoleMessageReceived ( DtResponse  )

protected

virtual void MAKLogger::DtLgrSystemInterface::deleteFile ( const DtString &  filename ) const

virtual

Delete a file.

DtString MAKLogger::DtLgrSystemInterface::guiConfigFilename

(

)

const

get name of GUI configuration file

virtual void MAKLogger::DtLgrSystemInterface::installOutputListener ( std::auto_ptr< DtLgrMessageOutputListener >  listener ) const

virtual

Install an output listener.

bool MAKLogger::DtLgrSystemInterface::isPerformanceWarningEnabled

(

)

const

check if performance warning is enabled

virtual void MAKLogger::DtLgrSystemInterface::issueTextCommand ( const DtString &  commandString ) const

virtual

Issue a text command to the logger to parse and execute.

void MAKLogger::DtLgrSystemInterface::longOperationFinished ( DtResponse  )

protected

void MAKLogger::DtLgrSystemInterface::longOperationStarted ( DtResponse  )

protected

void MAKLogger::DtLgrSystemInterface::longOperationUpdated ( DtResponse  )

protected

void MAKLogger::DtLgrSystemInterface::messageReceived ( DtResponse  )

protected

virtual bool MAKLogger::DtLgrSystemInterface::operationInterruptible ( ) const

virtual

Is the current operation interruptible.

virtual const DtString& MAKLogger::DtLgrSystemInterface::operationMessage ( ) const

virtual

Get the current operation message.

virtual const DtString& MAKLogger::DtLgrSystemInterface::operationName ( ) const

virtual

Get the current operation name.

virtual int MAKLogger::DtLgrSystemInterface::operationProgress ( ) const

virtual

Get the current operation progress.

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

private

Not Implemented.

void MAKLogger::DtLgrSystemInterface::performanceWarningReceived ( DtResponse  )

protected

void MAKLogger::DtLgrSystemInterface::requestShutdown ( DtResponse  )

protected

void MAKLogger::DtLgrSystemInterface::setGuiConfigFilename

(

DtString

guiConfigFilename

)

set name of GUI configuration file

void MAKLogger::DtLgrSystemInterface::setGuiConfigFilename ( DtResponse  )

protected

virtual void MAKLogger::DtLgrSystemInterface::setNotifyLevel ( int  vlLevel, int  lgrLevel  ) const

virtual

Change the notify level.

void MAKLogger::DtLgrSystemInterface::setPerformanceWarning	(	bool	behind,
		DtTime	amountBehind
	)

set performance warning

virtual void MAKLogger::DtLgrSystemInterface::shutdown ( ) const

virtual

Tell the logger to shut down.

DtTime MAKLogger::DtLgrSystemInterface::tickOverheadTime

(

)

const

returns amount of time logger has overrun its tick period

virtual bool MAKLogger::DtLgrSystemInterface::timeToShutdown ( ) const

virtual

Is it time to shut down.

virtual bool MAKLogger::DtLgrSystemInterface::wasOperationCanceled ( ) const

virtual

Check to see if the last operation was canceled.

Member Data Documentation

DtValueSignal<DtString> MAKLogger::DtLgrSystemInterface::consoleMessageSignal

Message Response for console message.

DtValueSignal<DtString> MAKLogger::DtLgrSystemInterface::messageSignal

Message Response signal.

bool MAKLogger::DtLgrSystemInterface::myBasicGuiFlag

protected

DtThreadSafe<bool>* MAKLogger::DtLgrSystemInterface::myCancelFlag

protected

DtString MAKLogger::DtLgrSystemInterface::myConsoleMessage

protected

DtString MAKLogger::DtLgrSystemInterface::myGuiConfigFilename

protected

DtString MAKLogger::DtLgrSystemInterface::myMessage

protected

bool MAKLogger::DtLgrSystemInterface::myOperationCanceledFlag

protected

bool MAKLogger::DtLgrSystemInterface::myOperationInterruptible

protected

DtString MAKLogger::DtLgrSystemInterface::myOperationMessage

protected

DtString MAKLogger::DtLgrSystemInterface::myOperationName

protected

int MAKLogger::DtLgrSystemInterface::myOperationProgress

protected

bool MAKLogger::DtLgrSystemInterface::myOperationRunningFlag

protected

bool MAKLogger::DtLgrSystemInterface::myPerformanceWarning

protected

DtTime MAKLogger::DtLgrSystemInterface::myTickOverheadTime

protected

bool MAKLogger::DtLgrSystemInterface::myTimeToShutdown

protected

DtValueSignal<DtString> MAKLogger::DtLgrSystemInterface::operationMessageSignal

Operation message signal.

DtValueSignal<int> MAKLogger::DtLgrSystemInterface::operationProgressSignal

Operation progress signal.

DtValueSignal<bool> MAKLogger::DtLgrSystemInterface::operationSignal

Operation signal which changes when an operation starts and stops ( true and false accordingly)

DtValueSignal<bool> MAKLogger::DtLgrSystemInterface::performanceWarningSignal

Performance warning signal.

DtValueSignal<bool> MAKLogger::DtLgrSystemInterface::shutdownSignal

Operation signal that is sent when a shutdown is initiated.

---

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

• lgrSystemInterface.h