CustusX  15.4.0-beta
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxProbe.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 
34 #ifndef CXPROBE_H_
35 #define CXPROBE_H_
36 
37 #include "cxResourceExport.h"
38 
39 #include <QObject>
40 #include <boost/weak_ptr.hpp>
41 #include "cxProbeData.h"
42 #include "cxForwardDeclarations.h"
43 
44 namespace cx
45 {
53 class cxResource_EXPORT Probe: public QObject
54 {
55  Q_OBJECT
56 public:
57  virtual ~Probe()
58  {
59  }
60  virtual bool isValid() const = 0;
61  virtual void addXml(QDomNode& dataNode) = 0;
62  virtual void parseXml(QDomNode& dataNode) = 0;
63 
64  virtual QStringList getConfigIdList() const = 0;
65  virtual QString getConfigName(QString uid) = 0;
66  virtual QString getConfigId() const = 0;
67  virtual QString getConfigurationPath() const = 0;
68 
69  virtual void removeCurrentConfig() = 0;
70  virtual void saveCurrentConfig(QString uid, QString name) = 0;
71 
72  virtual void applyNewConfigurationWithId(QString uid) = 0;
73  virtual void setTemporalCalibration(double val) = 0;
74  virtual void setSoundSpeedCompensationFactor(double val) = 0;
75  virtual void setProbeSector(ProbeDefinition probeSector) = 0;
76  virtual void setRTSource(VideoSourcePtr source) = 0;
77  virtual void removeRTSource(VideoSourcePtr source) = 0;
78 
79  virtual void setActiveStream(QString uid) = 0;
80  virtual QString getActiveStream() const = 0;
81 
82  virtual QStringList getAvailableVideoSources() = 0;
83  virtual VideoSourcePtr getRTSource(QString uid = "active") const = 0;
84  virtual ProbeDefinition getProbeData(QString uid = "active") const = 0;
85  virtual ProbeSectorPtr getSector(QString uid = "active") = 0;
86 
87 signals:
88  void sectorChanged();
89  void activeConfigChanged();
90  void videoSourceAdded(VideoSourcePtr source);
91 };
92 
93 typedef boost::shared_ptr<Probe> ProbePtr;
94 typedef boost::weak_ptr<Probe> ProbeWeakPtr;
95 
96 }//namespace cx
97 
98 #endif /* CXPROBE_H_ */
virtual ~Probe()
Definition: cxProbe.h:57
boost::shared_ptr< Probe > ProbePtr
Definition: cxProbe.h:93
US Probe interface.
Definition: cxProbe.h:53
boost::weak_ptr< Probe > ProbeWeakPtr
Definition: cxProbe.h:94
boost::shared_ptr< class VideoSource > VideoSourcePtr
boost::shared_ptr< class ProbeSector > ProbeSectorPtr
Definition of characteristics for an Ultrasound Probe Sector.
Definition: cxProbeData.h:118