Fraxinus  17.12-rc3
An IGT application
cxAcquisitionService.h
Go to the documentation of this file.
1 /*=========================================================================
2 This file is part of CustusX, an Image Guided Therapy Application.
3 
4 Copyright (c) 2008-2014, SINTEF Department of Medical Technology
5 All rights reserved.
6 
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9 
10 1. Redistributions of source code must retain the above copyright notice,
11  this list of conditions and the following disclaimer.
12 
13 2. Redistributions in binary form must reproduce the above copyright notice,
14  this list of conditions and the following disclaimer in the documentation
15  and/or other materials provided with the distribution.
16 
17 3. Neither the name of the copyright holder nor the names of its contributors
18  may be used to endorse or promote products derived from this software
19  without specific prior written permission.
20 
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 =========================================================================*/
32 
33 #ifndef CXACQUSITIONSERVICE_H
34 #define CXACQUSITIONSERVICE_H
35 
36 #include "org_custusx_acquisition_Export.h"
37 
38 #include <QObject>
39 #include <vector>
40 #include <boost/shared_ptr.hpp>
41 class QDomNode;
42 
43 #define AcquisitionService_iid "cx::AcquisitionService"
44 
45 namespace cx
46 {
47 
48 typedef boost::shared_ptr<class AcquisitionService> AcquisitionServicePtr;
49 typedef boost::shared_ptr<class RecordSession> RecordSessionPtr;
50 
57 class org_custusx_acquisition_EXPORT AcquisitionService : public QObject
58 {
59  Q_OBJECT
60 public:
61  virtual ~AcquisitionService() {}
62 
63  enum TYPE
64  {
66  tUS,
67  tCOUNT
68  };
69  typedef QFlags<TYPE> TYPES;
70 // Q_DECLARE_FLAGS( TYPES, TYPE);
71 
72  enum STATE
73  {
74  sRUNNING = 0,
75  sPOST_PROCESSING = 1,
76  sNOT_RUNNING = 2
77  };
78 
79  // Core interface
80 
81  virtual bool isNull() = 0;
82  static AcquisitionServicePtr getNullObject();
83 
84  virtual RecordSessionPtr getLatestSession() = 0;
85  virtual std::vector<RecordSessionPtr> getSessions() = 0;
86 
87  virtual bool isReady(TYPES context) const = 0;
88  virtual QString getInfoText(TYPES context) const = 0;
89  virtual STATE getState() const = 0;
90 // virtual void toggleRecord(TYPES context, QString category);
91  virtual void startRecord(TYPES context, QString category, RecordSessionPtr session = RecordSessionPtr()) = 0;
92  virtual void stopRecord() = 0;
93  virtual void cancelRecord() = 0;
94  virtual void startPostProcessing() = 0;
95  virtual void stopPostProcessing() = 0;
96 
97  virtual int getNumberOfSavingThreads() const = 0;
98 
99  // Extented interface
100 
101  RecordSessionPtr getSession(QString uid);
102 
103 signals:
104  void started();
105  void cancelled();
106  void stateChanged();
107  void usReadinessChanged();
108  void acquisitionStopped();
109 
110  void recordedSessionsChanged();
111 
112  // From USAcquisition
113  void acquisitionDataReady();
114  void saveDataCompleted(QString mhdFilename);
115 };
116 
117 } // cx
119 
120 #endif // CXACQUSITIONSERVICE_H
Acqusition services abstract interface.
#define AcquisitionService_iid
boost::shared_ptr< class AcquisitionService > AcquisitionServicePtr
boost::shared_ptr< class RecordSession > RecordSessionPtr
Namespace for all CustusX production code.