00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::NamedEnum 00026 00027 Description 00028 Initialise the NamedEnum HashTable from the static list of names. 00029 00030 SourceFiles 00031 NamedEnum.C 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef NamedEnum_H 00036 #define NamedEnum_H 00037 00038 #include <OpenFOAM/HashTable.H> 00039 #include <OpenFOAM/StaticAssert.H> 00040 00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00042 00043 namespace Foam 00044 { 00045 00046 /*---------------------------------------------------------------------------*\ 00047 Class NamedEnum Declaration 00048 \*---------------------------------------------------------------------------*/ 00049 00050 template<class Enum, int nEnum> 00051 class NamedEnum 00052 : 00053 public HashTable<int> 00054 { 00055 //- nEnum must be positive (non-zero) 00056 StaticAssert(nEnum > 0); 00057 00058 // Private Member Functions 00059 00060 //- Disallow default bitwise copy construct 00061 NamedEnum(const NamedEnum&); 00062 00063 //- Disallow default bitwise assignment 00064 void operator=(const NamedEnum&); 00065 00066 00067 public: 00068 00069 // Static data members 00070 00071 //- The set of names corresponding to the enumeration Enum 00072 static const char* names[nEnum]; 00073 00074 00075 // Constructors 00076 00077 //- Construct from names 00078 NamedEnum(); 00079 00080 00081 // Member Functions 00082 00083 //- Read a word from Istream and return the corresponding 00084 // enumeration element 00085 Enum read(Istream&) const; 00086 00087 //- Write the name representation of the enumeration to an Ostream 00088 void write(const Enum e, Ostream&) const; 00089 00090 00091 // Member Operators 00092 00093 //- Return the enumeration element corresponding to the given name 00094 const Enum operator[](const char* name) const 00095 { 00096 return Enum(HashTable<int>::operator[](name)); 00097 } 00098 00099 //- Return the enumeration element corresponding to the given name 00100 const Enum operator[](const word& name) const 00101 { 00102 return Enum(HashTable<int>::operator[](name)); 00103 } 00104 00105 //- Return the name of the given enumeration element 00106 const char* operator[](const Enum e) const 00107 { 00108 return names[e]; 00109 } 00110 }; 00111 00112 00113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00114 00115 } // End namespace Foam 00116 00117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00118 00119 #ifdef NoRepository 00120 # include "NamedEnum.C" 00121 #endif 00122 00123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00124 00125 #endif 00126 00127 // ************************ vim: set sw=4 sts=4 et: ************************ //
