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 &)
virtual void	handleNotification (Field &)
	Handles all field changes related to fields created in appendFields().
virtual void	import (const FileListTools::FileList &fileList)=0
void	updateProgressIndicator (const std::string &info, float percState) override
void	_updateConsole (bool fullUpdate=true) override
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)
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 *)
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)
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="")
void	logFullFatalError (const std::string &func, MLErrorCode err, const std::string &reason)
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)
bool	getRichTextCodingFlag () const
void	setRichTextCodingFlag (bool useRichTextCoding)
	See getRichTextCodingFlag() for details.
bool	getUpdateProgressDuringInterruptChecksFlag () const
void	setUpdateProgressDuringInterruptChecksFlag (bool callUpdateProgressDuringInterruptChecks)
	See getUpdateProgressDuringInterruptChecksFlag() for details.
void	setStatusUpdateTimeIntervalInSeconds (double checkIntervalInSeconds)
double	getStatusUpdateTimeIntervalInSeconds () const
void	setCheckTimeIntervalInSeconds (double checkIntervalInSeconds)
double	getCheckTimeIntervalInSeconds () const
	Returns the currently set interrupt check time interval.
void	setInterruptCheckFunction (InterruptCheckFunc checkFunc, void *userData)
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)
NotifyField *	getInterruptCheckField () const
void	setStatusField (StringField *statusField)
	Set a StringField which always shall be updated with all logged messages; ignored if nullptr.
StringField *	getStatusField () const
virtual bool	wasInterrupted ()
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)
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 ()
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

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)
Static Protected Member Functions inherited from ml::ProgressLogger
static void	_updateProgressIndicatorCB (void *userData, const std::string &info, float 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.

Referenced by _getOutVolumeList().

◆ ~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.

References DirectDicomImportImporterBase().

◆ _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 )