MeVisLab Toolbox Reference
|
Base importer class for the DirectDicomImport module. More...
#include <mlDirectDicomImportImporterBase.h>
Public Member Functions | |
DirectDicomImportImporterBase (DirectDicomImport &ddiOp) | |
Constructor using a DirectDicomImport instance associated with. More... | |
~DirectDicomImportImporterBase () override | |
Destructor. More... | |
virtual void | appendFields (FieldContainer &) |
Appends all parameter fields related to the import class to fieldContainer. More... | |
virtual void | handleNotification (Field &) |
Handles all field changes related to fields created in appendFields(). More... | |
virtual void | import (const FileListTools::FileList &fileList)=0 |
Builds MultiFileVolume(s) from files provided by fileList. More... | |
void | updateProgressIndicator (const std::string &info, float percState) override |
Update a progress indicator which shows the message info and the percentage percState. More... | |
void | _updateConsole (bool fullUpdate=true) override |
Updates the output console if there is any. More... | |
virtual DicomConfigurableMessageFilterBaseRefCountedPtr | getMessageCollector () const |
Privides access to the message collector of the internally referenced DDI instance. More... | |
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. More... | |
virtual | ~ProgressLogger () |
Destructor. More... | |
void | setAutoNewLineTermination (bool on) |
Enable/disable automatic newline termination of logged messages. More... | |
bool | isAutoNewLineTerminationOn () const |
Returns enabled/disabled automatic newline termination of logged messages. More... | |
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. More... | |
void | logAnyMessage (std::string msg, unsigned int formatFlags=NoFlags) |
Log any string into the console. More... | |
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. More... | |
void | logError (const std::string &func, MLErrorCode err, const std::string &reason) |
See logFatalError() for details. More... | |
void | logWarning (const std::string &func, MLErrorCode err, const std::string &reason) |
See logFatalError() for details. More... | |
void | logInfo (const std::string &func, const std::string &reason="") |
Same as logFatalError, logError, and logWarning, but logging only information without error. More... | |
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. More... | |
void | logFullError (const std::string &func, MLErrorCode err, const std::string &reason) |
See logFullFatalError() for details. More... | |
void | logFullWarning (const std::string &func, MLErrorCode err, const std::string &reason) |
See logFullFatalError() for details. More... | |
void | logFullInfo (const std::string &func, const std::string &reason) |
Same as logFullFatalError, logFullError, and logFullWarning, but logging only information without error. More... | |
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. More... | |
void | setRichTextCodingFlag (bool useRichTextCoding) |
See getRichTextCodingFlag() for details. More... | |
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. More... | |
void | setUpdateProgressDuringInterruptChecksFlag (bool callUpdateProgressDuringInterruptChecks) |
See getUpdateProgressDuringInterruptChecksFlag() for details. More... | |
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. More... | |
double | getStatusUpdateTimeIntervalInSeconds () const |
Returns the currently set Module::updateProgress() call time interval when status fields are updated. More... | |
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. More... | |
double | getCheckTimeIntervalInSeconds () const |
Returns the currently set interrupt check time interval. More... | |
void | setInterruptCheckFunction (InterruptCheckFunc checkFunc, void *userData) |
Set a function which actually does a check for interrupts and its user data. More... | |
InterruptCheckFunc | getInterruptCheckFunction () const |
Returns the currently set function for interrupt checks. More... | |
void * | getInterruptCheckFunctionUserData () const |
Returns the currently set user data pointer for interrupt checks. More... | |
void | setInterruptCheckField (NotifyField *interruptField=nullptr) |
Set a NotifyField which shall be checked for button presses which mean interruptions; ignored if nullptr. More... | |
NotifyField * | getInterruptCheckField () const |
Return the currently set NotifyField pointer which shall be checked for button presses; default is nullptr. More... | |
void | setStatusField (StringField *statusField) |
Set a StringField which always shall be updated with all logged messages; ignored if nullptr. More... | |
StringField * | getStatusField () const |
Return the currently set StringField pointer which is updated on logged messages; default is nullptr. More... | |
virtual bool | wasInterrupted () |
If the interruption flag is already set then immediately true is returned. More... | |
virtual bool | getInterruptedFlag () const |
Returns current state of interruption flag (but does not check for interruption). More... | |
virtual void | setInterruptedFlag (bool wasInterrupted) |
Sets current state of interruption flag (but does not check for interruption). More... | |
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). More... | |
void | setHadFlags (bool hadFlag) |
Sets all had*Flags to hadFlag. More... | |
void | setFatalErrorMessagePrefix (const std::string &msg) |
Set/get prefixes for messages. More... | |
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(). More... | |
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. More... | |
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. More... | |
Protected Member Functions inherited from ml::ProgressLogger | |
std::string | _doAutoNewLineTerminate (const std::string &msg) const |
Helper to terminate msg with newline at end according. More... | |
virtual bool | _isStopPressed () const |
Checks for interruption with currently set _checkFunc or _interruptCheckField or returns false if not available. More... | |
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. More... | |
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. More... | |
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. More... | |
Base importer class for the DirectDicomImport module.
Definition at line 44 of file mlDirectDicomImportImporterBase.h.
ml::DirectDicomImportImporterBase::DirectDicomImportImporterBase | ( | DirectDicomImport & | ddiOp | ) |
Constructor using a DirectDicomImport instance associated with.
|
override |
Destructor.
|
protectedvirtual |
Modifiable list of DirectDicomImportVolumeReferences to which new volumes are going to be appended during the import process.
|
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.
|
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::DirectDicomImportOtherImporter, and ml::DirectDicomImportDPLImporter.
Definition at line 57 of file mlDirectDicomImportImporterBase.h.
|
virtual |
Privides access to the message collector of the internally referenced DDI instance.
|
inlinevirtual |
Handles all field changes related to fields created in appendFields().
Reimplemented in ml::DirectDicomImportOtherImporter, and ml::DirectDicomImportDPLImporter.
Definition at line 60 of file mlDirectDicomImportImporterBase.h.
|
pure virtual |
Builds MultiFileVolume(s) from files provided by fileList.
fileList | Manager for a map of file names associated with filter attributes. |
Implemented in ml::DirectDicomImportOtherImporter, and ml::DirectDicomImportDPLImporter.
|
overridevirtual |
Update a progress indicator which shows the message info and the percentage percState.
Implements empty base class method.
Reimplemented from ml::ProgressLogger.