Extended DPL logger class redirecting messages from the DPL to a DirectDicomImport instance. More...

#include <mlDirectDicomImportDPLLogger.h>

Inheritance diagram for ml::DirectDicomImportDPLLogger:

Public Types
typedef void	ProgressCB(void *usrData, const std::string &info, float state)
	Progress callback which can be registered for DPL progress logging. More...

Public Member Functions
	DirectDicomImportDPLLogger (ProgressLogger *ddiLogger=nullptr)
	Constructor: A class logging DPl messages to the console of the instance of a ProgressLogger. More...

virtual void	setProgressCB (ProgressCB callback=nullptr, void userData=nullptr, float progressStart=0.2f, float progressRange=0.3f)
	Defines the currently used progress callback or resets it if nothing is passed. More...

void	setProgressLogger (ProgressLogger *ddiLogger=nullptr)
	Set the used ProgressLogger instance, defaults to nullptr. More...

ProgressLogger *	getProgressLogger () const
	Returns the currently set ProgressLogger. More...

void	setVerboseLevel (unsigned int verboseLevel)
	Verbose level (0 = only warnings and errors, other values = full information). More...

unsigned int	getVerboseLevel () const
	Returns verbose level. More...

void	setLogPartingAndSortingInformationOn (bool on)
	Enables logging of partitioning and sorting information if enabled, default is off/false. More...

bool	isPartingAndSortingInformationOn ()
	Returns true if logging of partitioning and sorting information is enabled, otherwise false. More...

void	setTagValueProvider (DirectDicomImportDPLTagValueProvider *prov=nullptr)
	An optional tag value provider from which information about the recent frame can be retrieved for more details about errors. More...

DirectDicomImportDPLTagValueProvider *	getTagValueProvider () const
	Returns the currently set tag value provider or nullptr if not set. More...

Protected Member Functions
void	log (Logger::LogTypes logType, const std::string &msgArg) override
	Receives the DPL message and sends it to the console of the DirectDicomImport instance. More...

void	log (Logger::LogTypes logType, DPL::ErrorInfo *error) override
	Receives the DPL error and sends it to the console of the DirectDicomImport instance. More...

Detailed Description

Extended DPL logger class redirecting messages from the DPL to a DirectDicomImport instance.

Definition at line 46 of file mlDirectDicomImportDPLLogger.h.

Member Typedef Documentation

◆ ProgressCB

typedef void ml::DirectDicomImportDPLLogger::ProgressCB(void *usrData, const std::string &info, float state)

Progress callback which can be registered for DPL progress logging.

Definition at line 53 of file mlDirectDicomImportDPLLogger.h.

Constructor & Destructor Documentation

◆ DirectDicomImportDPLLogger()

ml::DirectDicomImportDPLLogger::DirectDicomImportDPLLogger ( ProgressLogger * ddiLogger = nullptr )

Constructor: A class logging DPl messages to the console of the instance of a ProgressLogger.

Member Function Documentation

◆ getProgressLogger()

ProgressLogger* ml::DirectDicomImportDPLLogger::getProgressLogger ( ) const

Returns the currently set ProgressLogger.

◆ getTagValueProvider()

DirectDicomImportDPLTagValueProvider* ml::DirectDicomImportDPLLogger::getTagValueProvider ( ) const

Returns the currently set tag value provider or nullptr if not set.

◆ getVerboseLevel()

unsigned int ml::DirectDicomImportDPLLogger::getVerboseLevel ( ) const

Returns verbose level.

◆ isPartingAndSortingInformationOn()

bool ml::DirectDicomImportDPLLogger::isPartingAndSortingInformationOn ( )

Returns true if logging of partitioning and sorting information is enabled, otherwise false.

◆ log() [1/2]

void ml::DirectDicomImportDPLLogger::log	(	Logger::LogTypes	logType,
		const std::string &	msgArg
	)

overrideprotected

Receives the DPL message and sends it to the console of the DirectDicomImport instance.

Parameters

logType	The type of message to log.
msgArg	The message to log.

◆ log() [2/2]

void ml::DirectDicomImportDPLLogger::log	(	Logger::LogTypes	logType,
		DPL::ErrorInfo *	error
	)

overrideprotected

Receives the DPL error and sends it to the console of the DirectDicomImport instance.

Call is ignored if error is nullptr.

Parameters

logType	The type of message to log.
error	Pointer to a container whose string (got from toString) is logged.

◆ setLogPartingAndSortingInformationOn()

void ml::DirectDicomImportDPLLogger::setLogPartingAndSortingInformationOn ( bool on )

Enables logging of partitioning and sorting information if enabled, default is off/false.

◆ setProgressCB()

virtual void ml::DirectDicomImportDPLLogger::setProgressCB	(	ProgressCB *	callback = `nullptr`,
		void *	userData = `nullptr`,
		float	progressStart = `0.2f`,
		float	progressRange = `0.3f`
	)

virtual

Defines the currently used progress callback or resets it if nothing is passed.

◆ setProgressLogger()

void ml::DirectDicomImportDPLLogger::setProgressLogger ( ProgressLogger * ddiLogger = nullptr )

Set the used ProgressLogger instance, defaults to nullptr.

◆ setTagValueProvider()

void ml::DirectDicomImportDPLLogger::setTagValueProvider ( DirectDicomImportDPLTagValueProvider * prov = nullptr )

An optional tag value provider from which information about the recent frame can be retrieved for more details about errors.

◆ setVerboseLevel()

void ml::DirectDicomImportDPLLogger::setVerboseLevel ( unsigned int verboseLevel )

Verbose level (0 = only warnings and errors, other values = full information).

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

FMEstable/ReleaseMeVis/Projects/DICOM/MLDirectDicomImport/Sources/mlDirectDicomImportDPLLogger.h

Public Types

Public Member Functions

Protected Member Functions