Compute Library
 21.08
ToggleOption.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2018 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_UTILS_TOGGLEOPTION
25 #define ARM_COMPUTE_UTILS_TOGGLEOPTION
26 
27 #include "SimpleOption.h"
28 
29 #include <string>
30 
31 namespace arm_compute
32 {
33 namespace utils
34 {
35 /** Implementation of an option that can be either true or false. */
36 class ToggleOption : public SimpleOption<bool>
37 {
38 public:
40 
41  /** Construct the option with the given default value.
42  *
43  * @param[in] name Name of the option.
44  * @param[in] default_value Default value.
45  */
46  ToggleOption(std::string name, bool default_value);
47 
48  bool parse(std::string value) override;
49  std::string help() const override;
50 };
51 
52 inline ToggleOption::ToggleOption(std::string name, bool default_value)
53  : SimpleOption<bool>
54 {
55  std::move(name), default_value
56 }
57 {
58 }
59 
60 inline bool ToggleOption::parse(std::string value)
61 {
62  if(value == "true")
63  {
64  _value = true;
65  _is_set = true;
66  }
67  else if(value == "false")
68  {
69  _value = false;
70  _is_set = true;
71  }
72 
73  return _is_set;
74 }
75 
76 inline std::string ToggleOption::help() const
77 {
78  return "--" + name() + ", --no-" + name() + " - " + _help;
79 }
80 } // namespace utils
81 } // namespace arm_compute
82 #endif /* ARM_COMPUTE_UTILS_TOGGLEOPTION */
Implementation of an option that can be either true or false.
Definition: ToggleOption.h:36
ToggleOption(std::string name, bool default_value)
Construct the option with the given default value.
Definition: ToggleOption.h:52
SimpleOption(std::string name, T default_value)
Construct the option with the given default value.
Definition: SimpleOption.h:76
Copyright (c) 2017-2021 Arm Limited.
bool parse(std::string value) override
Parses the given string.
std::string name() const
Name of the option.
Definition: Option.h:115
const bool & value() const
Get the option value.
Definition: SimpleOption.h:112
std::string help() const override
Help message for the option.
Implementation of an option that accepts a single value.
Definition: SimpleOption.h:39