String.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
31
32// ArmarX
34
35namespace armarx::aron::data
36{
37
38 class String;
39 typedef std::shared_ptr<String> StringPtr;
40
41 class String : public detail::PrimitiveVariant<data::dto::AronString, std::string, String>
42 {
43 public:
44 /* constructors */
45 String(const Path& = Path());
46 String(const data::dto::AronStringPtr&, const Path& = Path());
47 String(const std::string&, const Path& = Path());
48
49 /* operators */
50 using detail::PrimitiveVariant<data::dto::AronString, std::string, String>::operator==;
51 bool operator==(const String&) const override;
52 bool operator==(const StringPtr&) const override;
53
54 /* static methods */
55 static StringPtr FromAronStringDTO(const data::dto::AronStringPtr& aron);
56 static data::dto::AronStringPtr ToAronStringDTO(const StringPtr& navigator);
57
58 /* public member functions */
59 data::dto::AronStringPtr toAronStringDTO() const;
60
61 /* virtual implementations */
62 void fromString(const std::string& setter) override;
63
64 std::string getShortName() const override;
65 std::string getFullName() const override;
66
67 type::VariantPtr recalculateType() const override;
68 bool fullfillsType(const type::VariantPtr&) const override;
69 };
70} // namespace armarx::aron::data
71
72namespace armarx::aron
73{
74 template <typename... _Args>
76 make_string(_Args&&... args)
77 {
78 return std::make_shared<aron::data::String>(args...);
79 }
80} // namespace armarx::aron
The Path class.
Definition Path.h:36
std::string getShortName() const override
get a short str representation of this variant
Definition String.cpp:108
type::VariantPtr recalculateType() const override
recalculate the type of a data variant. Please not tha the mapping ist NOT bijective,...
Definition String.cpp:128
static data::dto::AronStringPtr ToAronStringDTO(const StringPtr &navigator)
Definition String.cpp:88
std::string getFullName() const override
get the full str representation of this variant
Definition String.cpp:114
void fromString(const std::string &setter) override
set a primitive from a std string
Definition String.cpp:102
bool operator==(const String &) const override
Definition String.cpp:56
data::dto::AronStringPtr toAronStringDTO() const
Definition String.cpp:95
String(const Path &=Path())
Definition String.cpp:39
bool fullfillsType(const type::VariantPtr &) const override
checks, if the current data variant fullfills the given type
Definition String.cpp:120
static StringPtr FromAronStringDTO(const data::dto::AronStringPtr &aron)
Definition String.cpp:78
A convenience header to include all aron files (full include, not forward declared)
std::shared_ptr< String > StringPtr
std::shared_ptr< Variant > VariantPtr
aron::data::StringPtr make_string(_Args &&... args)
Definition String.h:76