MAKLogger::DtLgrTimeInterface Class Reference

The class for interfacing with the loggers time state. More...

Inheritance diagram for MAKLogger::DtLgrTimeInterface:

Collaboration diagram for MAKLogger::DtLgrTimeInterface:

Public Types
typedef std::pair < DtAbsoluteTime, DtAbsoluteTime >	TimePair
typedef DtLgrTimeCommandFactory	Factory
typedef DtLgrTimeInterface	ThisClass
Public Types inherited from MAKLogger::DtLgrSystemInterface
typedef DtLgrSystemCommandFactory	Factory

Public Member Functions
virtual	~DtLgrTimeInterface ()
	DTOR.
virtual const DtAbsoluteTime &	currentTime () const
	Current time in the tape.
virtual const DtAbsoluteTime &	startTime () const
	Time to start must be >= of firstTime && <= currentTime.
virtual const DtAbsoluteTime &	stopTime () const
	Time to stop, must be <= of lastTime && >= currentTime.
virtual const DtAbsoluteTime &	firstTime () const
	First valid time, start time must be greater or equal to this time.
virtual const DtAbsoluteTime &	lastTime () const
	Last valid time, stop time must be less than or equal to this time.
virtual bool	atStartTime () const
	Return if current time is the startTime of file;.
virtual bool	atStopTime () const
	Return if current time is the startTime of file;.
void	currentTimeChanged (DtResponse)
	Callback for currentTimeChanged.
void	startStopTimesChanged (DtResponse)
	Callback for startStopTimesChanged.
void	firstLastTimesChanged (DtResponse)
	Callback for firstLastTimesChanged.
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.
Public Member Functions inherited from MAKLogger::DtCommandInterface
virtual	~DtCommandInterface ()
	Virtual Constructor.
virtual bool	update ()
	Remove all all commands from response queue Update is responsible for updating all responses and synchronizing state.
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.

Public Attributes
DtValueSignal< DtAbsoluteTime >	currentTimeChangedSignal
	Response handlers.
DtValueSignal< TimePair >	startStopTimesChangedSignal
DtValueSignal< DtAbsoluteTime >	firstTimeChangedSignal
DtValueSignal< DtAbsoluteTime >	lastTimeChangedSignal
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.

Protected Member Functions
	DtLgrTimeInterface (DtLogger &logger)
	Ctr with Logger and driver for initialization of state.
void	connectResponse (DtLgrCommandId, void(DtLgrTimeInterface::*)(DtResponse))
	Hooks up a DtResponse callback.
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)

Protected Attributes
DtAbsoluteTime	myCurrentTime
DtAbsoluteTime	myFirstTime
DtAbsoluteTime	myLastTime
TimePair	myStartStopTimes
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
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
Protected Types inherited from MAKLogger::DtCommandInterface
typedef std::map< DtCommand, DtResponseFunctorSP, std::less < DtCommand > >	DtResponseMap
	Callback types.

Detailed Description

The class for interfacing with the loggers time state.

Member Typedef Documentation

typedef DtLgrTimeCommandFactory MAKLogger::DtLgrTimeInterface::Factory

typedef DtLgrTimeInterface MAKLogger::DtLgrTimeInterface::ThisClass

typedef std::pair<DtAbsoluteTime,DtAbsoluteTime> MAKLogger::DtLgrTimeInterface::TimePair

Constructor & Destructor Documentation

MAKLogger::DtLgrTimeInterface::DtLgrTimeInterface ( DtLogger &  logger )

protected

Ctr with Logger and driver for initialization of state.

virtual MAKLogger::DtLgrTimeInterface::~DtLgrTimeInterface ( )

virtual

DTOR.

Member Function Documentation

virtual bool MAKLogger::DtLgrTimeInterface::atStartTime ( ) const

virtual

Return if current time is the startTime of file;.

virtual bool MAKLogger::DtLgrTimeInterface::atStopTime ( ) const

virtual

Return if current time is the startTime of file;.

void MAKLogger::DtLgrTimeInterface::connectResponse ( DtLgrCommandId  , void(DtLgrTimeInterface::*)(DtResponse)    )

protected

Hooks up a DtResponse callback.

virtual const DtAbsoluteTime& MAKLogger::DtLgrTimeInterface::currentTime ( ) const

virtual

Current time in the tape.

void MAKLogger::DtLgrTimeInterface::currentTimeChanged

(

DtResponse

)

Callback for currentTimeChanged.

void MAKLogger::DtLgrTimeInterface::firstLastTimesChanged

(

DtResponse

)

Callback for firstLastTimesChanged.

virtual const DtAbsoluteTime& MAKLogger::DtLgrTimeInterface::firstTime ( ) const

virtual

First valid time, start time must be greater or equal to this time.

virtual const DtAbsoluteTime& MAKLogger::DtLgrTimeInterface::lastTime ( ) const

virtual

Last valid time, stop time must be less than or equal to this time.

void MAKLogger::DtLgrTimeInterface::startStopTimesChanged

(

DtResponse

)

Callback for startStopTimesChanged.

virtual const DtAbsoluteTime& MAKLogger::DtLgrTimeInterface::startTime ( ) const

virtual

Time to start must be >= of firstTime && <= currentTime.

virtual const DtAbsoluteTime& MAKLogger::DtLgrTimeInterface::stopTime ( ) const

virtual

Time to stop, must be <= of lastTime && >= currentTime.

Member Data Documentation

DtValueSignal<DtAbsoluteTime> MAKLogger::DtLgrTimeInterface::currentTimeChangedSignal

Response handlers.

DtValueSignal<DtAbsoluteTime> MAKLogger::DtLgrTimeInterface::firstTimeChangedSignal

DtValueSignal<DtAbsoluteTime> MAKLogger::DtLgrTimeInterface::lastTimeChangedSignal

DtAbsoluteTime MAKLogger::DtLgrTimeInterface::myCurrentTime

protected

DtAbsoluteTime MAKLogger::DtLgrTimeInterface::myFirstTime

protected

DtAbsoluteTime MAKLogger::DtLgrTimeInterface::myLastTime

protected

TimePair MAKLogger::DtLgrTimeInterface::myStartStopTimes

protected

DtValueSignal<TimePair> MAKLogger::DtLgrTimeInterface::startStopTimesChangedSignal

---

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

• lgrTimeInterface.h