src/OpenFOAM/containers/NamedEnum/NamedEnum.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::NamedEnum
  27
  28 Description
  29     Initialise the NamedEnum HashTable from the static list of names.
  30
  31 SourceFiles
  32     NamedEnum.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef NamedEnum_H
  37 #define NamedEnum_H
  38
  39 #include "HashTable.H"
  40 #include "StaticAssert.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                           Class NamedEnum Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class Enum, int nEnum>
  52 class NamedEnum
  53 :
  54     public HashTable<int>
  55 {
  56 #ifndef SWIG
  57     //- nEnum must be positive (non-zero)
  58     StaticAssert(nEnum > 0);
  59 #endif
  60
  61
  62     // Private Member Functions
  63
  64         //- Disallow default bitwise copy construct
  65         NamedEnum(const NamedEnum&);
  66
  67         //- Disallow default bitwise assignment
  68         void operator=(const NamedEnum&);
  69
  70
  71 public:
  72
  73     // Static data members
  74
  75         //- The set of names corresponding to the enumeration Enum
  76         static const char* names[nEnum];
  77
  78
  79     // Constructors
  80
  81         //- Construct from names
  82         NamedEnum();
  83
  84
  85     // Member Functions
  86
  87         //- Read a word from Istream and return the corresponding
  88         //  enumeration element
  89         Enum read(Istream&) const;
  90
  91         //- Write the name representation of the enumeration to an Ostream
  92         void write(const Enum e, Ostream&) const;
  93
  94
  95     // Member Operators
  96
  97         //- Return the enumeration element corresponding to the given name
  98         const Enum operator[](const char* name) const
  99         {
 100             return Enum(HashTable<int>::operator[](name));
 101         }
 102
 103         //- Return the enumeration element corresponding to the given name
 104         const Enum operator[](const word& name) const
 105         {
 106             return Enum(HashTable<int>::operator[](name));
 107         }
 108
 109         //- Return the name of the given enumeration element
 110         const char* operator[](const Enum e) const
 111         {
 112             return names[e];
 113         }
 114 };
 115
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 } // End namespace Foam
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 #ifdef NoRepository
 124 #   include "NamedEnum.C"
 125 #endif
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 #endif
 130
 131 // ************************************************************************* //