Fraxinus  17.12-rc1
An IGT application
cxDataMetric.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 
35 #ifndef CXDATAMETRIC_H_
36 #define CXDATAMETRIC_H_
37 
38 #include "cxResourceExport.h"
39 #include "cxPrecompiledHeader.h"
40 
41 #include "cxData.h"
42 #include <QColor>
43 
44 namespace cx
45 {
46 typedef boost::shared_ptr<class SpaceProvider> SpaceProviderPtr;
47 typedef boost::shared_ptr<class SpaceListener> SpaceListenerPtr;
48 
64 class cxResource_EXPORT DataMetric : public Data
65 {
66 public:
67  DataMetric(const QString& uid, const QString& name, PatientModelServicePtr dataManager, SpaceProviderPtr spaceProvider);
68  virtual ~DataMetric();
69 
70  virtual QIcon getIcon() {return QIcon(":/icons/metric.png");}
71 
72  virtual QString getSpace();
73  virtual Vector3D getRefCoord() const = 0;
74  virtual Transform3D getRefFrame() const { return createTransformTranslate(this->getRefCoord()); }
75  virtual bool isValid() const { return true; }
76  virtual QString getValueAsString() const = 0;
77  virtual bool showValueInGraphics() const { return false; }
78 
79  void setColor(const QColor& color);
80  QColor getColor();
81 
82  void addXml(QDomNode& dataNode);
83  void parseXml(QDomNode& dataNode);
84  virtual bool load(QString path) { return true; }
85  virtual void save(const QString& basePath) {}
86 
87 protected:
89  SpaceProviderPtr mSpaceProvider;
90 
91  QColor mColor;
92 
93 };
94 typedef boost::shared_ptr<DataMetric> DataMetricPtr;
95 
99 }
100 
101 #endif /* CXDATAMETRIC_H_ */
boost::shared_ptr< class SpaceProvider > SpaceProviderPtr
Transform3D Transform3D
Transform3D is a representation of an affine 3D transform.
boost::shared_ptr< DataMetric > DataMetricPtr
Definition: cxDataMetric.h:94
virtual void save(const QString &basePath)
metrics don&#39;t store info in file, xml only.
Definition: cxDataMetric.h:85
PatientModelServicePtr mDataManager
Definition: cxDataMetric.h:88
SpaceProviderPtr mSpaceProvider
Definition: cxDataMetric.h:89
boost::shared_ptr< class PatientModelService > PatientModelServicePtr
virtual bool showValueInGraphics() const
Definition: cxDataMetric.h:77
Transform3D createTransformTranslate(const Vector3D &translation)
virtual Transform3D getRefFrame() const
Definition: cxDataMetric.h:74
Eigen::Vector3d Vector3D
Vector3D is a representation of a point or vector in 3D.
Definition: cxVector3D.h:63
Superclass for all data objects.
Definition: cxData.h:109
virtual QIcon getIcon()
Definition: cxDataMetric.h:70
virtual bool isValid() const
Definition: cxDataMetric.h:75
boost::shared_ptr< class SpaceListener > SpaceListenerPtr
virtual bool load(QString path)
metrics don&#39;t store info in file, xml only.
Definition: cxDataMetric.h:84
Base class for all Data Metrics.
Definition: cxDataMetric.h:64
Namespace for all CustusX production code.