CppField.h
Go to the documentation of this file.
1 /*
2  * This file is part of ArmarX.
3  *
4  * Copyright (C) 2011-2016, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
5  *
6  * ArmarX is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  *
10  * ArmarX is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  *
18  * @package
19  * @author
20  * @date
21  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
22  * GNU General Public License
23  */
24 #pragma once
25 
26 #include <memory>
27 #include "CppWriter.h"
28 
29 
30 
31 namespace armarx
32 {
33  class CppField;
34  using CppFieldPtr = std::shared_ptr<CppField>;
35 
36  class CppField
37  {
38  public:
39  CppField(const std::string& type, const std::string& name, const std::string& default_value = "", const std::string& doc = "");
40  std::string getName() const;
41  std::string getType() const;
42  void setDoc(const std::string& documentation);
43  void writeCpp(const CppWriterPtr& writer);
44 
45 
46 
47  private:
48  std::string type;
49  std::string name;
50  std::string default_value = "";
51  std::string doc = "";
52  };
53 }
armarx::CppField::setDoc
void setDoc(const std::string &documentation)
Definition: CppField.cpp:54
CppWriter.h
armarx::CppField::CppField
CppField(const std::string &type, const std::string &name, const std::string &default_value="", const std::string &doc="")
Definition: CppField.cpp:32
armarx::CppFieldPtr
std::shared_ptr< CppField > CppFieldPtr
Definition: CppField.h:34
armarx::CppField::getType
std::string getType() const
Definition: CppField.cpp:49
armarx::CppField::getName
std::string getName() const
Definition: CppField.cpp:44
armarx::CppField
Definition: CppField.h:36
armarx::CppWriterPtr
std::shared_ptr< CppWriter > CppWriterPtr
Definition: CppWriter.h:35
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:28
armarx::CppField::writeCpp
void writeCpp(const CppWriterPtr &writer)
Definition: CppField.cpp:59