localIOdictionary.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) 2015-2017 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::localIOdictionary
28 
29 Description
30  localIOdictionary is derived from IOdictionary but excludes parallel
31  master reading.
32 
33 SourceFiles
34  localIOdictionary.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef localIOdictionary_H
39 #define localIOdictionary_H
40 
41 #include "baseIOdictionary.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class localIOdictionary Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public baseIOdictionary
55 {
56 
57 public:
58 
59  // Constructors
60 
61  //- Construct given an IOobject
62  localIOdictionary(const IOobject& io);
63 
64  //- Construct given an IOobject and dictionary
65  localIOdictionary(const IOobject& io, const dictionary& dict);
66 
67  //- Construct given an IOobject and Istream
68  localIOdictionary(const IOobject& io, Istream& is);
69 
70  //- Construct given an IOobject, supply wanted typeName
71  localIOdictionary(const IOobject& io, const word& wantedType);
72 
73 
74  //- Destructor
75  virtual ~localIOdictionary();
76 
77 
78  // Member functions
79 
80  //- Is object global
81  virtual bool global() const
82  {
83  return false;
84  }
85 
86  //- Return complete path + object name if the file exists
87  // in the case otherwise null
88  virtual fileName filePath() const
89  {
90  // Use default (local only) search strategy
91  return localFilePath(type());
92  }
93 
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************************************************************* //
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:104
Foam::IOobject::localFilePath
fileName localFilePath(const word &typeName, const bool search=true) const
Helper for filePath that searches locally.
Definition: IOobject.C:502
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
baseIOdictionary.H
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:61
Foam::baseIOdictionary
baseIOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO function...
Definition: baseIOdictionary.H:57
Foam::localIOdictionary::localIOdictionary
localIOdictionary(const IOobject &io)
Construct given an IOobject.
Definition: localIOdictionary.C:32
dict
dictionary dict
Definition: searchingEngine.H:14
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
Foam::localIOdictionary::filePath
virtual fileName filePath() const
Return complete path + object name if the file exists.
Definition: localIOdictionary.H:87
Foam::localIOdictionary::global
virtual bool global() const
Is object global.
Definition: localIOdictionary.H:80
Foam::type
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:590
Foam::localIOdictionary::~localIOdictionary
virtual ~localIOdictionary()
Destructor.
Definition: localIOdictionary.C:98
Foam::localIOdictionary
localIOdictionary is derived from IOdictionary but excludes parallel master reading.
Definition: localIOdictionary.H:51