Zivid C++ API  2.4.2+1a2e8cfb-1
Defining the Future of 3D Machine Vision
Range.h
Go to the documentation of this file.
1 
2 
3 /*******************************************************************************
4 
5  * This file is part of the Zivid 3D Camera API
6 
7  *
8 
9  * Copyright 2015-2021 (C) Zivid AS
10 
11  * All rights reserved.
12 
13  *
14 
15  * Zivid Software License, v1.0
16 
17  *
18 
19  * Redistribution and use in source and binary forms, with or without
20 
21  * modification, are permitted provided that the following conditions are met:
22 
23  *
24 
25  * 1. Redistributions of source code must retain the above copyright notice,
26 
27  * this list of conditions and the following disclaimer.
28 
29  *
30 
31  * 2. Redistributions in binary form must reproduce the above copyright notice,
32 
33  * this list of conditions and the following disclaimer in the documentation
34 
35  * and/or other materials provided with the distribution.
36 
37  *
38 
39  * 3. Neither the name of Zivid AS nor the names of its contributors may be used
40 
41  * to endorse or promote products derived from this software without specific
42 
43  * prior written permission.
44 
45  *
46 
47  * 4. This software, with or without modification, must not be used with any
48 
49  * other 3D camera than from Zivid AS.
50 
51  *
52 
53  * 5. Any software provided in binary form under this license must not be
54 
55  * reverse engineered, decompiled, modified and/or disassembled.
56 
57  *
58 
59  * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
60 
61  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
62 
63  * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
64 
65  * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
66 
67  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
68 
69  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
70 
71  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
72 
73  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
74 
75  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
76 
77  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
78 
79  *
80 
81  * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
82 
83  * Info: http://www.zivid.com
84 
85  ******************************************************************************/
86 
87 
88 
89 #pragma once
90 
91 #include <sstream>
92 
93 namespace Zivid
94 {
100  template<typename T>
101  class Range
102  {
103  public:
105  constexpr Range(T min, T max)
106  : m_min{ std::move(min) }
107  , m_max{ std::move(max) }
108  {}
109 
111  constexpr const T &min() const
112  {
113  return m_min;
114  }
115 
117  constexpr const T &max() const
118  {
119  return m_max;
120  }
121 
127  constexpr bool isInRange(const T &value) const
128  {
129  return value >= m_min && value <= m_max;
130  }
131 
133  bool operator==(const Range<T> &other) const
134  {
135  return m_min == other.m_min && m_max == other.m_max;
136  }
137 
139  bool operator!=(const Range<T> &other) const
140  {
141  return !operator==(other);
142  }
143 
145  std::string toString() const
146  {
147  std::stringstream stream;
148  stream << "{ " << m_min << ", " << m_max << " }";
149  return stream.str();
150  }
151 
152  private:
153  T m_min;
154  T m_max;
155  };
156 
158  template<typename T>
159  std::ostream &operator<<(std::ostream &os, const Range<T> &range)
160  {
161  return os << range.toString();
162  }
163 } // namespace Zivid
Class describing a range of values for a given type T
Definition: Range.h:102
bool operator!=(const Range< T > &other) const
Comparison operator
Definition: Range.h:139
constexpr Range(T min, T max)
Constructor
Definition: Range.h:105
constexpr bool isInRange(const T &value) const
Check if the value is in range
Definition: Range.h:127
bool operator==(const Range< T > &other) const
Comparison operator
Definition: Range.h:133
constexpr const T & max() const
Get the maximum value of the range
Definition: Range.h:117
std::string toString() const
Get the range as string
Definition: Range.h:145
constexpr const T & min() const
Get the minimum value of the range
Definition: Range.h:111
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:99
std::ostream & operator<<(std::ostream &stream, const Array2D< T > &array)
Serialize array information to a stream
Definition: Array2D.h:214