ad_physics
DurationValidInputRange.hpp
Go to the documentation of this file.
1 /*
2  * ----------------- BEGIN LICENSE BLOCK ---------------------------------
3  *
4  * Copyright (C) 2018-2020 Intel Corporation
5  *
6  * SPDX-License-Identifier: MIT
7  *
8  * ----------------- END LICENSE BLOCK -----------------------------------
9  */
10 
18 #pragma once
19 
20 #include <cmath>
21 #include <limits>
22 #include "ad/physics/Duration.hpp"
23 #include "spdlog/fmt/ostr.h"
24 #include "spdlog/spdlog.h"
25 
39 inline bool withinValidInputRange(::ad::physics::Duration const &input, bool const logErrors = true)
40 {
41  // check for generic numeric limits of the type
42  bool inValidInputRange = input.isValid() && (std::numeric_limits<::ad::physics::Duration>::lowest() <= input)
44  if (!inValidInputRange && logErrors)
45  {
46  spdlog::error("withinValidInputRange(::ad::physics::Duration)>> {} out of numerical limits [{}, {}]",
47  input,
50  }
51  // check for individual input range
52  if (inValidInputRange)
53  {
54  inValidInputRange = (::ad::physics::Duration(0.) <= input) && (input <= ::ad::physics::Duration(1e6));
55  if (!inValidInputRange && logErrors)
56  {
57  spdlog::error("withinValidInputRange(::ad::physics::Duration)>> {} out of valid input range [{}, {}]",
58  input,
60  ::ad::physics::Duration(1e6)); // LCOV_EXCL_BR_LINE
61  }
62  }
63  return inValidInputRange;
64 }
std::numeric_limits<::ad::physics::Duration >::lowest
static inline ::ad::physics::Duration lowest()
Definition: Duration.hpp:522
std::numeric_limits<::ad::physics::Duration >::max
static inline ::ad::physics::Duration max()
Definition: Duration.hpp:529
withinValidInputRange
bool withinValidInputRange(::ad::physics::Duration const &input, bool const logErrors=true)
check if the given Duration is within valid input range
Definition: DurationValidInputRange.hpp:39
ad::physics::Duration
DataType Duration.
Definition: Duration.hpp:67
ad::physics::Duration::isValid
bool isValid() const
Definition: Duration.hpp:403
Duration.hpp