SpecializedVariant.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 "../Variant.h"
31 
32 // ArmarX
34 
36 {
37  template <typename AronDataT, typename DerivedT>
39  {
40  public:
42  using PointerType = std::shared_ptr<DerivedT>;
43  using AronDataType = AronDataT;
44 
45  public:
46  SpecializedVariantBase() = delete;
47 
50  {
51  }
52 
53  SpecializedVariantBase(const typename AronDataType::PointerType& o,
55  const Path& path = Path()) :
57  {
59  }
60 
61  virtual ~SpecializedVariantBase() = default;
62 
63  // operators
64  operator typename AronDataType::PointerType()
65  {
66  return aron;
67  }
68 
69  bool
70  operator==(const Variant& other) const override
71  {
72  const auto& n = DerivedT::DynamicCast(other);
73  return *this == n;
74  }
75 
76  virtual bool operator==(const DerivedT&) const = 0;
77  virtual bool operator==(const PointerType& other) const = 0;
78 
79  // new interface methods
80  virtual PointerType
81  clone() const
82  {
83  return clone(getPath());
84  }
85 
86  virtual PointerType clone(const Path& newPath) const = 0;
87 
88  // virtual implementations
90  cloneAsVariant() const override
91  {
92  return clone();
93  }
94 
96  cloneAsVariant(const Path& newPath) const override
97  {
98  return clone(newPath);
99  }
100 
101  data::dto::GenericDataPtr
102  toAronDTO() const override
103  {
104  return aron;
105  }
106 
107  VariantPtr
108  navigateRelative(const Path& path) const override
109  {
110  Path absoluteFromHere = path.getWithoutPrefix(getPath());
111  return navigateAbsolute(absoluteFromHere);
112  }
113 
114  // static methods
115  static PointerType
117  {
118  return std::dynamic_pointer_cast<DerivedT>(n);
119  }
120 
121  static DerivedT&
123  {
124  return dynamic_cast<DerivedT&>(n);
125  }
126 
127  static const DerivedT&
129  {
130  return dynamic_cast<const DerivedT&>(n);
131  }
132 
133  static PointerType
135  {
136  if (!n)
137  {
138  return nullptr;
139  }
140 
141  PointerType casted = DerivedT::DynamicCast(n);
142  ARMARX_CHECK_NOT_NULL(casted)
143  << "The path was: " << n->getPath().toString() << ".\n"
144  << "It has the descriptor: '"
146  << "'.\n"
147  << "And the typeid: " << typeid(n).name() << ". Tried to cast to "
148  << typeid(PointerType).name();
149  return casted;
150  }
151 
152  protected:
153  typename AronDataType::PointerType aron;
154  };
155 } // namespace armarx::aron::data::detail
armarx::aron::data::Variant::descriptor
const data::Descriptor descriptor
Definition: Variant.h:155
armarx::aron::data::detail::SpecializedVariantBase::navigateRelative
VariantPtr navigateRelative(const Path &path) const override
navigate relative
Definition: SpecializedVariant.h:108
armarx::aron::data::defaultconversion::string::Descriptor2String
const std::map< data::Descriptor, std::string > Descriptor2String
Definition: Descriptor.h:207
ARMARX_CHECK_NOT_NULL
#define ARMARX_CHECK_NOT_NULL(ptr)
This macro evaluates whether ptr is not null and if it turns out to be false it will throw an Express...
Definition: ExpressionException.h:206
armarx::aron::data::Variant::getPath
Path getPath() const
get the path
Definition: Variant.h:110
armarx::aron::data::Variant::PointerType
VariantPtr PointerType
Definition: Variant.h:63
armarx::aron::data::Variant::path
const Path path
Definition: Variant.h:156
armarx::aron::data::Descriptor
Descriptor
Definition: Descriptor.h:179
armarx::aron::data::detail::SpecializedVariantBase::DynamicCastAndCheck
static PointerType DynamicCastAndCheck(const VariantPtr &n)
Definition: SpecializedVariant.h:134
magic_enum::detail::n
constexpr auto n() noexcept
Definition: magic_enum.hpp:418
armarx::aron::data::detail::SpecializedVariantBase::clone
virtual PointerType clone() const
Definition: SpecializedVariant.h:81
armarx::aron::data::Variant::navigateAbsolute
virtual VariantPtr navigateAbsolute(const Path &path) const =0
naviate absolute
armarx::aron::data::detail::SpecializedVariantBase::SpecializedVariantBase
SpecializedVariantBase(const typename AronDataType::PointerType &o, const data::Descriptor descriptor, const Path &path=Path())
Definition: SpecializedVariant.h:53
armarx::aron::data::detail::SpecializedVariantBase::DynamicCast
static PointerType DynamicCast(const VariantPtr &n)
Definition: SpecializedVariant.h:116
armarx::aron::Path
The Path class.
Definition: Path.h:35
armarx::aron::data::VariantPtr
std::shared_ptr< Variant > VariantPtr
Definition: forward_declarations.h:11
armarx::aron::data::detail
Definition: ComplexVariant.h:34
armarx::aron::data::detail::SpecializedVariantBase::SpecializedVariantBase
SpecializedVariantBase()=delete
armarx::aron::data::detail::SpecializedVariantBase::~SpecializedVariantBase
virtual ~SpecializedVariantBase()=default
armarx::aron::data::detail::SpecializedVariantBase::DynamicCast
static const DerivedT & DynamicCast(const Variant &n)
Definition: SpecializedVariant.h:128
armarx::aron::data::Variant
The Variant class.
Definition: Variant.h:60
armarx::aron::data::detail::SpecializedVariantBase::cloneAsVariant
VariantPtr cloneAsVariant(const Path &newPath) const override
Definition: SpecializedVariant.h:96
armarx::aron::data::detail::SpecializedVariantBase::DynamicCast
static DerivedT & DynamicCast(Variant &n)
Definition: SpecializedVariant.h:122
ExpressionException.h
armarx::aron::data::detail::SpecializedVariantBase::toAronDTO
data::dto::GenericDataPtr toAronDTO() const override
convert the variant to the ice representation
Definition: SpecializedVariant.h:102
armarx::aron::data::detail::SpecializedVariantBase::operator==
bool operator==(const Variant &other) const override
Definition: SpecializedVariant.h:70
armarx::navigation::core::Path
std::vector< Pose > Path
Definition: basic_types.h:46
armarx::aron::data::detail::SpecializedVariantBase
Definition: SpecializedVariant.h:38
armarx::aron::Path::getWithoutPrefix
Path getWithoutPrefix(const Path &) const
Definition: Path.cpp:218
armarx::aron::data::detail::SpecializedVariantBase< data::dto::AronInt, Int >::AronDataType
data::dto::AronInt AronDataType
Definition: SpecializedVariant.h:43
armarx::aron::data::detail::SpecializedVariantBase::cloneAsVariant
VariantPtr cloneAsVariant() const override
get a pointer to a copy of this variant
Definition: SpecializedVariant.h:90
armarx::aron::data::detail::SpecializedVariantBase::aron
AronDataType::PointerType aron
Definition: SpecializedVariant.h:153
armarx::aron::data::detail::SpecializedVariantBase::SpecializedVariantBase
SpecializedVariantBase(const data::Descriptor descriptor, const Path &path=Path())
Definition: SpecializedVariant.h:48
armarx::aron::data::detail::SpecializedVariantBase::PointerType
std::shared_ptr< DerivedT > PointerType
Definition: SpecializedVariant.h:42