Fraxinus  16.5.0-fx-rc9
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxDoubleProperty.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  * sscDoubleProperty.h
36  *
37  * Created on: Jun 27, 2010
38  * Author: christiana
39  */
40 
41 #ifndef CXDOUBLEPROPERTY_H_
42 #define CXDOUBLEPROPERTY_H_
43 
44 #include "cxResourceExport.h"
45 
46 #include <QDomElement>
47 #include <QStringList>
48 #include "cxDoubleRange.h"
49 #include "cxDoublePropertyBase.h"
50 #include "cxXmlOptionItem.h"
51 
52 namespace cx
53 {
54 
55 typedef boost::shared_ptr<class DoubleProperty> DoublePropertyPtr;
56 
69 class cxResource_EXPORT DoubleProperty: public DoublePropertyBase
70 {
71 
72  Q_OBJECT
73 public:
77  static DoublePropertyPtr initialize(const QString& uid, QString name, QString help, double value, DoubleRange range, int decimals, QDomNode root = QDomNode());
78  void setInternal2Display(double factor);
79 
80 public:
81  // inherited interface
82  virtual QString getDisplayName() const;
83  virtual QString getUid() const;
84  virtual bool setValue(double value);
85  virtual double getValue() const;
86  virtual QString getHelp() const;
87  virtual DoubleRange getValueRange() const;
88  virtual void setValueRange(DoubleRange range);
89  virtual int getValueDecimals() const;
90  virtual double convertInternal2Display(double internal)
91  {
92  return mFactor * internal;
93  }
94  virtual double convertDisplay2Internal(double display)
95  {
96  return display / mFactor;
97  }
98 
99 
100 signals:
101  void valueWasSet();
102 
103 private:
104  DoubleProperty();
105  QString mName;
106  QString mUid;
107  QString mHelp;
108  double mValue;
109  double mDecimals;
110  DoubleRange mRange;
111  XmlOptionItem mStore;
112  double mFactor;
113 };
114 
115 } // namespace cx
116 
117 #endif /* CXDOUBLEPROPERTY_H_ */
Utility class for describing a bounded numeric range.
Definition: cxDoubleRange.h:53
Helper class for storing one string value in an xml document.
boost::shared_ptr< class DoubleProperty > DoublePropertyPtr
virtual double convertDisplay2Internal(double display)
conversion from internal value to display value
virtual double convertInternal2Display(double internal)
conversion from internal value to display value (for example between 0..1 and percent) ...