CppClass.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 "CppCtor.h"
27 #include "CppEnum.h"
28 #include "CppField.h"
29 #include "CppMethod.h"
30 #include "MetaClass.h"
31 
32 namespace armarx
33 {
34  class CppClass;
35  using CppClassPtr = std::shared_ptr<CppClass>;
36 
37  class CppClass : virtual public MetaClass
38  {
39  public:
40  CppClass(const std::vector<std::string>& namespaces,
41  const std::string& name,
42  const std::string& templates = "");
43 
44  virtual void write(const MetaWriterPtr& writer) override;
45  void writeCpp(const CppWriterPtr& writer);
46  static void WriteCpp(const std::vector<CppClassPtr>& classes, const CppWriterPtr& writer);
47 
48  void addPublicMethod(const CppMethodPtr method);
49  CppMethodPtr addPublicMethod(const std::string& header,
50  const std::string& doc = "",
51  const bool enforceBlockGeneration = false);
52 
53  void addCtor(const CppCtorPtr&);
54  CppCtorPtr addCtor(const std::string& arguments);
55  CppCtorPtr addCtor(const std::string& arguments, const CppBlockPtr& b);
56 
57  void addPublicField(const CppFieldPtr& field);
58  void addPrivateField(const CppFieldPtr& field);
59  void addProtectedField(const CppFieldPtr& field);
60 
61  void addInnerClass(const CppClassPtr inner);
62  CppClassPtr addInnerClass(const std::string& name);
63 
64  void addInnerEnum(const CppEnumPtr inner);
65  CppEnumPtr addInnerEnum(const std::string& name);
66 
67  void addInherit(const std::string& inherit);
68 
69  void addInclude(const std::string include);
70  bool hasInclude(const std::string include);
71 
72  void setTemplates(const std::string&);
73 
74 
75  private:
76  std::vector<std::string> namespaces;
77  std::string templates;
78  std::vector<CppMethodPtr> publicMethods;
79  std::vector<CppFieldPtr> privateFields;
80  std::vector<CppFieldPtr> protectedFields;
81  std::vector<CppFieldPtr> publicFields;
82  std::vector<std::string> inherit;
83  std::vector<CppEnumPtr> innerEnums;
84  std::vector<CppClassPtr> innerClasses;
85  std::vector<CppCtorPtr> ctors;
86  std::vector<std::string> includes;
87  };
88 } // namespace armarx
armarx::CppClass::writeCpp
void writeCpp(const CppWriterPtr &writer)
Definition: CppClass.cpp:63
CppMethod.h
armarx::CppCtorPtr
std::shared_ptr< CppCtor > CppCtorPtr
Definition: CppCtor.h:31
armarx::CppClass::write
virtual void write(const MetaWriterPtr &writer) override
Definition: CppClass.cpp:47
MetaClass.h
armarx::CppClassPtr
std::shared_ptr< CppClass > CppClassPtr
Definition: CppClass.h:35
CppCtor.h
armarx::CppBlockPtr
std::shared_ptr< CppBlock > CppBlockPtr
Definition: CppBlock.h:37
armarx::CppClass::addPublicMethod
void addPublicMethod(const CppMethodPtr method)
Definition: CppClass.cpp:206
armarx::CppClass::addInherit
void addInherit(const std::string &inherit)
Definition: CppClass.cpp:296
armarx::CppFieldPtr
std::shared_ptr< CppField > CppFieldPtr
Definition: CppField.h:33
armarx::CppEnumPtr
std::shared_ptr< CppEnum > CppEnumPtr
Definition: CppEnum.h:54
armarx::MetaClass::name
std::string name
Definition: MetaClass.h:49
armarx::CppClass::CppClass
CppClass(const std::vector< std::string > &namespaces, const std::string &name, const std::string &templates="")
Definition: CppClass.cpp:37
CppEnum.h
armarx::CppClass::hasInclude
bool hasInclude(const std::string include)
Definition: CppClass.cpp:308
armarx::CppClass::addInnerClass
void addInnerClass(const CppClassPtr inner)
Definition: CppClass.cpp:274
CppField.h
armarx::CppClass
Definition: CppClass.h:37
armarx::CppMethodPtr
std::shared_ptr< CppMethod > CppMethodPtr
Definition: CppMethod.h:31
armarx::CppClass::setTemplates
void setTemplates(const std::string &)
Definition: CppClass.cpp:314
armarx::MetaClass
Definition: MetaClass.h:36
armarx::CppClass::WriteCpp
static void WriteCpp(const std::vector< CppClassPtr > &classes, const CppWriterPtr &writer)
Definition: CppClass.cpp:54
armarx::MetaWriterPtr
std::shared_ptr< MetaWriter > MetaWriterPtr
Definition: MetaWriter.h:37
armarx::CppClass::addPublicField
void addPublicField(const CppFieldPtr &field)
Definition: CppClass.cpp:259
armarx::CppClass::addPrivateField
void addPrivateField(const CppFieldPtr &field)
Definition: CppClass.cpp:245
armarx::CppClass::addInclude
void addInclude(const std::string include)
Definition: CppClass.cpp:302
armarx::CppWriterPtr
std::shared_ptr< CppWriter > CppWriterPtr
Definition: CppWriter.h:35
armarx::CppClass::addInnerEnum
void addInnerEnum(const CppEnumPtr inner)
Definition: CppClass.cpp:280
armarx::CppClass::addCtor
void addCtor(const CppCtorPtr &)
Definition: CppClass.cpp:223
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:27
armarx::CppClass::addProtectedField
void addProtectedField(const CppFieldPtr &field)
Definition: CppClass.cpp:252