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 <string>
28 
29 // Base class
30 #include "../detail/PrimitiveVariant.h"
31 
32 namespace armarx::aron::type
33 {
34  /**
35  * @brief The String class. It represents the string type
36  */
37  class String : public detail::PrimitiveVariant<type::dto::AronString, String, std::string>
38  {
39  public:
41 
42  /* constructors */
43  String(const Path& = Path());
44  String(const type::dto::AronString&, const Path& = Path());
45 
46  type::dto::AronStringPtr toStringDTO() const;
47 
48  /* virtual implementations */
49  virtual std::string getShortName() const override;
50  virtual std::string getFullName() const override;
51  };
52 } // namespace armarx::aron::type
armarx::aron::Path
The Path class.
Definition: Path.h:36
armarx::aron::type::String::String
String(const Path &=Path())
Definition: String.cpp:35
armarx::aron::type::detail::PrimitiveVariant
Definition: PrimitiveVariant.h:39
armarx::aron::type::String::toStringDTO
type::dto::AronStringPtr toStringDTO() const
Definition: String.cpp:46
armarx::aron::type::String::getFullName
virtual std::string getFullName() const override
get the full name of this specific type
Definition: String.cpp:59
armarx::aron::type
A convenience header to include all aron files (full include, not forward declared)
Definition: aron_conversions.cpp:9
armarx::aron::type::String::getShortName
virtual std::string getShortName() const override
get a short name of this specific type
Definition: String.cpp:53
armarx::armem::server::ltm::detail::mixin::Path
std::filesystem::path Path
Definition: DiskStorageMixin.h:17
armarx::aron::type::String
The String class.
Definition: String.h:37