ConditionCheckInRange.h
Go to the documentation of this file.
1 /*
2 * This file is part of ArmarX.
3 *
4 * Copyright (C) 2011-2016, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
5 *
6 * ArmarX is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 *
10 * ArmarX is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 *
18 * @package ArmarX::Core
19 * @author Kai Welke (welke _at_ kit _dot_ edu)
20 * @date 2011
21 * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
22 * GNU General Public License
23 */
24 
25 #pragma once
26 
30 
31 namespace armarx
32 {
33  /**
34  * \ingroup ConditionChecks
35  *
36  * Checks if the numbers published in the relevant data fields are within a reference range.
37  *
38  * Parameters: The lower and upper bound of the reference range
39  * Supported types: Int, Float, Double
40  */
42  public ConditionCheck
43  {
44  public:
46  {
47  setNumberParameters(2);
48 
49  addSupportedType(VariantType::Int, createParameterTypeList(2, VariantType::Int, VariantType::Int));
50  addSupportedType(VariantType::Long, createParameterTypeList(2, VariantType::Long, VariantType::Long));
51  addSupportedType(VariantType::Float, createParameterTypeList(2, VariantType::Float, VariantType::Float));
52  addSupportedType(VariantType::Double, createParameterTypeList(2, VariantType::Double, VariantType::Double));
53  }
54 
55  ConditionCheck* clone() override
56  {
57  return new ConditionCheckInRange(*this);
58  }
59 
60  bool evaluate(const StringVariantMap& dataFields) override
61  {
62  if (dataFields.size() != 1)
63  {
64  ARMARX_WARNING_S << "Size of dataFields: " << dataFields.size();
65  throw InvalidConditionException("Wrong number of datafields for condition InRange ");
66  }
67 
68  const Variant& value = dataFields.begin()->second;
69  VariantTypeId type = value.getType();
70 
71  if (type == VariantType::Int)
72  {
73  return (value.getInt() > getParameter(0).getInt()) && (value.getInt() < getParameter(1).getInt());
74  }
75 
76  if (type == VariantType::Long)
77  {
78  return (value.getLong() > getParameter(0).getLong()) && (value.getLong() < getParameter(1).getLong());
79  }
80 
81  if (type == VariantType::Float)
82  {
83  return (value.getFloat() > getParameter(0).getFloat()) && (value.getFloat() < getParameter(1).getFloat());
84  }
85 
86  if (type == VariantType::Double)
87  {
88  return (value.getDouble() > getParameter(0).getDouble()) && (value.getDouble() < getParameter(1).getDouble());
89  }
90 
91  return false;
92  }
93  };
94 }
95 
armarx::ConditionCheckInRange::ConditionCheckInRange
ConditionCheckInRange()
Definition: ConditionCheckInRange.h:45
armarx::Variant
The Variant class is described here: Variants.
Definition: Variant.h:224
armarx::VariantType::Float
const VariantTypeId Float
Definition: Variant.h:918
armarx::StringVariantMap
std::map< std::string, Variant > StringVariantMap
Definition: Variant.h:748
armarx::VariantType::Double
const VariantTypeId Double
Definition: Variant.h:919
cxxopts::value
std::shared_ptr< Value > value()
Definition: cxxopts.hpp:926
armarx::ConditionCheckInRange::evaluate
bool evaluate(const StringVariantMap &dataFields) override
Evaluate the condition based on the current data field values.
Definition: ConditionCheckInRange.h:60
armarx::ConditionCheckInRange::clone
ConditionCheck * clone() override
Clones the current check.
Definition: ConditionCheckInRange.h:55
armarx::VariantType::Long
const VariantTypeId Long
Definition: Variant.h:917
armarx::VariantTypeId
Ice::Int VariantTypeId
Definition: Variant.h:44
ARMARX_WARNING_S
#define ARMARX_WARNING_S
Definition: Logging.h:206
armarx::ConditionCheck
Definition: ConditionCheck.h:56
armarx::ConditionCheckInRange
Definition: ConditionCheckInRange.h:41
armarx::VariantType::Int
const VariantTypeId Int
Definition: Variant.h:916
ImportExport.h
ConditionCheck.h
ARMARXCORE_IMPORT_EXPORT
#define ARMARXCORE_IMPORT_EXPORT
Definition: ImportExport.h:38
Logging.h
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:28