www.mooseframework.org
InputFileFormatter.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef INPUTFILEFORMATTER_H
16 #define INPUTFILEFORMATTER_H
17 
18 #include "SyntaxTree.h"
19 
25 {
26 public:
27  InputFileFormatter(bool dump_mode);
28 
29  virtual std::string
30  printBlockOpen(const std::string & name, short depth, const std::string & /*doc*/) override;
31  virtual std::string printBlockClose(const std::string & name, short depth) const override;
32  virtual std::string printParams(const std::string & prefix,
33  const std::string & fully_qualified_name,
34  InputParameters & params,
35  short depth,
36  const std::string & search_string,
37  bool & found) override;
38 
39 protected:
40  bool _dump_mode;
41 };
42 
43 #endif /* INPUTFILEFORMATTER_H */
InputFileFormatter(bool dump_mode)
virtual std::string printBlockOpen(const std::string &name, short depth, const std::string &) override
This method is called at the beginning of each Node in the tree.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
virtual std::string printBlockClose(const std::string &name, short depth) const override
This method is called at the end of of each Node in the tree.
virtual std::string printParams(const std::string &prefix, const std::string &fully_qualified_name, InputParameters &params, short depth, const std::string &search_string, bool &found) override
This function is called for each InputParameters object stored at a particular node.
This class produces produces a dump of the InputFileParameters that appears like the normal input fil...