OpenFOAM: API Guide
v2012
The open source CFD toolbox
doxygenXmlParser.H
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------*\
2
========= |
3
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4
\\ / O peration |
5
\\ / A nd | www.openfoam.com
6
\\/ M anipulation |
7
-------------------------------------------------------------------------------
8
Copyright (C) 2012-2014 OpenFOAM Foundation
9
-------------------------------------------------------------------------------
10
License
11
This file is part of OpenFOAM.
12
13
OpenFOAM is free software: you can redistribute it and/or modify it
14
under the terms of the GNU General Public License as published by
15
the Free Software Foundation, either version 3 of the License, or
16
(at your option) any later version.
17
18
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21
for more details.
22
23
You should have received a copy of the GNU General Public License
24
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26
Class
27
Foam::doxygenXmlParser
28
29
Description
30
Parser for doxygen XML
31
32
SourceFiles
33
doxygenXmlParser.C
34
35
\*---------------------------------------------------------------------------*/
36
37
#ifndef doxygenXmlParser_H
38
#define doxygenXmlParser_H
39
40
#include "
dictionary.H
"
41
#include "
IFstream.H
"
42
43
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45
namespace
Foam
46
{
47
48
/*---------------------------------------------------------------------------*\
49
Class doxygenXmlParser Declaration
50
\*---------------------------------------------------------------------------*/
51
52
class
doxygenXmlParser
53
:
54
public
dictionary
55
{
56
57
public
:
58
59
//- Construct from components
60
doxygenXmlParser
61
(
62
const
fileName
& fName,
63
const
string
& startTag,
64
const
string
& searchStr,
65
const
bool
exactMatch,
66
const
word
& ext
67
);
68
69
70
// Member functions
71
72
//- Skip past a block
73
void
skipBlock
(
IFstream
& is,
const
word
& blockName)
const
;
74
75
//- Skip forward to block
76
void
skipForward
(
IFstream
& is,
const
word
& blockName)
const
;
77
78
//- Return the entry
79
template
<
class
Type>
80
void
getEntry
(
IFstream
& is, Type&
entry
)
const
;
81
82
//- Return the entry value
83
template
<
class
Type>
84
void
getValue
(
IFstream
& is, Type&
entry
)
const
;
85
};
86
87
88
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89
90
}
// End namespace Foam
91
92
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93
94
#ifdef NoRepository
95
#include "
doxygenXmlParserTemplates.C
"
96
#endif
97
98
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99
100
#endif
101
102
// ************************************************************************* //
Foam::entry
A keyword and a list of tokens is an 'entry'.
Definition:
entry.H:67
Foam::doxygenXmlParser::skipForward
void skipForward(IFstream &is, const word &blockName) const
Skip forward to block.
Foam::word
A class for handling words, derived from Foam::string.
Definition:
word.H:62
Foam::fileName
A class for handling file names.
Definition:
fileName.H:69
Foam::doxygenXmlParser
Parser for doxygen XML.
Definition:
doxygenXmlParser.H:51
Foam::IFstream
Input from file stream, using an ISstream.
Definition:
IFstream.H:53
Foam::doxygenXmlParser::skipBlock
void skipBlock(IFstream &is, const word &blockName) const
Skip past a block.
Foam::doxygenXmlParser::getValue
void getValue(IFstream &is, Type &entry) const
Return the entry value.
Foam::doxygenXmlParser::getEntry
void getEntry(IFstream &is, Type &entry) const
Return the entry.
doxygenXmlParserTemplates.C
IFstream.H
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition:
dictionary.H:121
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
dictionary.H
Foam::doxygenXmlParser::doxygenXmlParser
doxygenXmlParser(const fileName &fName, const string &startTag, const string &searchStr, const bool exactMatch, const word &ext)
Construct from components.
applications
utilities
miscellaneous
foamHelp
helpTypes
doxygenXmlParser
doxygenXmlParser.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.