dictionaryEntry.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2025 OpenFOAM Foundation
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 \*---------------------------------------------------------------------------*/
25 
26 #include "dictionaryEntry.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
31 (
32  const keyType& key,
33  const dictionary& parentDict,
34  const dictionary& dict
35 )
36 :
37  entry
38  (
39  key,
40  &dict != &dictionary::null
41  ? dict.endLineNumber()
42  : -1
43  ),
44  dictionary(parentDict, dict)
45 {}
46 
47 
49 (
50  const dictionary& parentDict,
51  const dictionaryEntry& dictEnt
52 )
53 :
54  entry(dictEnt),
55  dictionary(parentDict, dictEnt)
56 {}
57 
58 
59 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
60 
62 {
63  return entry::startLineNumber();
64 }
65 
66 
68 {
69  if (size())
70  {
71  return last()->endLineNumber();
72  }
73  else
74  {
75  return startLineNumber();
76  }
77 }
78 
79 
81 {
83  << "Attempt to return dictionary entry as a primitive"
84  << abort(FatalIOError);
85 
86  return lookup("");
87 }
88 
89 
91 {
92  return *this;
93 }
94 
95 
97 {
98  return *this;
99 }
100 
101 
102 // ************************************************************************* //
Input token stream.
Definition: ITstream.H:53
A keyword and a list of tokens is a 'dictionaryEntry'.
dictionaryEntry(const dictionary &parentDict, Istream &)
Construct from the parent dictionary and Istream.
virtual label endLineNumber() const
Return line number of last token in the dictionary.
ITstream & stream() const
This entry is not a primitive,.
const dictionary & dict() const
Return dictionary.
virtual label startLineNumber() const
Return line number of the keyword of the entry.
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
A keyword and a list of tokens is an 'entry'.
Definition: entry.H:68
virtual label startLineNumber() const
Return line number of keyword of the entry.
Definition: entry.H:154
A class for handling keywords in dictionaries.
Definition: keyType.H:69
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:346
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
errorManip< error > abort(error &err)
Definition: errorManip.H:131
IOerror FatalIOError
dictionary dict