Bool.h
Go to the documentation of this file.
1 /*
2  * This file is part of ArmarX.
3  *
4  * Copyright (C) 2012-2016, High Performance Humanoid Technologies (H2T),
5  * Karlsruhe Institute of Technology (KIT), all rights reserved.
6  *
7  * ArmarX is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  *
11  * ArmarX is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <http://www.gnu.org/licenses/>.
18  *
19  * @author Fabian Peller-Konrad (fabian dot peller-konrad at kit dot edu)
20  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
21  * GNU General Public License
22  */
23 
24 #pragma once
25 
26 // STD/STL
27 #include <memory>
28 
29 // Base class
30 #include "../detail/PrimitiveVariant.h"
31 
32 // ArmarX
33 #include "../../../type/variant/primitive/Bool.h"
34 
35 namespace armarx::aron::data
36 {
37 
38  class Bool;
39  typedef std::shared_ptr<Bool> BoolPtr;
40 
41  class Bool :
42  public detail::PrimitiveVariant<data::dto::AronBool, bool, Bool>
43  {
44  public:
45  /* constructors */
46  Bool(const Path& = Path());
47  Bool(const data::dto::AronBoolPtr&, const Path& = Path());
48  Bool(const bool, const Path& = Path());
49 
50  // operators
52 
53  bool operator==(const Bool& other) const override;
54  bool operator==(const BoolPtr&) const override;
55 
56  // static methods
57  static BoolPtr FromAronBoolDTO(const data::dto::AronBoolPtr& aron);
58  static data::dto::AronBoolPtr ToAronBoolDTO(const BoolPtr& navigator);
59 
60  // class methods
61  data::dto::AronBoolPtr toAronBoolDTO() const;
62 
63  /* virtual implementations */
64  void fromString(const std::string& setter) override;
65 
66  std::string getShortName() const override;
67  std::string getFullName() const override;
68 
69  type::VariantPtr recalculateType() const override;
70  bool fullfillsType(const type::VariantPtr&) const override;
71  };
72 }
73 
74 namespace armarx::aron
75 {
76  template<typename... _Args>
77  aron::data::BoolPtr make_bool(_Args&&... args)
78  {
79  return std::make_shared<aron::data::Bool>(args...);
80  }
81 }
armarx::aron::data::Bool::toAronBoolDTO
data::dto::AronBoolPtr toAronBoolDTO() const
Definition: Bool.cpp:93
armarx::aron::type::VariantPtr
std::shared_ptr< Variant > VariantPtr
Definition: forward_declarations.h:11
armarx::aron::data::Bool
Definition: Bool.h:41
armarx::aron::data::Bool::Bool
Bool(const Path &=Path())
Definition: Bool.cpp:37
armarx::VariantType::Bool
const VariantTypeId Bool
Definition: Variant.h:915
armarx::aron::data::Bool::fromString
void fromString(const std::string &setter) override
set a primitive from a std string
Definition: Bool.cpp:100
armarx::aron::Path
The Path class.
Definition: Path.h:36
armarx::aron::make_bool
aron::data::BoolPtr make_bool(_Args &&... args)
Definition: Bool.h:77
armarx::aron::data::Bool::recalculateType
type::VariantPtr recalculateType() const override
recalculate the type of a data variant. Please not tha the mapping ist NOT bijective,...
Definition: Bool.cpp:139
armarx::aron
Definition: DataDisplayVisitor.cpp:5
armarx::aron::data::Bool::getShortName
std::string getShortName() const override
get a short str representation of this variant
Definition: Bool.cpp:119
armarx::aron::data::Bool::fullfillsType
bool fullfillsType(const type::VariantPtr &) const override
checks, if the current data variant fullfills the given type
Definition: Bool.cpp:131
armarx::aron::data
A convenience header to include all aron files (full include, not forward declared)
Definition: aron_conversions.cpp:3
armarx::aron::data::detail::PrimitiveVariant
Definition: PrimitiveVariant.h:40
armarx::aron::data::Bool::ToAronBoolDTO
static data::dto::AronBoolPtr ToAronBoolDTO(const BoolPtr &navigator)
Definition: Bool.cpp:86
armarx::aron::data::Bool::FromAronBoolDTO
static BoolPtr FromAronBoolDTO(const data::dto::AronBoolPtr &aron)
Definition: Bool.cpp:76
armarx::aron::data::Bool::getFullName
std::string getFullName() const override
get the full str representation of this variant
Definition: Bool.cpp:125
armarx::armem::server::ltm::detail::mixin::Path
std::filesystem::path Path
Definition: DiskStorageMixin.h:17
armarx::aron::data::detail::SpecializedVariantBase< data::dto::AronBool, Bool >::aron
AronDataType::PointerType aron
Definition: SpecializedVariant.h:154
armarx::aron::data::Bool::operator==
bool operator==(const Bool &other) const override
Definition: Bool.cpp:54
armarx::aron::data::BoolPtr
std::shared_ptr< Bool > BoolPtr
Definition: forward_declarations.h:38