CppMethod.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 "CppBlock.h"
27 
28 namespace armarx
29 {
30  class CppMethod;
31  using CppMethodPtr = std::shared_ptr<CppMethod>;
32 
33  class CppMethod
34  {
35  public:
36  CppMethod(const std::string& header,
37  const std::string& doc = "",
38  const bool enforceBlockGeneration = false);
39 
40  void writeCpp(const CppWriterPtr& writer);
41  void addLine(const std::string& line);
42  void addLine(const boost::basic_format<char>& line);
43  void addBlock(const CppBlockPtr& block);
44  void setBlock(const CppBlockPtr& block);
45  void setCompact(bool compact);
46  void setEnforceBlockGeneration(bool enforceBlockGeneration);
47 
48  private:
49  std::string header, doc;
50  CppBlockPtr block;
51  bool compact = false;
52 
53  bool enforceBlockGeneration = false;
54  };
55 
56 } // namespace armarx
armarx::CppMethod::writeCpp
void writeCpp(const CppWriterPtr &writer)
Definition: CppMethod.cpp:45
armarx::CppMethod::addBlock
void addBlock(const CppBlockPtr &block)
Definition: CppMethod.cpp:114
CppBlock.h
armarx::CppBlockPtr
std::shared_ptr< CppBlock > CppBlockPtr
Definition: CppBlock.h:37
armarx::CppMethod::setCompact
void setCompact(bool compact)
Definition: CppMethod.cpp:130
armarx::CppMethod::setBlock
void setBlock(const CppBlockPtr &block)
Definition: CppMethod.cpp:124
armarx::CppMethodPtr
std::shared_ptr< CppMethod > CppMethodPtr
Definition: CppMethod.h:31
armarx::CppMethod::CppMethod
CppMethod(const std::string &header, const std::string &doc="", const bool enforceBlockGeneration=false)
Definition: CppMethod.cpp:35
armarx::CppMethod::addLine
void addLine(const std::string &line)
Definition: CppMethod.cpp:94
armarx::CppWriterPtr
std::shared_ptr< CppWriter > CppWriterPtr
Definition: CppWriter.h:35
armarx::CppMethod
Definition: CppMethod.h:33
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:27
armarx::CppMethod::setEnforceBlockGeneration
void setEnforceBlockGeneration(bool enforceBlockGeneration)
Definition: CppMethod.cpp:136