Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
OpenFOAM
db
IOobjectList
IOobjectList.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 | Copyright (C) 1991-2010 OpenCFD Ltd.
6
\\/ M anipulation |
7
-------------------------------------------------------------------------------
8
License
9
This file is part of OpenFOAM.
10
11
OpenFOAM is free software: you can redistribute it and/or modify it
12
under the terms of the GNU General Public License as published by
13
the Free Software Foundation, either version 3 of the License, or
14
(at your option) any later version.
15
16
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19
for more details.
20
21
You should have received a copy of the GNU General Public License
22
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23
24
Class
25
Foam::IOobjectList
26
27
Description
28
List of IOobjects with searching and retrieving facilities.
29
30
SourceFiles
31
IOobjectList.C
32
33
\*---------------------------------------------------------------------------*/
34
35
#ifndef IOobjectList_H
36
#define IOobjectList_H
37
38
#include <
OpenFOAM/HashPtrTable.H
>
39
#include <
OpenFOAM/IOobject.H
>
40
41
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43
namespace
Foam
44
{
45
46
/*---------------------------------------------------------------------------*\
47
Class IOobjectList Declaration
48
\*---------------------------------------------------------------------------*/
49
50
class
IOobjectList
51
:
52
public
HashPtrTable
<IOobject>
53
{
54
// Private Member Functions
55
56
//- Disallow default bitwise assignment
57
void
operator=(
const
IOobjectList
&);
58
59
60
public
:
61
62
// Constructors
63
64
//- Construct given an initial estimate for the number of entries
65
explicit
IOobjectList
(
const
label nIoObjects = 128);
66
67
//- Construct from objectRegistry and instance path
68
IOobjectList
69
(
70
const
objectRegistry
& db,
71
const
fileName
& instance,
72
const
fileName
& local =
""
73
);
74
75
//- Construct as copy
76
IOobjectList
(
const
IOobjectList
&);
77
78
79
// Destructor
80
81
~IOobjectList
();
82
83
84
// Member functions
85
86
//- Add an IOobject to list
87
bool
add
(
IOobject
&);
88
89
//- Remove an IOobject from list
90
bool
remove
(
IOobject
&);
91
92
//- Lookup a given name and return IOobject ptr if found else NULL
93
IOobject
*
lookup
(
const
word
&
name
)
const
;
94
95
//- Return the list for all IOobjects of given class
96
IOobjectList
lookupClass
(
const
word
& className)
const
;
97
98
//- Return the list of names of the IOobjects
99
wordList
names
()
const
;
100
101
//- Return the list of names of the IOobjects of given class
102
wordList
names
(
const
word
& className)
const
;
103
};
104
105
106
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107
108
}
// End namespace Foam
109
110
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111
112
#endif
113
114
// ************************ vim: set sw=4 sts=4 et: ************************ //