Zivid C++ API 2.9.0+4dbba385-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-2023 (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
92
93#include <chrono>
94#include <sstream>
95#include <stdexcept>
96
97namespace Zivid
98{
99#ifndef NO_DOC
101 namespace Detail
102 {
103 template<typename UnderlyingType, typename Unit>
104 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &os, std::chrono::duration<UnderlyingType, Unit> value);
105
106 template<typename Clock, typename Duration>
107 ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &os, std::chrono::time_point<Clock, Duration> value);
108 } // namespace Detail
109#endif
110
116 template<typename T>
117 class Range
118 {
119 public:
121 using Type = T;
122
124 constexpr Range() = default;
125
127 constexpr Range(T min, T max)
128 : m_min{ std::move(min) }
129 , m_max{ std::move(
130 min <= max ? max : throw std::invalid_argument{ "Range is expected to have min <= max" }) }
131 {}
132
134 constexpr const T &min() const
135 {
136 return m_min;
137 }
138
140 constexpr const T &max() const
141 {
142 return m_max;
143 }
144
150 constexpr bool isInRange(const T &value) const
151 {
152 return value >= m_min && value <= m_max;
153 }
154
156 bool operator==(const Range<T> &other) const
157 {
158 return m_min == other.m_min && m_max == other.m_max;
159 }
160
162 bool operator!=(const Range<T> &other) const
163 {
164 return !operator==(other);
165 }
166
168 std::string toString() const
169 {
170 using Zivid::Detail::operator<<;
171 std::ostringstream stream;
172 stream << "{ " << m_min << ", " << m_max << " }";
173 return std::move(stream).str();
174 }
175
176 private:
177 T m_min = {};
178 T m_max = {};
179 };
180
182 template<typename T>
183 std::ostream &operator<<(std::ostream &os, const Range<T> &range)
184 {
185 return os << range.toString();
186 }
187} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition: CoreExport.h:101
Class describing a range of values for a given type T
Definition: Range.h:118
constexpr const T & min() const
Get the minimum value of the range
Definition: Range.h:134
bool operator!=(const Range< T > &other) const
Comparison operator
Definition: Range.h:162
constexpr Range(T min, T max)
Constructor
Definition: Range.h:127
constexpr bool isInRange(const T &value) const
Check if the value is in range
Definition: Range.h:150
bool operator==(const Range< T > &other) const
Comparison operator
Definition: Range.h:156
std::string toString() const
Get the range as string
Definition: Range.h:168
T Type
Underlying type
Definition: Range.h:121
constexpr const T & max() const
Get the maximum value of the range
Definition: Range.h:140
constexpr Range()=default
Default constructor
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:243