blob: c38be2af72b0b328dee8a609382a6f6ae0115e1f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/*
* Copyright 2008-2009 Ben Boeckel <MathStuf@gmail.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* \file sigcore/Range.h
*/
#ifndef SIGCORE_RANGE
#define SIGCORE_RANGE
// Sigcore includes
#include "Global.h"
// Qt includes
#include <QtCore/QMetaType>
namespace Sigcore
{
/**
* \class Sigcore::Range Range.h sigcore/Range.h
* \brief Class that represents a range of values.
*/
class SIGCORE_EXPORT Range
{
public:
/**
* Default constructor.
*/
Range();
/**
* Conversion constructor.
*
* \param value Value to set the range to.
*/
Range(const double value);
/**
* Constructor.
*
* \param minimum The minimum value of the range.
* \param maximum The maximum value of the range.
*/
Range(const double minimum, const double maximum);
/**
* Sets the values for the range.
*
* \param minimum The minimum value of the range.
* \param maximum The maximum value of the range.
*/
void set(const double minimum, const double maximum);
/**
* Set the minimum value for the range.
*
* \param minimum The minimum value of the range.
*/
void setMinimum(const double minimum);
/**
* Set the maximum value for the range.
*
* \param maximum The maximum value of the range.
*/
void setMaximum(const double maximum);
/**
* \sa setMinimum
*
* \return The minimum value of the range.
*/
double minimum() const;
/**
* \sa setMaximum
*
* \return The maximum value of the range.
*/
double maximum() const;
/**
* \return \p true if the range is valid, \p false otherwise.
*/
bool valid() const;
/**
* \param value The value to check for.
*
* \return \p true if the range contains \p value, \p false otherwise.
*/
bool in(const double value) const;
/**
* \param range The range to check for.
*
* \return \p true if \p range is completely within the range, \p false otherwise.
*/
bool in(const Range& range) const;
/**
* Intersects two ranges.
*
* \param rhs The range to intersect with.
* \return The common range.
*/
Range operator&(const Range& rhs) const;
Range& operator&=(const Range& rhs);
/**
* Merges two ranges.
*
* \param rhs The range to merge with.
* \return The merged range.
*/
Range operator|(const Range& rhs) const;
Range& operator|=(const Range& rhs);
Range& operator=(const Range& rhs);
Range operator-() const;
Range operator+(const Range& rhs) const;
Range operator-(const Range& rhs) const;
Range operator*(const Range& rhs) const;
Range operator/(const Range& rhs) const;
Range& operator+=(const Range& rhs);
Range& operator-=(const Range& rhs);
Range& operator*=(const Range& rhs);
Range& operator/=(const Range& rhs);
bool operator==(const Range& rhs) const;
bool operator!=(const Range& rhs) const;
private:
double m_minimum;
double m_maximum;
};
}
Q_DECLARE_METATYPE(Sigcore::Range)
#endif
|
