MAKLogger::DtLgrFullInterface Class Reference

Utility class which provides access to multiple interfaces. More...

Inheritance diagram for MAKLogger::DtLgrFullInterface:

Collaboration diagram for MAKLogger::DtLgrFullInterface:

Public Member Functions
virtual	~DtLgrFullInterface ()
	Protected virtual constructor, allows class to be replaced.
virtual bool	update ()
	Update all interfaces.
DtLgrPlaybackInterface *	playbackInterface ()
	Get a playback interface.
const DtLgrPlaybackInterface *	playbackInterface () const
	Get a playback interface.
DtLgrRecordInterface *	recordInterface ()
	Get a record interface.
const DtLgrRecordInterface *	recordInterface () const
	Get a record interface.
DtLgrEditorInterface *	editorInterface ()
	Get a editor interface.
const DtLgrEditorInterface *	editorInterface () const
	Get a editor interface.
DtLgrSimInterface *	simulationInterface ()
	Get a simulation interface.
const DtLgrSimInterface *	simulationInterface () const
	Get a simulation interface.
DtLgrSystemInterface *	systemInterface ()
	Get a system interface.
const DtLgrSystemInterface *	systemInterface () const
	Get a system interface.
Public Member Functions inherited from MAKLogger::DtLgrSystemInterface
virtual	~DtLgrSystemInterface ()
	Constructor takes logger ref the interface will be attached to.
virtual void	issueTextCommand (const DtString &commandString) const
	Issue a text command to the logger to parse and execute.
virtual void	cancelLongOperation () const
	Attempt to cancel a long operation.
virtual void	deleteFile (const DtString &filename) const
	Delete a file.
virtual void	setNotifyLevel (int vlLevel, int lgrLevel) const
	Change the notify level.
virtual void	shutdown () const
	Tell the logger to shut down.
virtual bool	timeToShutdown () const
	Is it time to shut down.
virtual const DtString &	operationName () const
	Get the current operation name.
virtual const DtString &	operationMessage () const
	Get the current operation message.
virtual int	operationProgress () const
	Get the current operation progress.
virtual bool	operationInterruptible () const
	Is the current operation interruptible.
virtual bool	wasOperationCanceled () const
	Check to see if the last operation was canceled.
virtual void	installOutputListener (std::auto_ptr< DtLgrMessageOutputListener > listener) const
	Install an output listener.
bool	basicGuiFlag () const
	get the current basic gui flag.
void	setGuiConfigFilename (DtString guiConfigFilename)
	set name of GUI configuration file
DtString	guiConfigFilename () const
	get name of GUI configuration file
void	setPerformanceWarning (bool behind, DtTime amountBehind)
	set performance warning
bool	isPerformanceWarningEnabled () const
	check if performance warning is enabled
DtTime	tickOverheadTime () const
	returns amount of time logger has overrun its tick period
Public Member Functions inherited from MAKLogger::DtCommandInterface
virtual	~DtCommandInterface ()
	Virtual Constructor.
void	disconnectFromDispatcher ()
	Disconnects the interface from its dispatcher, this is for temporarily removing itself from the message queue.
void	reconnectToDispatcher ()
	Reconnect the interface to its dispatcher.
void	addResponseHandler (const DtCommand &command, DtResponseFunctorSP)
virtual void	sendCommand (const DtCommand &) const
	Send a command to the interface's dispatcher.
bool	executeResponse (DtResponse command)
	Execute a response.

Protected Attributes
DtLgrSystemInterface *	mySystemInterface
DtLgrPlaybackInterface *	myPlaybackInterface
DtLgrRecordInterface *	myRecordInterface
DtLgrEditorInterface *	myEditorInterface
DtLgrSimInterface *	mySimulationInterface
bool	myProcessingUpdate
Protected Attributes inherited from MAKLogger::DtLgrSystemInterface
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.
DtCommandDispatcherSP	myDispatcher
	A shared pointer to the interface's dispatcher.

Additional Inherited Members
Public Types inherited from MAKLogger::DtLgrSystemInterface
typedef DtLgrSystemCommandFactory	Factory
Public Attributes inherited from MAKLogger::DtLgrSystemInterface
DtValueSignal< DtString >	messageSignal
	Message Response signal.
DtValueSignal< DtString >	consoleMessageSignal
	Message Response for console message.
DtValueSignal< bool >	operationSignal
	Operation signal which changes when an operation starts and stops ( true and false accordingly)
DtValueSignal< bool >	shutdownSignal
	Operation signal that is sent when a shutdown is initiated.
DtValueSignal< DtString >	operationMessageSignal
	Operation message signal.
DtValueSignal< int >	operationProgressSignal
	Operation progress signal.
DtValueSignal< bool >	performanceWarningSignal
	Performance warning signal.
Protected Types inherited from MAKLogger::DtCommandInterface
typedef std::map< DtCommand, DtResponseFunctorSP, std::less < DtCommand > >	DtResponseMap
	Callback types.
Protected Member Functions inherited from MAKLogger::DtLgrSystemInterface
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)

Detailed Description

Utility class which provides access to multiple interfaces.

Constructor & Destructor Documentation

virtual MAKLogger::DtLgrFullInterface::~DtLgrFullInterface ( )

virtual

Protected virtual constructor, allows class to be replaced.

Member Function Documentation

DtLgrEditorInterface* MAKLogger::DtLgrFullInterface::editorInterface

(

)

Get a editor interface.

const DtLgrEditorInterface* MAKLogger::DtLgrFullInterface::editorInterface

(

)

const

Get a editor interface.

DtLgrPlaybackInterface* MAKLogger::DtLgrFullInterface::playbackInterface

(

)

Get a playback interface.

const DtLgrPlaybackInterface* MAKLogger::DtLgrFullInterface::playbackInterface

(

)

const

Get a playback interface.

DtLgrRecordInterface* MAKLogger::DtLgrFullInterface::recordInterface

(

)

Get a record interface.

const DtLgrRecordInterface* MAKLogger::DtLgrFullInterface::recordInterface

(

)

const

Get a record interface.

DtLgrSimInterface* MAKLogger::DtLgrFullInterface::simulationInterface

(

)

Get a simulation interface.

const DtLgrSimInterface* MAKLogger::DtLgrFullInterface::simulationInterface

(

)

const

Get a simulation interface.

DtLgrSystemInterface* MAKLogger::DtLgrFullInterface::systemInterface

(

)

Get a system interface.

const DtLgrSystemInterface* MAKLogger::DtLgrFullInterface::systemInterface

(

)

const

Get a system interface.

virtual bool MAKLogger::DtLgrFullInterface::update ( )

virtual

Update all interfaces.

Reimplemented from MAKLogger::DtCommandInterface.

Member Data Documentation

DtLgrEditorInterface* MAKLogger::DtLgrFullInterface::myEditorInterface

protected

DtLgrPlaybackInterface* MAKLogger::DtLgrFullInterface::myPlaybackInterface

protected

bool MAKLogger::DtLgrFullInterface::myProcessingUpdate

protected

DtLgrRecordInterface* MAKLogger::DtLgrFullInterface::myRecordInterface

protected

DtLgrSimInterface* MAKLogger::DtLgrFullInterface::mySimulationInterface

protected

DtLgrSystemInterface* MAKLogger::DtLgrFullInterface::mySystemInterface

protected

---

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

• lgrFullInterface.h