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
31namespace 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 {
43 public:
57
59 clone() override
60 {
61 return new ConditionCheckInRange(*this);
62 }
63
64 bool
65 evaluate(const StringVariantMap& dataFields) override
66 {
67 if (dataFields.size() != 1)
68 {
69 ARMARX_WARNING_S << "Size of dataFields: " << dataFields.size();
70 throw InvalidConditionException(
71 "Wrong number of datafields for condition InRange ");
72 }
73
74 const Variant& value = dataFields.begin()->second;
75 VariantTypeId type = value.getType();
76
77 if (type == VariantType::Int)
78 {
79 return (value.getInt() > getParameter(0).getInt()) &&
80 (value.getInt() < getParameter(1).getInt());
81 }
82
83 if (type == VariantType::Long)
84 {
85 return (value.getLong() > getParameter(0).getLong()) &&
86 (value.getLong() < getParameter(1).getLong());
87 }
88
89 if (type == VariantType::Float)
90 {
91 return (value.getFloat() > getParameter(0).getFloat()) &&
92 (value.getFloat() < getParameter(1).getFloat());
93 }
94
95 if (type == VariantType::Double)
96 {
97 return (value.getDouble() > getParameter(0).getDouble()) &&
98 (value.getDouble() < getParameter(1).getDouble());
99 }
100
101 return false;
102 }
103 };
104} // namespace armarx
#define ARMARXCORE_IMPORT_EXPORT
ConditionCheck * clone() override
Clones the current check.
bool evaluate(const StringVariantMap &dataFields) override
Evaluate the condition based on the current data field values.
A ConditionCheck implements a check on the sensor data stream of a Sensor-Actor Unit.
static ParameterTypeList createParameterTypeList(int numberTypes,...)
void setNumberParameters(int numberParameters)
Sets the number of paramaters required for this check.
const Variant & getParameter(int index)
Retrieve parameters of check.
ConditionCheck()
Creates and initializes a ConditionCheck instance.
void addSupportedType(VariantTypeId dataFieldType=0, ParameterTypeList parameterTypes=ParameterTypeList())
Add a supported type for elementary condition check marks pairs of (dataFieldType,...
The Variant class is described here: Variants.
Definition Variant.h:224
#define ARMARX_WARNING_S
The logging level for unexpected behaviour, but not a serious problem.
Definition Logging.h:213
const VariantTypeId Int
Definition Variant.h:917
const VariantTypeId Long
Definition Variant.h:918
const VariantTypeId Double
Definition Variant.h:920
const VariantTypeId Float
Definition Variant.h:919
This file offers overloads of toIce() and fromIce() functions for STL container types.
Ice::Int VariantTypeId
Definition Variant.h:43
std::map< std::string, Variant > StringVariantMap
Definition Variant.h:748