CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Slots | Signals | Public Member Functions | Protected Attributes | Properties | Friends | List of all members
ctkDICOMRetrieve Class Reference

#include <Libs/DICOM/Core/ctkDICOMRetrieve.h>

Inheritance diagram for ctkDICOMRetrieve:
Inheritance graph
[legend]
Collaboration diagram for ctkDICOMRetrieve:
Collaboration graph
[legend]

Public Slots

Q_INVOKABLE void cancel ()
 Cancel the current operation. More...
 
Q_INVOKABLE bool getSeries (const QString &studyInstanceUID, const QString &seriesInstanceUID)
 Use CGET to ask peer host to store data to us. More...
 
Q_INVOKABLE bool getStudy (const QString &studyInstanceUID)
 Use CGET to ask peer host to store data to us. More...
 
Q_INVOKABLE bool moveSeries (const QString &studyInstanceUID, const QString &seriesInstanceUID)
 Use CMOVE to ask peer host to store data to move destination. More...
 
Q_INVOKABLE bool moveStudy (const QString &studyInstanceUID)
 Use CMOVE to ask peer host to store data to move destination. More...
 

Signals

void debug (const QString &message)
 
void done (const bool &error)
 
void error (const QString &message)
 Signal is emitted inside the retrieve() function. It send any error messages. More...
 
void progress (const QString &message)
 
void progress (int progress)
 

Public Member Functions

Q_INVOKABLE QString calledAETitle () const
 
Q_INVOKABLE QString callingAETitle () const
 
 ctkDICOMRetrieve (QObject *parent=0)
 
Q_INVOKABLE QSharedPointer< ctkDICOMDatabasedatabase () const
 
Q_INVOKABLE QString host () const
 
Q_INVOKABLE bool keepAssociationOpen ()
 
Q_INVOKABLE QString moveDestinationAETitle () const
 
Q_INVOKABLE int port () const
 
Q_INVOKABLE void setCalledAETitle (const QString &calledAETitle)
 
Q_INVOKABLE void setCallingAETitle (const QString &callingAETitle)
 
Q_INVOKABLE void setDatabase (ctkDICOMDatabase &dicomDatabase)
 
void setDatabase (QSharedPointer< ctkDICOMDatabase > dicomDatabase)
 
Q_INVOKABLE void setHost (const QString &host)
 peer hostname being connected to More...
 
Q_INVOKABLE void setKeepAssociationOpen (const bool keepOpen)
 
Q_INVOKABLE void setMoveDestinationAETitle (const QString &moveDestinationAETitle)
 
Q_INVOKABLE void setPort (int port)
 [0, 65365] port on peer host - e.g. 11112 More...
 
Q_INVOKABLE void setWasCanceled (const bool wasCanceled)
 
Q_INVOKABLE bool wasCanceled ()
 
virtual ~ctkDICOMRetrieve ()
 

Protected Attributes

QScopedPointer< ctkDICOMRetrievePrivate > d_ptr
 

Properties

QString calledAETitle
 
QString callingAETitle
 
QString host
 
bool keepAssociationOpen
 
QString moveDestinationAETitle
 
int port
 
bool wasCanceled
 

Friends

class ctkDICOMRetrieveSCUPrivate
 

Detailed Description

Definition at line 38 of file ctkDICOMRetrieve.h.

Constructor & Destructor Documentation

◆ ctkDICOMRetrieve()

ctkDICOMRetrieve::ctkDICOMRetrieve ( QObject *  parent = 0)
explicit

◆ ~ctkDICOMRetrieve()

virtual ctkDICOMRetrieve::~ctkDICOMRetrieve ( )
virtual

Member Function Documentation

◆ calledAETitle()

Q_INVOKABLE QString ctkDICOMRetrieve::calledAETitle ( ) const

◆ callingAETitle()

Q_INVOKABLE QString ctkDICOMRetrieve::callingAETitle ( ) const

◆ cancel

Q_INVOKABLE void ctkDICOMRetrieve::cancel ( )
slot

Cancel the current operation.

◆ database()

Q_INVOKABLE QSharedPointer<ctkDICOMDatabase> ctkDICOMRetrieve::database ( ) const

◆ debug

void ctkDICOMRetrieve::debug ( const QString &  message)
signal

Signal is emitted inside the retrieve() function. It sends detailed feedback for debugging

◆ done

void ctkDICOMRetrieve::done ( const bool &  error)
signal

Signal is emitted inside the retrieve() function when finished with value true for success or false for error

◆ error

void ctkDICOMRetrieve::error ( const QString &  message)
signal

Signal is emitted inside the retrieve() function. It send any error messages.

◆ getSeries

Q_INVOKABLE bool ctkDICOMRetrieve::getSeries ( const QString &  studyInstanceUID,
const QString &  seriesInstanceUID 
)
slot

Use CGET to ask peer host to store data to us.

◆ getStudy

Q_INVOKABLE bool ctkDICOMRetrieve::getStudy ( const QString &  studyInstanceUID)
slot

Use CGET to ask peer host to store data to us.

◆ host()

Q_INVOKABLE QString ctkDICOMRetrieve::host ( ) const

◆ keepAssociationOpen()

Q_INVOKABLE bool ctkDICOMRetrieve::keepAssociationOpen ( )

◆ moveDestinationAETitle()

Q_INVOKABLE QString ctkDICOMRetrieve::moveDestinationAETitle ( ) const

◆ moveSeries

Q_INVOKABLE bool ctkDICOMRetrieve::moveSeries ( const QString &  studyInstanceUID,
const QString &  seriesInstanceUID 
)
slot

Use CMOVE to ask peer host to store data to move destination.

◆ moveStudy

Q_INVOKABLE bool ctkDICOMRetrieve::moveStudy ( const QString &  studyInstanceUID)
slot

Use CMOVE to ask peer host to store data to move destination.

◆ port()

Q_INVOKABLE int ctkDICOMRetrieve::port ( ) const

◆ progress [1/2]

void ctkDICOMRetrieve::progress ( const QString &  message)
signal

Signal is emitted inside the retrieve() function. It sends the different step the function is at.

◆ progress [2/2]

void ctkDICOMRetrieve::progress ( int  progress)
signal

Signal is emitted inside the retrieve() function. It ranges from 0 to 100. In case of an error, you are assured that the progress value 100 is fired

◆ setCalledAETitle()

Q_INVOKABLE void ctkDICOMRetrieve::setCalledAETitle ( const QString &  calledAETitle)

CTK_AE - the AE of the serice of peer host that you are calling which tells the host what you are requesting

◆ setCallingAETitle()

Q_INVOKABLE void ctkDICOMRetrieve::setCallingAETitle ( const QString &  callingAETitle)

Set methods for connectivity CTK_AE - the AE string by which the peer host might recognize your request

◆ setDatabase() [1/2]

Q_INVOKABLE void ctkDICOMRetrieve::setDatabase ( ctkDICOMDatabase dicomDatabase)

where to insert new data sets obtained via get (must be set for get to succee

◆ setDatabase() [2/2]

void ctkDICOMRetrieve::setDatabase ( QSharedPointer< ctkDICOMDatabase dicomDatabase)

◆ setHost()

Q_INVOKABLE void ctkDICOMRetrieve::setHost ( const QString &  host)

peer hostname being connected to

◆ setKeepAssociationOpen()

Q_INVOKABLE void ctkDICOMRetrieve::setKeepAssociationOpen ( const bool  keepOpen)

prefer to keep using the existing association to peer host when doing multiple requests (default true)

◆ setMoveDestinationAETitle()

Q_INVOKABLE void ctkDICOMRetrieve::setMoveDestinationAETitle ( const QString &  moveDestinationAETitle)

Typically CTK_STORE or similar - needs to be something that the peer host knows about and is able to move data into Only used when calling moveSeries or moveStudy

◆ setPort()

Q_INVOKABLE void ctkDICOMRetrieve::setPort ( int  port)

[0, 65365] port on peer host - e.g. 11112

◆ setWasCanceled()

Q_INVOKABLE void ctkDICOMRetrieve::setWasCanceled ( const bool  wasCanceled)

did someone cancel us during operation? (default false)

◆ wasCanceled()

Q_INVOKABLE bool ctkDICOMRetrieve::wasCanceled ( )

Friends And Related Function Documentation

◆ ctkDICOMRetrieveSCUPrivate

friend class ctkDICOMRetrieveSCUPrivate
friend

Definition at line 124 of file ctkDICOMRetrieve.h.

Member Data Documentation

◆ d_ptr

QScopedPointer<ctkDICOMRetrievePrivate> ctkDICOMRetrieve::d_ptr
protected

Definition at line 118 of file ctkDICOMRetrieve.h.

Property Documentation

◆ calledAETitle

QString ctkDICOMRetrieve::calledAETitle
readwrite

Definition at line 1 of file ctkDICOMRetrieve.h.

◆ callingAETitle

QString ctkDICOMRetrieve::callingAETitle
readwrite

Definition at line 1 of file ctkDICOMRetrieve.h.

◆ host

QString ctkDICOMRetrieve::host
readwrite

Definition at line 1 of file ctkDICOMRetrieve.h.

◆ keepAssociationOpen

bool ctkDICOMRetrieve::keepAssociationOpen
readwrite

Definition at line 1 of file ctkDICOMRetrieve.h.

◆ moveDestinationAETitle

QString ctkDICOMRetrieve::moveDestinationAETitle
readwrite

Definition at line 1 of file ctkDICOMRetrieve.h.

◆ port

int ctkDICOMRetrieve::port
readwrite

Definition at line 1 of file ctkDICOMRetrieve.h.

◆ wasCanceled

bool ctkDICOMRetrieve::wasCanceled
readwrite

Definition at line 1 of file ctkDICOMRetrieve.h.


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