MetaClass.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 <vector>
28 #include "MetaWriter.h"
29 
30 namespace armarx
31 {
32  class MetaClass;
33  using MetaClassPtr = std::shared_ptr<MetaClass>;
34 
35  class MetaClass
36  {
37  public:
38  MetaClass(const std::string& name);
39 
40  virtual void write(const MetaWriterPtr& writer) = 0;
41  static void Write(const std::vector<MetaClassPtr>& classes, const MetaWriterPtr& writer);
42 
43  void addClassDoc(const std::string& doc);
44 
45  std::string getName() const;
46 
47  protected:
48  std::string name;
49  std::string docString;
50  };
51 }
armarx::MetaClass::getName
std::string getName() const
Definition: MetaClass.cpp:50
armarx::MetaClass::docString
std::string docString
Definition: MetaClass.h:49
armarx::MetaClassPtr
std::shared_ptr< MetaClass > MetaClassPtr
Definition: MetaClass.h:33
armarx::MetaClass::Write
static void Write(const std::vector< MetaClassPtr > &classes, const MetaWriterPtr &writer)
Definition: MetaClass.cpp:37
armarx::MetaClass::MetaClass
MetaClass(const std::string &name)
Definition: MetaClass.cpp:32
armarx::MetaClass::name
std::string name
Definition: MetaClass.h:48
armarx::MetaClass
Definition: MetaClass.h:35
armarx::MetaClass::write
virtual void write(const MetaWriterPtr &writer)=0
armarx::MetaWriterPtr
std::shared_ptr< MetaWriter > MetaWriterPtr
Definition: MetaWriter.h:37
MetaWriter.h
armarx::MetaClass::addClassDoc
void addClassDoc(const std::string &doc)
Definition: MetaClass.cpp:45
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:28