The class which interfaces with the logger editor functionality. More...

Inheritance diagram for MAKLogger::DtLgrEditorInterface:

Collaboration diagram for MAKLogger::DtLgrEditorInterface:

Public Types
enum	FileDataOperations { DataAdded, DataDeleted, DataMoved }
	Data operation types. More...

enum	ExportType { UserExport, UserExportSelectionOnly, InternalExport }

typedef DtLgrEditorCommandFactory	Factory

typedef DtLgrEditorInterface	ThisClass

typedef std::map< DtString, DtLgrExportType >	ExportTypeMap

Public Types inherited from MAKLogger::DtLgrSystemInterface
typedef DtLgrSystemCommandFactory	Factory

Public Member Functions
virtual	~DtLgrEditorInterface ()
	DTOR. More...

virtual void	clearSection (const DtAbsoluteTime &start, const DtAbsoluteTime &stop) const
	Clear a section of a tape. More...

virtual void	cutSection (const DtAbsoluteTime &start, const DtAbsoluteTime &stop) const
	Cut a section of a tape. More...

virtual void	exportFile (const DtString &exportType, const DtString &filename, bool recheckpoint, bool openAfterExport) const
	Export a section of a tape. More...

virtual void	exportSection (const DtString &exportType, const DtString &filename, const DtAbsoluteTime &start, const DtAbsoluteTime &stop, const DtRelativeTime &offset, bool recheckpoint, bool openAfterExport) const
	Export a section of a tape. More...

virtual void	mergeInFile (const DtString &filename, const DtRelativeTime &offset) const
	Merge in a file. More...

virtual void	appendFileToEnd (const DtString &filename) const
	Append a file to the end. More...

virtual void	prefixFileToStart (const DtString &filename) const
	Append a file to the end. More...

virtual void	trimStart () const
	Trim empty leading time from tape. More...

virtual void	offsetTime (const DtRelativeTime &offset) const
	Offset the time in the logger tape. More...

virtual void	convertFile () const
	Convert the current file. More...

virtual void	addExportType (const DtString &fileFormat, const DtString &fileFilter, bool offsetData, bool generateData, ExportType exportType, std::auto_ptr< DtLgrPacketPrinter > printer) const
	Add and export type to the logger. More...

virtual const ExportTypeMap &	exportTypes () const
	Get a map of the current export types and their file filters. More...

virtual const DtAbsoluteTime &	lastOperationStart () const
	Get the last operation start time. More...

virtual const DtAbsoluteTime &	lastOperationEnd () const
	Get the last operation end time. More...

virtual const DtRelativeTime &	lastOperationOffset () const
	Get the last operation offset. More...

virtual const DtString &	lastOperationSource () const
	Get the last operation source name. More...

virtual const DtString &	completedExportType () const
	Get the last completed export type.. More...

virtual const DtString &	completedExportDestination () const
	Get the last completed export destination. More...

virtual void	setRecheckpointOnExport (bool recheckpoint) const
	Set the option to recheckpoint on export. More...

virtual bool	recheckpointOnExport () const
	Return the status of recheckpoint on export option. More...

Public Member Functions inherited from MAKLogger::DtLgrSystemInterface
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...

Static Public Member Functions
static DtLgrEditorInterface *	create (DtLogger &)
	Thread safe interface creator. More...

static DtLgrEditorInterface *	createNonThreadsafe (DtLogger &logger, const DtLgrEditorDriver &driver)
	NonThreadsafe creator should not be called by User, used internally by create. More...

Public Attributes
DtValueSignal< DtString >	exportTypeAddedSignal
	Signal that a export type has been added. More...

DtValueSignal< DtString >	exportCompletedSignal
	Signal that a export has been completed, value is export type. More...

DtValueSignal< DtString >	exportCanceledSignal
	Signal that a export has been completed, value is export type. More...

DtValueSignal< FileDataOperations >	dataOperationSignal
	Signal that a data operation has occurred. More...

Public Attributes inherited from MAKLogger::DtLgrSystemInterface
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	exportTypeAdded (DtResponse response)
	Export type added response handler. More...

void	dataAdded (DtResponse response)
	File Data Added response handler. More...

void	dataDeleted (DtResponse response)
	File Data Deleted response handler. More...

void	dataMoved (DtResponse response)
	File Data Moved response handler. More...

void	exportCompleted (DtResponse response)
	File Data Moved response handler. More...

void	recheckpointOnExportChanged (DtResponse response)
	Recheck on export optino changed. More...

	DtLgrEditorInterface (DtLogger &logger, const DtLgrEditorDriver &driver)
	Ctr with Logger and driver for initialization of state. More...

void	connectResponse (DtLgrCommandId id, void(DtLgrEditorInterface::*function)(DtResponse))
	Helper function to connect response handlers. More...

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)

Protected Attributes
ExportTypeMap	myExportTypes

DtString	myNewestExportType

FileDataOperations	myLastOperation

DtAbsoluteTime	myLastOperationStart

DtAbsoluteTime	myLastOperationEnd

DtRelativeTime	myLastOperationOffset

DtString	myLastOperationSource

DtString	myLastExportType

DtString	myLastExportName

bool	myRecheckpointOnExport

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. More...

DtCommandDispatcherSP	myDispatcher
	A shared pointer to the interface's dispatcher. More...

Private Member Functions
	DtLgrEditorInterface (const DtLgrEditorInterface &)
	Not Implemented. More...

DtLgrEditorInterface &	operator= (const DtLgrEditorInterface &)
	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 which interfaces with the logger editor functionality.

Member Typedef Documentation

typedef std::map<DtString,DtLgrExportType> MAKLogger::DtLgrEditorInterface::ExportTypeMap

typedef DtLgrEditorCommandFactory MAKLogger::DtLgrEditorInterface::Factory

typedef DtLgrEditorInterface MAKLogger::DtLgrEditorInterface::ThisClass

Member Enumeration Documentation

enum MAKLogger::DtLgrEditorInterface::ExportType

Enumerator
UserExport
UserExportSelectionOnly
InternalExport

enum MAKLogger::DtLgrEditorInterface::FileDataOperations

Data operation types.

Enumerator
DataAdded
DataDeleted
DataMoved

Constructor & Destructor Documentation

virtual MAKLogger::DtLgrEditorInterface::~DtLgrEditorInterface ( )

virtual

DTOR.

MAKLogger::DtLgrEditorInterface::DtLgrEditorInterface	(	DtLogger &	logger,
		const DtLgrEditorDriver &	driver
	)

protected

Ctr with Logger and driver for initialization of state.

MAKLogger::DtLgrEditorInterface::DtLgrEditorInterface ( const DtLgrEditorInterface & )

private

Not Implemented.

Member Function Documentation

virtual void MAKLogger::DtLgrEditorInterface::addExportType	(	const DtString &	fileFormat,
		const DtString &	fileFilter,
		bool	offsetData,
		bool	generateData,
		ExportType	exportType,
		std::auto_ptr< DtLgrPacketPrinter >	printer
	)		const

virtual

Add and export type to the logger.

All use and ownership of the printer object must be relinquished since it will move to a separate thread.

virtual void MAKLogger::DtLgrEditorInterface::appendFileToEnd ( const DtString & filename ) const

virtual

Append a file to the end.

virtual void MAKLogger::DtLgrEditorInterface::clearSection	(	const DtAbsoluteTime &	start,
		const DtAbsoluteTime &	stop
	)		const

virtual

Clear a section of a tape.

virtual const DtString& MAKLogger::DtLgrEditorInterface::completedExportDestination ( ) const

virtual

Get the last completed export destination.

virtual const DtString& MAKLogger::DtLgrEditorInterface::completedExportType ( ) const

virtual

Get the last completed export type..

void MAKLogger::DtLgrEditorInterface::connectResponse	(	DtLgrCommandId	id,
		void(DtLgrEditorInterface::*)(DtResponse)	function
	)

protected

Helper function to connect response handlers.

virtual void MAKLogger::DtLgrEditorInterface::convertFile ( ) const

virtual

Convert the current file.

static DtLgrEditorInterface* MAKLogger::DtLgrEditorInterface::create ( DtLogger & )

static

Thread safe interface creator.

static DtLgrEditorInterface* MAKLogger::DtLgrEditorInterface::createNonThreadsafe	(	DtLogger &	logger,
		const DtLgrEditorDriver &	driver
	)

static

NonThreadsafe creator should not be called by User, used internally by create.

virtual void MAKLogger::DtLgrEditorInterface::cutSection	(	const DtAbsoluteTime &	start,
		const DtAbsoluteTime &	stop
	)		const

virtual

Cut a section of a tape.

void MAKLogger::DtLgrEditorInterface::dataAdded ( DtResponse response )

protected

File Data Added response handler.

void MAKLogger::DtLgrEditorInterface::dataDeleted ( DtResponse response )

protected

File Data Deleted response handler.

void MAKLogger::DtLgrEditorInterface::dataMoved ( DtResponse response )

protected

File Data Moved response handler.

void MAKLogger::DtLgrEditorInterface::exportCompleted ( DtResponse response )

protected

File Data Moved response handler.

virtual void MAKLogger::DtLgrEditorInterface::exportFile	(	const DtString &	exportType,
		const DtString &	filename,
		bool	recheckpoint,
		bool	openAfterExport
	)		const

virtual

Export a section of a tape.

virtual void MAKLogger::DtLgrEditorInterface::exportSection	(	const DtString &	exportType,
		const DtString &	filename,
		const DtAbsoluteTime &	start,
		const DtAbsoluteTime &	stop,
		const DtRelativeTime &	offset,
		bool	recheckpoint,
		bool	openAfterExport
	)		const

virtual

Export a section of a tape.

void MAKLogger::DtLgrEditorInterface::exportTypeAdded ( DtResponse response )

protected

Export type added response handler.

virtual const ExportTypeMap& MAKLogger::DtLgrEditorInterface::exportTypes ( ) const

virtual

Get a map of the current export types and their file filters.

virtual const DtAbsoluteTime& MAKLogger::DtLgrEditorInterface::lastOperationEnd ( ) const

virtual

Get the last operation end time.

virtual const DtRelativeTime& MAKLogger::DtLgrEditorInterface::lastOperationOffset ( ) const

virtual

Get the last operation offset.

virtual const DtString& MAKLogger::DtLgrEditorInterface::lastOperationSource ( ) const

virtual

Get the last operation source name.

virtual const DtAbsoluteTime& MAKLogger::DtLgrEditorInterface::lastOperationStart ( ) const

virtual

Get the last operation start time.

virtual void MAKLogger::DtLgrEditorInterface::mergeInFile	(	const DtString &	filename,
		const DtRelativeTime &	offset
	)		const

virtual

Merge in a file.

virtual void MAKLogger::DtLgrEditorInterface::offsetTime ( const DtRelativeTime & offset ) const

virtual

Offset the time in the logger tape.

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

private

Not Implemented.

virtual void MAKLogger::DtLgrEditorInterface::prefixFileToStart ( const DtString & filename ) const

virtual

Append a file to the end.

virtual bool MAKLogger::DtLgrEditorInterface::recheckpointOnExport ( ) const

virtual

Return the status of recheckpoint on export option.

void MAKLogger::DtLgrEditorInterface::recheckpointOnExportChanged ( DtResponse response )

protected

Recheck on export optino changed.

virtual void MAKLogger::DtLgrEditorInterface::setRecheckpointOnExport ( bool recheckpoint ) const

virtual

Set the option to recheckpoint on export.

virtual void MAKLogger::DtLgrEditorInterface::trimStart ( ) const

virtual

Trim empty leading time from tape.

Member Data Documentation

DtValueSignal<FileDataOperations> MAKLogger::DtLgrEditorInterface::dataOperationSignal

Signal that a data operation has occurred.

DtValueSignal<DtString> MAKLogger::DtLgrEditorInterface::exportCanceledSignal

Signal that a export has been completed, value is export type.

DtValueSignal<DtString> MAKLogger::DtLgrEditorInterface::exportCompletedSignal

Signal that a export has been completed, value is export type.

DtValueSignal<DtString> MAKLogger::DtLgrEditorInterface::exportTypeAddedSignal

Signal that a export type has been added.

ExportTypeMap MAKLogger::DtLgrEditorInterface::myExportTypes

protected

DtString MAKLogger::DtLgrEditorInterface::myLastExportName

protected

DtString MAKLogger::DtLgrEditorInterface::myLastExportType

protected

FileDataOperations MAKLogger::DtLgrEditorInterface::myLastOperation

protected

DtAbsoluteTime MAKLogger::DtLgrEditorInterface::myLastOperationEnd

protected

DtRelativeTime MAKLogger::DtLgrEditorInterface::myLastOperationOffset

protected

DtString MAKLogger::DtLgrEditorInterface::myLastOperationSource

protected

DtAbsoluteTime MAKLogger::DtLgrEditorInterface::myLastOperationStart

protected

DtString MAKLogger::DtLgrEditorInterface::myNewestExportType

protected

bool MAKLogger::DtLgrEditorInterface::myRecheckpointOnExport

protected

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

lgrEditorInterface.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation