src/OpenFOAM/containers/NamedEnum/NamedEnum.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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 "NamedEnum.H"
  27
  28 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  29
  30 template<class Enum, int nEnum>
  31 Foam::NamedEnum<Enum, nEnum>::NamedEnum()
  32 :
  33     HashTable<int>(2*nEnum)
  34 {
  35     for (int enumI = 0; enumI < nEnum; ++enumI)
  36     {
  37         if (!names[enumI] || names[enumI][0] == '\0')
  38         {
  39             stringList goodNames(enumI);
  40
  41             for (int i = 0; i < enumI; ++i)
  42             {
  43                 goodNames[i] = names[i];
  44             }
  45
  46             FatalErrorIn("NamedEnum<Enum, nEnum>::NamedEnum()")
  47                 << "Illegal enumeration name at position " << enumI << endl
  48                 << "after entries " << goodNames << ".\n"
  49                 << "Possibly your NamedEnum<Enum, nEnum>::names array"
  50                 << " is not of size " << nEnum << endl
  51                 << abort(FatalError);
  52         }
  53         insert(names[enumI], enumI);
  54     }
  55 }
  56
  57
  58 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  59
  60 template<class Enum, int nEnum>
  61 Enum Foam::NamedEnum<Enum, nEnum>::read(Istream& is) const
  62 {
  63     const word name(is);
  64
  65     HashTable<int>::const_iterator iter = find(name);
  66
  67     if (iter == HashTable<int>::end())
  68     {
  69         FatalIOErrorIn
  70         (
  71             "NamedEnum<Enum, nEnum>::read(Istream&) const", is
  72         )   << name << " is not in enumeration: "
  73             << sortedToc() << exit(FatalIOError);
  74     }
  75
  76     return Enum(iter());
  77 }
  78
  79
  80 template<class Enum, int nEnum>
  81 void Foam::NamedEnum<Enum, nEnum>::write(const Enum e, Ostream& os) const
  82 {
  83     os  << operator[](e);
  84 }
  85
  86
  87 template<class Enum, int nEnum>
  88 Foam::stringList Foam::NamedEnum<Enum, nEnum>::strings()
  89 {
  90     stringList lst(nEnum);
  91
  92     label nElem = 0;
  93     for (int enumI = 0; enumI < nEnum; ++enumI)
  94     {
  95         if (names[enumI] && names[enumI][0])
  96         {
  97             lst[nElem++] = names[enumI];
  98         }
  99     }
 100
 101     lst.setSize(nElem);
 102     return lst;
 103 }
 104
 105
 106 template<class Enum, int nEnum>
 107 Foam::wordList Foam::NamedEnum<Enum, nEnum>::words()
 108 {
 109     wordList lst(nEnum);
 110
 111     label nElem = 0;
 112     for (int enumI = 0; enumI < nEnum; ++enumI)
 113     {
 114         if (names[enumI] && names[enumI][0])
 115         {
 116             lst[nElem++] = names[enumI];
 117         }
 118     }
 119
 120     lst.setSize(nElem);
 121     return lst;
 122 }
 123
 124
 125 // ************************************************************************* //