Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / foam / containers / NamedEnum / NamedEnum.C
blobc08e16b4e1620d7c33ed4dfc04e30af507ebcb5b
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend 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 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 \*---------------------------------------------------------------------------*/
26 #include "NamedEnum.H"
27 #include "stringList.H"
29 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
31 template<class Enum, int nEnum>
32 Foam::NamedEnum<Enum, nEnum>::NamedEnum()
34     HashTable<int>(2*nEnum)
36     for (int i=0; i<nEnum; i++)
37     {
38         if (!names[i] || names[i][0] == '\0')
39         {
40             stringList goodNames(i);
42             for (label j = 0; j < i; j++)
43             {
44                 goodNames[j] = names[j];
45             }
47             FatalErrorIn("NamedEnum<Enum, nEnum>::NamedEnum()")
48                 << "Illegal enumeration name at position " << i << endl
49                 << "after entries " << goodNames << ".\n"
50                 << "Possibly your NamedEnum<Enum, nEnum>::names array"
51                 << " is not of size " << nEnum << endl
52                 << abort(FatalError);
53         }
54         insert(names[i], i);
55     }
59 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
61 template<class Enum, int nEnum>
62 Enum Foam::NamedEnum<Enum, nEnum>::read(Istream& is) const
64     word name(is);
66     HashTable<int>::const_iterator iter = find(name);
68     if (iter == HashTable<int>::end())
69     {
70         FatalIOErrorIn
71         (
72             "NamedEnum<Enum, nEnum>::read(Istream& is) const",
73             is
74         )   << name << " is not in enumeration " << toc()
75             << exit(FatalIOError);
76     }
78     return Enum(iter());
82 template<class Enum, int nEnum>
83 void Foam::NamedEnum<Enum, nEnum>::write(const Enum e, Ostream& os) const
85     os << operator[](e);
89 // * * * * * * * * * * * * * * * Ostream Operator  * * * * * * * * * * * * * //
91 template<class Enum, int nEnum>
92 Foam::Ostream& Foam::operator<<
94     Ostream& os,
95     const NamedEnum<Enum, nEnum>& n
98     for (int e = 0; e < nEnum; e++)
99     {
100         os << e << " " << n.names[e] << nl;
101     }
103     return os;
107 // ************************************************************************* //