CustusX  22.04-rc5
An IGT application
Public Types | Signals | Public Member Functions | Static Public Member Functions | List of all members
cx::AcquisitionService Class Referenceabstract

Acqusition services abstract interface. More...

#include <cxAcquisitionService.h>

Inheritance diagram for cx::AcquisitionService:
cx::AcquisitionImplService cx::AcquisitionServiceNull cx::AcquisitionServiceProxy

Public Types

enum  TYPE { tTRACKING, tUS, tCOUNT }
 
enum  STATE { sRUNNING = 0, sPOST_PROCESSING = 1, sNOT_RUNNING = 2 }
 
typedef QFlags< TYPE > TYPES
 

Signals

void started ()
 
void cancelled ()
 
void stateChanged ()
 
void usReadinessChanged ()
 
void acquisitionStopped ()
 
void recordedSessionsChanged ()
 
void acquisitionDataReady ()
 emitted when data is acquired and sent to the reconstruction module More...
 
void saveDataCompleted (QString mhdFilename)
 emitted when data has been saved to file More...
 

Public Member Functions

virtual ~AcquisitionService ()
 
virtual bool isNull ()=0
 
virtual RecordSessionPtr getLatestSession ()=0
 
virtual std::vector< RecordSessionPtr > getSessions ()=0
 
virtual bool isReady (TYPES context) const =0
 
virtual QString getInfoText (TYPES context) const =0
 
virtual STATE getState () const =0
 
virtual void startRecord (TYPES context, QString category, RecordSessionPtr session=RecordSessionPtr())=0
 
virtual void stopRecord ()=0
 
virtual void cancelRecord ()=0
 
virtual void startPostProcessing ()=0
 
virtual void stopPostProcessing ()=0
 
virtual int getNumberOfSavingThreads () const =0
 
RecordSessionPtr getSession (QString uid)
 

Static Public Member Functions

static AcquisitionServicePtr getNullObject ()
 

Detailed Description

Acqusition services abstract interface.

Date
2014-11-26
Author
Ole Vegard Solberg, SINTEF

Definition at line 36 of file cxAcquisitionService.h.

Member Typedef Documentation

typedef QFlags<TYPE> cx::AcquisitionService::TYPES

Definition at line 48 of file cxAcquisitionService.h.

Member Enumeration Documentation

enum cx::AcquisitionService::STATE
Enumerator
sRUNNING 
sPOST_PROCESSING 
sNOT_RUNNING 

Definition at line 51 of file cxAcquisitionService.h.

enum cx::AcquisitionService::TYPE
Enumerator
tTRACKING 
tUS 
tCOUNT 

Definition at line 42 of file cxAcquisitionService.h.

Constructor & Destructor Documentation

virtual cx::AcquisitionService::~AcquisitionService ( )
inlinevirtual

Definition at line 40 of file cxAcquisitionService.h.

Member Function Documentation

void cx::AcquisitionService::acquisitionDataReady ( )
signal

emitted when data is acquired and sent to the reconstruction module

void cx::AcquisitionService::acquisitionStopped ( )
signal
void cx::AcquisitionService::cancelled ( )
signal
virtual void cx::AcquisitionService::cancelRecord ( )
pure virtual

Implemented in cx::AcquisitionImplService, cx::AcquisitionServiceProxy, and cx::AcquisitionServiceNull.

virtual QString cx::AcquisitionService::getInfoText ( TYPES  context) const
pure virtual

Implemented in cx::AcquisitionImplService, cx::AcquisitionServiceProxy, and cx::AcquisitionServiceNull.

virtual RecordSessionPtr cx::AcquisitionService::getLatestSession ( )
pure virtual

Implemented in cx::AcquisitionImplService, cx::AcquisitionServiceProxy, and cx::AcquisitionServiceNull.

AcquisitionServicePtr cx::AcquisitionService::getNullObject ( )
static

Definition at line 21 of file cxAcquisitionService.cpp.

virtual int cx::AcquisitionService::getNumberOfSavingThreads ( ) const
pure virtual

Implemented in cx::AcquisitionImplService, cx::AcquisitionServiceProxy, and cx::AcquisitionServiceNull.

RecordSessionPtr cx::AcquisitionService::getSession ( QString  uid)

Definition at line 29 of file cxAcquisitionService.cpp.

virtual std::vector<RecordSessionPtr> cx::AcquisitionService::getSessions ( )
pure virtual

Implemented in cx::AcquisitionImplService, cx::AcquisitionServiceProxy, and cx::AcquisitionServiceNull.

virtual STATE cx::AcquisitionService::getState ( ) const
pure virtual

Implemented in cx::AcquisitionImplService, cx::AcquisitionServiceProxy, and cx::AcquisitionServiceNull.

virtual bool cx::AcquisitionService::isNull ( )
pure virtual

Implemented in cx::AcquisitionImplService, cx::AcquisitionServiceProxy, and cx::AcquisitionServiceNull.

virtual bool cx::AcquisitionService::isReady ( TYPES  context) const
pure virtual

Implemented in cx::AcquisitionImplService, cx::AcquisitionServiceProxy, and cx::AcquisitionServiceNull.

void cx::AcquisitionService::recordedSessionsChanged ( )
signal
void cx::AcquisitionService::saveDataCompleted ( QString  mhdFilename)
signal

emitted when data has been saved to file

void cx::AcquisitionService::started ( )
signal
virtual void cx::AcquisitionService::startPostProcessing ( )
pure virtual

Implemented in cx::AcquisitionImplService, cx::AcquisitionServiceProxy, and cx::AcquisitionServiceNull.

virtual void cx::AcquisitionService::startRecord ( TYPES  context,
QString  category,
RecordSessionPtr  session = RecordSessionPtr() 
)
pure virtual

Implemented in cx::AcquisitionImplService, cx::AcquisitionServiceProxy, and cx::AcquisitionServiceNull.

void cx::AcquisitionService::stateChanged ( )
signal
virtual void cx::AcquisitionService::stopPostProcessing ( )
pure virtual

Implemented in cx::AcquisitionImplService, cx::AcquisitionServiceProxy, and cx::AcquisitionServiceNull.

virtual void cx::AcquisitionService::stopRecord ( )
pure virtual

Implemented in cx::AcquisitionImplService, cx::AcquisitionServiceProxy, and cx::AcquisitionServiceNull.

void cx::AcquisitionService::usReadinessChanged ( )
signal
The documentation for this class was generated from the following files: