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 Member Functions | List of all members
ctkDicomHostInterface Struct Referenceabstract

#include <Plugins/org.commontk.dah.core/ctkDicomHostInterface.h>

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

Public Member Functions

virtual QString generateUID ()=0
 
virtual QRect getAvailableScreen (const QRect &preferredScreen)=0
 
virtual QString getOutputLocation (const QStringList &preferredProtocols)=0
 
virtual void notifyStateChanged (ctkDicomAppHosting::State state)=0
 
virtual void notifyStatus (const ctkDicomAppHosting::Status &status)=0
 
- Public Member Functions inherited from ctkDicomExchangeInterface
virtual QList< ctkDicomAppHosting::ObjectLocatorgetData (const QList< QUuid > &objectUUIDs, const QList< QString > &acceptableTransferSyntaxUIDs, bool includeBulkData)=0
 
virtual bool notifyDataAvailable (const ctkDicomAppHosting::AvailableData &data, bool lastData)=0
 
virtual void releaseData (const QList< QUuid > &objectUUIDs)=0
 
virtual ~ctkDicomExchangeInterface ()
 

Detailed Description

Definition at line 28 of file ctkDicomHostInterface.h.

Member Function Documentation

◆ generateUID()

virtual QString ctkDicomHostInterface::generateUID ( )
pure virtual

Returns a newly created DICOM UID that the Hosted Application might use, e.g., to create new data objects and structures.

Implemented in ctkExampleDicomHost.

◆ getAvailableScreen()

virtual QRect ctkDicomHostInterface::getAvailableScreen ( const QRect &  preferredScreen)
pure virtual

The Hosted Application supplies its preferred screen size in the appPreferredScreen parameter. The Hosting System may utilize this information as a hint, but may return a window location and size that best suits the Hosting System's GUI.

Implemented in ctkExampleDicomHost.

◆ getOutputLocation()

virtual QString ctkDicomHostInterface::getOutputLocation ( const QStringList &  preferredProtocols)
pure virtual

This method returns a URI that a Hosted Application may use to store output that it may provide back to the Hosting System (e.g. in response to a getData() call).

Returns
a URI that a Hosted Application may use to store output.

Implemented in ctkExampleDicomHost.

◆ notifyStateChanged()

virtual void ctkDicomHostInterface::notifyStateChanged ( ctkDicomAppHosting::State  state)
pure virtual

The Hosted Application shall invoke this method each time the Hosted Application successfully transitions to a new state. The new state is passed in the state parameter.

Implemented in ctkDicomAbstractHost.

◆ notifyStatus()

virtual void ctkDicomHostInterface::notifyStatus ( const ctkDicomAppHosting::Status status)
pure virtual

Method used by the Hosted Application to inform the Hosting System of notable events that occur during execution. The Hosted Application invoks this method, passing the information in the status parameter.

Implemented in ctkExampleDicomHost.


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