Base importer class for the DirectDicomImport module. More...

#include <mlDirectDicomImportImporterBase.h>

Inheritance diagram for ml::DirectDicomImportImporterBase:

Public Member Functions
	DirectDicomImportImporterBase (DirectDicomImport &ddiOp)
	Constructor using a DirectDicomImport instance associated with.

	~DirectDicomImportImporterBase () override
	Destructor.

virtual void	appendFields (FieldContainer &)
	Appends all parameter fields related to the import class to fieldContainer.

virtual void	handleNotification (Field &)
	Handles all field changes related to fields created in appendFields().

virtual void	import (const FileListTools::FileList &fileList)=0
	Builds MultiFileVolume(s) from files provided by fileList.

void	updateProgressIndicator (const std::string &info, float percState) override
	Update a progress indicator which shows the message info and the percentage percState.

void	_updateConsole (bool fullUpdate=true) override
	Updates the output console if there is any.

virtual DicomConfigurableMessageFilterBaseRefCountedPtr	getMessageCollector () const
	Privides access to the message collector of the internally referenced DDI instance.

Public Member Functions inherited from ml::ProgressLogger
	ProgressLogger (std::stringstream outputStream=nullptr, NotifyField intCheckField=nullptr, StringField *statusField=nullptr, bool useRichTextCoding=true)
	Default and convenience constructor.

virtual	~ProgressLogger ()
	Destructor.

void	setAutoNewLineTermination (bool on)
	Enable/disable automatic newline termination of logged messages.

bool	isAutoNewLineTerminationOn () const
	Returns enabled/disabled automatic newline termination of logged messages.

virtual bool	messageHook (const ProgressLogger &, MLMessageType, const std::string , const std::string , MLErrorCode , const std::string , unsigned int *)
	All logging methods pass their function arguments through this hook which allows to collect all messages sent to the ProgressLogger.

void	logAnyMessage (std::string msg, unsigned int formatFlags=NoFlags)
	Log any string into the console.

void	logFatalError (const std::string &func, MLErrorCode err, const std::string &reason)
	Logs a fatal error, an error, warning or information to the defined output stream/console.

void	logError (const std::string &func, MLErrorCode err, const std::string &reason)
	See logFatalError() for details.

void	logWarning (const std::string &func, MLErrorCode err, const std::string &reason)
	See logFatalError() for details.

void	logInfo (const std::string &func, const std::string &reason="")
	Same as logFatalError, logError, and logWarning, but logging only information without error.

void	logFullFatalError (const std::string &func, MLErrorCode err, const std::string &reason)
	Logs a fatal error, an error, warning or information to the defined output stream/console and sends the information also to the MeVisLab error handler.

void	logFullError (const std::string &func, MLErrorCode err, const std::string &reason)
	See logFullFatalError() for details.

void	logFullWarning (const std::string &func, MLErrorCode err, const std::string &reason)
	See logFullFatalError() for details.

void	logFullInfo (const std::string &func, const std::string &reason)
	Same as logFullFatalError, logFullError, and logFullWarning, but logging only information without error.

bool	getRichTextCodingFlag () const
	If enabled (the default) then outputs newlines are always converted to hyper/rich text line separators ( ) and different message types get different colors; if false then contents they are always converted to normal newline characters and rich/hypertext color statements are not inserted.

void	setRichTextCodingFlag (bool useRichTextCoding)
	See getRichTextCodingFlag() for details.

bool	getUpdateProgressDuringInterruptChecksFlag () const
	If enabled then progress updates are performed on each interrupt check; this is useful to enable the busy cursor together with interrupt checks.

void	setUpdateProgressDuringInterruptChecksFlag (bool callUpdateProgressDuringInterruptChecks)
	See getUpdateProgressDuringInterruptChecksFlag() for details.

void	setStatusUpdateTimeIntervalInSeconds (double checkIntervalInSeconds)
	Sets a time interval which is used to avoid that too many Module::updateProgress() calls are performed to update the user interfaces (which usually are very expensive); default is 1 second.

double	getStatusUpdateTimeIntervalInSeconds () const
	Returns the currently set Module::updateProgress() call time interval when status fields are updated.

void	setCheckTimeIntervalInSeconds (double checkIntervalInSeconds)
	Sets a time interval which is used to avoid that too many interruption checks are performed which usually are very expensive, default is 1 second.

double	getCheckTimeIntervalInSeconds () const
	Returns the currently set interrupt check time interval.

void	setInterruptCheckFunction (InterruptCheckFunc checkFunc, void *userData)
	Set a function which actually does a check for interrupts and its user data.

InterruptCheckFunc	getInterruptCheckFunction () const
	Returns the currently set function for interrupt checks.

void *	getInterruptCheckFunctionUserData () const
	Returns the currently set user data pointer for interrupt checks.

void	setInterruptCheckField (NotifyField *interruptField=nullptr)
	Set a NotifyField which shall be checked for button presses which mean interruptions; ignored if nullptr.

NotifyField *	getInterruptCheckField () const
	Return the currently set NotifyField pointer which shall be checked for button presses; default is nullptr.

void	setStatusField (StringField *statusField)
	Set a StringField which always shall be updated with all logged messages; ignored if nullptr.

StringField *	getStatusField () const
	Return the currently set StringField pointer which is updated on logged messages; default is nullptr.

virtual bool	wasInterrupted ()
	If the interruption flag is already set then immediately true is returned.

virtual bool	getInterruptedFlag () const
	Returns current state of interruption flag (but does not check for interruption).

virtual void	setInterruptedFlag (bool wasInterrupted)
	Sets current state of interruption flag (but does not check for interruption).

virtual bool	orToInterruptedFlag (bool wasInterrupted)
	Update interruption flag by ORing the passed flag to the internal flag and then returning the flag (but does not check for interruption).

void	setHadFlags (bool hadFlag)
	Sets all had*Flags to hadFlag.

void	setFatalErrorMessagePrefix (const std::string &msg)
	Set/get prefixes for messages.

void	setErrorMessagePrefix (const std::string &msg)

void	setWarningMessagePrefix (const std::string &msg)

void	setInfoMessagePrefix (const std::string &msg)

std::string	getFatalErrorMessagePrefix () const

std::string	getErrorMessagePrefix () const

std::string	getWarningMessagePrefix () const

std::string	getInfoMessagePrefix () const

bool	hadFatalError () const
	Returns true if any fatal error, error, warning or info was logged; can be reset with corresponding setHad*Flag().

bool	hadError () const

bool	hadWarning () const

bool	hadInfo () const

void	setHadFatalErrorFlag (bool hadFatalErrorFlag)
	Sets the state of the corresponding _had* member; used to clear recent logging states.

void	setHadErrorFlag (bool hadErrorFlag)

void	setHadWarningFlag (bool hadWarningFlag)

void	setHadInfoFlag (bool hadInfoFlag)

Protected Member Functions
virtual MultiFileVolumeList &	_getOutVolumeList ()
	Modifiable list of DirectDicomImportVolumeReferences to which new volumes are going to be appended during the import process.

Protected Member Functions inherited from ml::ProgressLogger
std::string	_doAutoNewLineTerminate (const std::string &msg) const
	Helper to terminate msg with newline at end according.

virtual bool	_isStopPressed () const
	Checks for interruption with currently set _checkFunc or _interruptCheckField or returns false if not available.

Additional Inherited Members
Public Types inherited from ml::ProgressLogger
enum	FormatFlags { NoFlags = 0 , Bold = 1 , Green = 2 , Yellow = 4 , Red = 8 , Blue = 16 }
	Enumerator describing some formatting flags. More...

typedef bool(*	InterruptCheckFunc) (void *userData)
	Function type to check to for an interruption.

Static Public Member Functions inherited from ml::ProgressLogger
static bool	isPressedField (NotifyField *fieldToCheck)
	Convenience implementation of an interrupt check function if user of this class does not want to implement his own check callback but only wants to check a NotifyField for presses.

Static Protected Member Functions inherited from ml::ProgressLogger
static void	_updateProgressIndicatorCB (void *userData, const std::string &info, float state)
	Static callback version to update a progress indicator about the current import state.

Detailed Description

Base importer class for the DirectDicomImport module.

Definition at line 44 of file mlDirectDicomImportImporterBase.h.

Constructor & Destructor Documentation

◆ DirectDicomImportImporterBase()

ml::DirectDicomImportImporterBase::DirectDicomImportImporterBase ( DirectDicomImport & ddiOp )

Constructor using a DirectDicomImport instance associated with.

◆ ~DirectDicomImportImporterBase()

ml::DirectDicomImportImporterBase::~DirectDicomImportImporterBase ( )

override

Destructor.

Member Function Documentation

◆ _getOutVolumeList()

virtual MultiFileVolumeList & ml::DirectDicomImportImporterBase::_getOutVolumeList ( )

protectedvirtual

Modifiable list of DirectDicomImportVolumeReferences to which new volumes are going to be appended during the import process.

◆ _updateConsole()

void ml::DirectDicomImportImporterBase::_updateConsole ( bool fullUpdate = true )

overridevirtual

Updates the output console if there is any.

If fullUpdate is true then the console is surely updated, if false then a time saving sloppy update is made. Implements empty base class method.

Reimplemented from ml::ProgressLogger.

◆ appendFields()

virtual void ml::DirectDicomImportImporterBase::appendFields ( FieldContainer & )

inlinevirtual

Appends all parameter fields related to the import class to fieldContainer.

Usually called in a constructor where notification handling should be deactivated to avoid side effects to handleNotification.

Reimplemented in ml::DirectDicomImportDPLImporter, and ml::DirectDicomImportOtherImporter.

Definition at line 57 of file mlDirectDicomImportImporterBase.h.

◆ getMessageCollector()

virtual DicomConfigurableMessageFilterBaseRefCountedPtr ml::DirectDicomImportImporterBase::getMessageCollector ( ) const

virtual

Privides access to the message collector of the internally referenced DDI instance.

◆ handleNotification()

virtual void ml::DirectDicomImportImporterBase::handleNotification ( Field & )

inlinevirtual

Handles all field changes related to fields created in appendFields().

Reimplemented in ml::DirectDicomImportDPLImporter, and ml::DirectDicomImportOtherImporter.

Definition at line 60 of file mlDirectDicomImportImporterBase.h.

◆ import()

virtual void ml::DirectDicomImportImporterBase::import ( const FileListTools::FileList & fileList )

pure virtual

Builds MultiFileVolume(s) from files provided by fileList.

Parameters

fileList Manager for a map of file names associated with filter attributes.

Implemented in ml::DirectDicomImportDPLImporter, and ml::DirectDicomImportOtherImporter.

◆ updateProgressIndicator()

void ml::DirectDicomImportImporterBase::updateProgressIndicator	(	const std::string &	info,
		float	percState )