Fraxinus  16.5.0-fx-rc9
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxDoubleRange.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  * sscDoubleRange.h
36  *
37  * Created on: Jun 23, 2010
38  * Author: christiana
39  */
40 #ifndef CXDOUBLERANGE_H_
41 #define CXDOUBLERANGE_H_
42 
43 #include "cxResourceExport.h"
44 
45 namespace cx
46 {
47 
53 struct cxResource_EXPORT DoubleRange
54 {
56  mMin(0), mMax(1), mStep(0.1)
57  {
58  }
59  DoubleRange(double min, double max, double step) :
60  mMin(min), mMax(max), mStep(step)
61  {
62  }
63  double mMin;
64  double mMax;
65  double mStep;
66  double min() const
67  {
68  return mMin;
69  }
70  double max() const
71  {
72  return mMax;
73  }
74  double step() const
75  {
76  return mStep;
77  }
78  double resolution() const
79  {
80  return (mMax - mMin) / mStep;
81  }
82  double range() const
83  {
84  return mMax - mMin;
85  }
86 
89  double constrainValue(double val)
90  {
91  if (val <= mMin)
92  return mMin;
93  if (val >= mMax)
94  return mMax;
95  return val;
96  }
97 };
98 
99 }
100 #endif /* CXDOUBLERANGE_H_ */
double max() const
maximum value
Definition: cxDoubleRange.h:70
Utility class for describing a bounded numeric range.
Definition: cxDoubleRange.h:53
double resolution() const
number of steps in range (1 step means 1 resolution).
Definition: cxDoubleRange.h:78
double min() const
minimum value
Definition: cxDoubleRange.h:66
double constrainValue(double val)
Definition: cxDoubleRange.h:89
double step() const
smallest reasonable increment
Definition: cxDoubleRange.h:74
DoubleRange(double min, double max, double step)
Definition: cxDoubleRange.h:59
double range() const
max - min
Definition: cxDoubleRange.h:82