zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

STYLE: note deprecated status for NamedEnum

Browse Source
This commit is contained in:
Mark Olesen
2018-01-09 16:06:40 +01:00
parent 243eda1f7a
commit ab38c04006
2 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Doxygen/footer.html
View File

@ -15,7 +15,7 @@
<address class="footer">
<small>
<p>
Copyright&nbsp;&copy;&nbsp;2011-2016&nbsp;
Copyright&nbsp;&copy;&nbsp;2011-2018&nbsp;
<a href="http://www.openfoam.com">OpenFOAM</a>
|
OPENFOAM&reg; is a registered

15
src/OpenFOAM/primitives/enums/NamedEnum.H
View File

@ -28,6 +28,13 @@ Description
A NamedEnum is a wrapper around a list of names that represent
particular enumeration values.
\deprecated This class is retained for compatibility only and should
not normally be used for any new code.
The Foam::Enum class is robuster, more flexible, easier to use.
See Also
Foam::Enum
SourceFiles
NamedEnum.C
@ -97,7 +104,7 @@ public:
// Member Functions
// Access
// Access
//- The number of lookup names for the enumeration
inline label size() const;
@ -115,7 +122,7 @@ public:
List<int> values() const;
// Query
// Query
//- Test if there is an enumeration corresponding to the given name.
inline bool found(const word& enumName) const;
@ -127,7 +134,7 @@ public:
bool hasName(const EnumType e) const;
// Lookup
// Lookup
//- Lookup the key in the dictionary and return the corresponding
// enumeration element based on its name.
@ -150,7 +157,7 @@ public:
) const;
// IO
// IO
//- Read a word from Istream and return the corresponding enumeration
EnumType read(Istream& is) const;