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