MeVisLab Scripting Reference
MLABBaseDicomTool Class Referenceabstract

#include <mlabBaseDicomTool.h>

Inherited by MLABFindSCU, and MLABPlainDicomTool.

Public Types

enum  Encoding { QueryEncoding , Latin1 , Utf8 }
enum  QueryModel { }

Public Slots

virtual void cancel ()=0
QStringList getErrorMessages () const
bool run ()
void setCalledAET (const QString &aet)
void setCallingAET (const QString &aet)
bool start ()
bool wait (unsigned long time=ULONG_MAX)

Signals

void finished (bool success)

Detailed Description

Base class for all Dicom tools of this script extension. It implements basic setup and handling of the thread (if used).

Member Enumeration Documentation

◆ Encoding

enum MLABBaseDicomTool::Encoding

Character encoding mode to use when querying a PACS.

Enumerator
QueryEncoding 

Do not state a SpecificCharacterSet, but request it per dataset. Values are transmitted and received Latin1-encoded, but this may generate extra result entries (with key name suffix "_display"), where the specified encoding is applied and differs from the Latin1 encoding.

Latin1 

Values are transmitted and received Latin1-encoded. SpecificCharacterSet is set accordingly.

Utf8 

Values are transmitted and received UTF8-encoded. SpecificCharacterSet is set accordingly.

◆ QueryModel

enum MLABBaseDicomTool::QueryModel

Query information model.

Enumerator
PatientRoot 

Query from patient root.

StudyRoot 

Query from study root.

PatientStudyOnly 

Retired from standard.

Member Function Documentation

◆ cancel

virtual void MLABBaseDicomTool::cancel ( )
pure virtualslot

Cancels asynchronous execution. Not all derived classes may implement this.

Implemented in MLABFindSCU, and MLABPlainDicomTool.

◆ finished

void MLABBaseDicomTool::finished ( bool success)
signal

Emitted when the execution of the tool finishes (also when run synchronously).

◆ getErrorMessages

QStringList MLABBaseDicomTool::getErrorMessages ( ) const
slot

Returns error messages of the last execution of this tool.

◆ run

bool MLABBaseDicomTool::run ( )
slot

Runs tool (waits until finished), returns if execution was successful.

◆ setCalledAET

void MLABBaseDicomTool::setCalledAET ( const QString & aet)
slot

Sets AET title of the called instance.

◆ setCallingAET

void MLABBaseDicomTool::setCallingAET ( const QString & aet)
slot

Sets AET title of the calling instance.

◆ start

bool MLABBaseDicomTool::start ( )
slot

Runs tool asynchronously. Connects to finished() signal to get notified when execution finishes.

◆ wait

bool MLABBaseDicomTool::wait ( unsigned long time = ULONG_MAX)
slot

Waits for asynchronous execution to finish. This may also block receiving of results, so it might be better to call run() in the first place.