Antares Simulator
Power System Simulator
modulo.h
1 /*
2  * Copyright 2007-2025, RTE (https://www.rte-france.com)
3  * See AUTHORS.txt
4  * SPDX-License-Identifier: MPL-2.0
5  * This file is part of Antares-Simulator,
6  * Adequacy and Performance assessment for interconnected energy networks.
7  *
8  * Antares_Simulator is free software: you can redistribute it and/or modify
9  * it under the terms of the Mozilla Public Licence 2.0 as published by
10  * the Mozilla Foundation, either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * Antares_Simulator is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * Mozilla Public Licence 2.0 for more details.
17  *
18  * You should have received a copy of the Mozilla Public Licence 2.0
19  * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
20  */
21 #ifndef __ANTARES_TOOLBOX_FILTER_OPERATOR_MODULO_H__
22 #define __ANTARES_TOOLBOX_FILTER_OPERATOR_MODULO_H__
23 
24 #include "../operator.h"
25 
26 namespace Antares::Toolbox::Filter::Operator
27 {
28 class Modulo: public AOperator
29 {
30 public:
31  Modulo(AFilterBase* parent):
32  AOperator(parent, wxT("%"), wxT("modulo"))
33  {
34  // When the operator is the modulo, we must have another
35  // value
36  parameters.push_back(Parameter(*this).presetModuloAddon());
37  }
38 
39  virtual ~Modulo()
40  {
41  }
42 
43  virtual bool compute(const int a) const
44  {
45  return parameters[0].value.asInt
46  ? (a % parameters[0].value.asInt == parameters[1].value.asInt)
47  : false;
48  }
49 
50  virtual bool compute(const double a) const
51  {
52  return (int(floor(a)) % parameters[0].value.asInt == parameters[1].value.asInt);
53  }
54 
55  virtual bool compute(const wxString&) const
56  {
57  return false;
58  }
59 
60 }; // class Modulo
61 
62 } // namespace Antares::Toolbox::Filter::Operator
63 
64 #endif // __ANTARES_TOOLBOX_FILTER_OPERATOR_MODULO_H__
Abstract Filter.
Definition: filter.h:48
Parameter::List parameters
Additional parameters.
Definition: operator.h:89
AOperator(AFilterBase *parent, const wxChar *name, const wxChar *caption)
namespace Constructor & Destructor
Definition: operator.cpp:26
Single parameter.
Definition: parameter.h:52
Parameter & presetModuloAddon()
Preset: Modulo.
Definition: parameter.cpp:199