ctkDicomAbstractExchangeCache Class Reference

Provides a basic convenience methods for the data exchange. More...

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

Inheritance diagram for ctkDicomAbstractExchangeCache:

Collaboration diagram for ctkDicomAbstractExchangeCache:

Signals
void	dataAvailable ()
void	internalDataAvailable ()

Public Member Functions
void	cleanIncomingData ()
	Clean internal data stucture that keeps the incoming data. More...
	ctkDicomAbstractExchangeCache ()
	Construct object. More...
virtual QList< ctkDicomAppHosting::ObjectLocator >	getData (const QList< QUuid > &objectUUIDs, const QList< QString > &acceptableTransferSyntaxUIDs, bool includeBulkData)
	Provide ctkDicomAppHosting::ObjectLocators to the other side. More...
const ctkDicomAppHosting::AvailableData &	getIncomingAvailableData () const
	Return the incoming available data. More...
virtual ctkDicomExchangeInterface *	getOtherSideExchangeService () const =0
	Gets the exchange service of the other side. More...
bool	lastIncomingData () const
	Return whether the incoming data was marked as lastData. More...
bool	notifyDataAvailable (const ctkDicomAppHosting::AvailableData &data, bool lastData)
	Receive notification from other side. More...
ctkDicomObjectLocatorCache *	objectLocatorCache () const
	Return the cache for outgoing data. More...
bool	publishData (const ctkDicomAppHosting::AvailableData &availableData, bool lastData)
	Publish data to other side. More...
void	releaseData (const QList< QUuid > &objectUUIDs)
virtual	~ctkDicomAbstractExchangeCache ()
	Destructor. More...
Public Member Functions inherited from ctkDicomExchangeInterface
virtual	~ctkDicomExchangeInterface ()

Detailed Description

Provides a basic convenience methods for the data exchange.

The implementation is based on the ctkDicomObjectLocatorCache.

Definition at line 38 of file ctkDicomAbstractExchangeCache.h.

Constructor & Destructor Documentation

ctkDicomAbstractExchangeCache::ctkDicomAbstractExchangeCache

(

)

Construct object.

Parameters

exchangeService

the ctkDicomExchangeService of the other side.

virtual ctkDicomAbstractExchangeCache::~ctkDicomAbstractExchangeCache ( )

virtual

Destructor.

Member Function Documentation

void ctkDicomAbstractExchangeCache::cleanIncomingData

(

)

Clean internal data stucture that keeps the incoming data.

Called when other side is gone (i.e., usually the other side is a hosted app).

void ctkDicomAbstractExchangeCache::dataAvailable ( )

signal

virtual QList<ctkDicomAppHosting::ObjectLocator> ctkDicomAbstractExchangeCache::getData ( const QList< QUuid > &  objectUUIDs, const QList< QString > &  acceptableTransferSyntaxUIDs, bool  includeBulkData  )

virtual

Provide ctkDicomAppHosting::ObjectLocators to the other side.

If we are a host, the other side is the hosted app and vice versa.

Parameters

objectUUIDs
acceptableTransferSyntaxUIDs
includeBulkData

Returns

QList<ctkDicomAppHosting::ObjectLocator>

Implements ctkDicomExchangeInterface.

const ctkDicomAppHosting::AvailableData& ctkDicomAbstractExchangeCache::getIncomingAvailableData

(

)

const

Return the incoming available data.

Returns

AvailableData *

virtual ctkDicomExchangeInterface* ctkDicomAbstractExchangeCache::getOtherSideExchangeService ( ) const

pure virtual

Gets the exchange service of the other side.

If we are a host, this must return the exchange service of the hosted app and vice versa.

Returns

ctkDicomExchangeService * of the other side

Implemented in ctkDicomAbstractHost, and ctkDicomAbstractApp.

void ctkDicomAbstractExchangeCache::internalDataAvailable ( )

signal

bool ctkDicomAbstractExchangeCache::lastIncomingData

(

)

const

Return whether the incoming data was marked as lastData.

Returns

bool value of lastData in incoming notifyDataAvailable call

bool ctkDicomAbstractExchangeCache::notifyDataAvailable ( const ctkDicomAppHosting::AvailableData &  data, bool  lastData  )

virtual

Receive notification from other side.

Implements ctkDicomExchangeInterface.

ctkDicomObjectLocatorCache* ctkDicomAbstractExchangeCache::objectLocatorCache

(

)

const

Return the cache for outgoing data.

Returns

ctkDicomObjectLocatorCache *

bool ctkDicomAbstractExchangeCache::publishData	(	const ctkDicomAppHosting::AvailableData &	availableData,
		bool	lastData
	)

Publish data to other side.

Parameters

availableData
lastData

Returns

bool

void ctkDicomAbstractExchangeCache::releaseData ( const QList< QUuid > &  objectUUIDs )

virtual

The recipient of data invokes this method to release access to binary data provided by the source of the data through a getData() call. The ArrayOfUUID identifies the data streams that the recipient is releasing.

Implements ctkDicomExchangeInterface.

---

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

• Plugins/org.commontk.dah.core/ctkDicomAbstractExchangeCache.h