NamedEnumI.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) 2017 OpenCFD Ltd.
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 \*---------------------------------------------------------------------------*/
27 
28 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29 
30 template<class EnumType, int nEnum>
31 inline Foam::label Foam::NamedEnum<EnumType, nEnum>::size() const
32 {
33  return lookup_.size();
34 }
35 
36 
37 template<class EnumType, int nEnum>
38 inline Foam::wordList Foam::NamedEnum<EnumType, nEnum>::toc() const
39 {
40  return lookup_.toc();
41 }
42 
43 
44 template<class EnumType, int nEnum>
45 inline Foam::wordList Foam::NamedEnum<EnumType, nEnum>::sortedToc() const
46 {
47  return lookup_.sortedToc();
48 }
49 
50 
51 template<class EnumType, int nEnum>
52 inline bool Foam::NamedEnum<EnumType, nEnum>::found
53 (
54  const word& enumName
55 ) const
56 {
57  return lookup_.found(enumName);
58 }
59 
60 
61 template<class EnumType, int nEnum>
62 inline bool Foam::NamedEnum<EnumType, nEnum>::hasEnum
63 (
64  const word& enumName
65 ) const
66 {
67  return lookup_.found(enumName);
68 }
69 
70 
71 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
72 
73 template<class EnumType, int nEnum>
74 inline const EnumType Foam::NamedEnum<EnumType, nEnum>::operator[]
75 (
76  const word& name
77 ) const
78 {
79  return EnumType(lookup_[name]);
80 }
81 
82 
83 template<class EnumType, int nEnum>
84 inline const char* Foam::NamedEnum<EnumType, nEnum>::operator[]
85 (
86  const EnumType e
87 ) const
88 {
89  return names[int(e)];
90 }
91 
92 
93 // ************************************************************************* //
found
bool found
Definition: TABSMDCalcMethod2.H:32
Foam::List< word >
Foam::constant::electromagnetic::e
const dimensionedScalar e
Elementary charge.
Definition: createFields.H:11
Foam::name
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
Foam::PtrListOps::names
List< word > names(const UPtrList< T > &list, const UnaryMatchPredicate &matcher)
Foam::NamedEnum
A NamedEnum is a wrapper around a list of names that represent particular enumeration values.
Definition: NamedEnum.H:58