Fraxinus  16.5.0-fx-rc8
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxDoublePairProperty.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 CXDOUBLEPAIRPROPERTY_H_
34 #define CXDOUBLEPAIRPROPERTY_H_
35 
36 #include "cxResourceExport.h"
37 
39 #include "cxXmlOptionItem.h"
40 
41 namespace cx
42 {
43 typedef boost::shared_ptr<class DoublePairProperty> DoublePairPropertyPtr;
44 
61 class cxResource_EXPORT DoublePairProperty : public DoublePairPropertyBase
62 {
63 Q_OBJECT
64 public:
68  static DoublePairPropertyPtr initialize(const QString& uid, QString name, QString help,
69  DoubleRange range, int decimals, QDomNode root = QDomNode());
70  void setInternal2Display(double factor);
71 
72 public:
73  // inherited interface
74  virtual QString getDisplayName() const;
75  virtual QString getUid() const;
76  virtual bool setValue(const Eigen::Vector2d& value);
77  virtual Eigen::Vector2d getValue() const;
78  virtual QString getHelp() const;
79  virtual DoubleRange getValueRange() const;
80  virtual void setValueRange(DoubleRange range);
81  virtual int getValueDecimals() const;
82  virtual double convertInternal2Display(double internal)
83  {
84  return mFactor * internal;
85  }
86  virtual double convertDisplay2Internal(double display)
87  {
88  return display / mFactor;
89  }
90 
91 
92 signals:
93  void valueWasSet();
94 
95 private:
97  QString mName;
98  QString mUid;
99  QString mHelp;
100  Eigen::Vector2d mValue;
101  double mDecimals;
102  DoubleRange mRange;
103  XmlOptionItem mStore;
104  double mFactor;
105 };
106 
107 } // namespace cx
108 #endif // CXDOUBLEPAIRPROPERTY_H_
Utility class for describing a bounded numeric range.
Definition: cxDoubleRange.h:53
virtual double convertDisplay2Internal(double display)
conversion from internal value to display value
Helper class for storing one string value in an xml document.
Implementation of DoublePairPropertyBase.
boost::shared_ptr< class DoublePairProperty > DoublePairPropertyPtr
Abstract interface for interaction with internal data structure: A pair of doubles.
virtual double convertInternal2Display(double internal)
conversion from internal value to display value (for example between 0..1 and percent) ...