wordIOList.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-2013 OpenFOAM Foundation
9  Copyright (C) 2019 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Typedef
28  Foam::wordIOList
29 
30 Description
31  IO of a list of words
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef wordIOList_H
36 #define wordIOList_H
37 
38 #include "wordList.H"
39 #include "IOList.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
47 
48  //- Print a List of wordList as a table
50  (
51  const UList<wordList>& tbl,
52  List<std::string::size_type>& columnWidths,
53  Ostream& os,
54  bool headerSeparator = true
55  );
56 
57  //- Print a List of wordList as a table
59  (
60  const UList<wordList>& tbl,
61  Ostream& os,
62  bool headerSeparator = true
63  );
64 }
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 #endif
69 
70 // ************************************************************************* //
Foam::wordListIOList
IOList< wordList > wordListIOList
Definition: wordIOList.H:46
wordList.H
IOList.H
Foam::wordIOList
IOList< word > wordIOList
IO of a list of words.
Definition: wordIOList.H:45
Foam::printTable
Ostream & printTable(const UList< wordList > &tbl, List< std::string::size_type > &columnWidths, Ostream &os, bool headerSeparator=true)
Print a List of wordList as a table.
Definition: wordIOList.C:47
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: BitOps.H:63
Foam::UList
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition: HashTable.H:103
Foam::IOList
A List of objects of type <T> with automated input and output.
Definition: IOList.H:53
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56