Fraxinus  17.12-rc2
An IGT application
cxDoublePairProperty.cpp
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 #include "cxDoublePairProperty.h"
34 #include "cxTypeConversions.h"
35 #include "cxVector3D.h"
36 
37 namespace cx
38 {
39 
43 DoublePairPropertyPtr DoublePairProperty::initialize(const QString& uid, QString name, QString help,
44  DoubleRange range, int decimals, QDomNode root)
45 {
47  retval->mUid = uid;
48  retval->mName = name.isEmpty() ? uid : name;
49  retval->mHelp = help;
50  retval->mRange = range;
51  retval->mStore = XmlOptionItem(uid, root.toElement());
52  retval->mValue = fromString(retval->mStore.readValue(qstring_cast(Eigen::Vector2d(0, 0))));
53  retval->mDecimals = decimals;
54  return retval;
55 }
56 
57 DoublePairProperty::DoublePairProperty()
58 {
59  mFactor = 1.0;
60 }
61 
63 {
64  mFactor = factor;
65 }
66 
68 {
69  return mName;
70 }
71 
73 {
74  return mUid;
75 }
76 
78 {
79  return mHelp;
80 }
81 
82 Eigen::Vector2d DoublePairProperty::getValue() const
83 {
84  return mValue;
85 }
86 
87 bool DoublePairProperty::setValue(const Eigen::Vector2d& val)
88 {
89  if (val == mValue)
90  return false;
91 
92  mValue = val;
93  mStore.writeValue(qstring_cast(val));
94  emit valueWasSet();
95  emit changed();
96  return true;
97 }
98 
100 {
101  return mRange;
102 }
103 
105 {
106  mRange = range;
107  emit changed();
108 }
109 
111 {
112  return mDecimals;
113 }
114 
115 } // namespace cx
QString qstring_cast(const T &val)
void setInternal2Display(double factor)
virtual QString getDisplayName() const
name of data entity. Used for display to user.
virtual DoubleRange getValueRange() const
Eigen::Vector2d fromString(const QString &text)
Definition: cxVector3D.cpp:127
Utility class for describing a bounded numeric range.
Definition: cxDoubleRange.h:53
virtual Eigen::Vector2d getValue() const
get the data value.
virtual QString getHelp() const
return a descriptive help string for the data, used for example as a tool tip.
virtual void setValueRange(DoubleRange range)
range of value. Use if data is constrained to a set.
Helper class for storing one string value in an xml document.
virtual int getValueDecimals() const
number of relevant decimals in value
Implementation of DoublePairPropertyBase.
virtual bool setValue(const Eigen::Vector2d &value)
set the data value.
virtual QString getUid() const
void changed()
emit when the underlying data value is changed: The user interface will be updated.
void writeValue(const QString &val)
boost::shared_ptr< class DoublePairProperty > DoublePairPropertyPtr
static DoublePairPropertyPtr initialize(const QString &uid, QString name, QString help, DoubleRange range, int decimals, QDomNode root=QDomNode())
Namespace for all CustusX production code.