NamedEnum.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::NamedEnum
 
Description
    Initialise the NamedEnum HashTable from the static list of names.
 
SourceFiles
    NamedEnum.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef NamedEnum_H
#define NamedEnum_H
 
#include "HashTable.H"
#include "StaticAssert.H"
#include "stringList.H"
#include "wordList.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                          Class NamedEnum Declaration
\*---------------------------------------------------------------------------*/
 
template<class Enum, int nEnum>
class NamedEnum
:
    public HashTable<int>
{
    //- nEnum must be positive (non-zero)
    StaticAssert(nEnum > 0);
 
    // Private Member Functions
 
        //- Disallow default bitwise copy construct
        NamedEnum(const NamedEnum&);
 
        //- Disallow default bitwise assignment
        void operator=(const NamedEnum&);
 
 
public:
 
    // Static data members
 
        //- The set of names corresponding to the enumeration Enum
        static const char* names[nEnum];
 
 
    // Constructors
 
        //- Construct from names
        NamedEnum();
 
 
    // Member Functions
 
        //- Read a word from Istream and return the corresponding
        //  enumeration element
        Enum read(Istream&) const;
 
        //- Write the name representation of the enumeration to an Ostream
        void write(const Enum e, Ostream&) const;
 
        //- The set of names as a list of strings
        static stringList strings();
 
        //- The set of names as a list of words
        static wordList words();
 
 
    // Member Operators
 
        //- Return the enumeration element corresponding to the given name
        const Enum operator[](const char* name) const
        {
            return Enum(HashTable<int>::operator[](name));
        }
 
        //- Return the enumeration element corresponding to the given name
        const Enum operator[](const word& name) const
        {
            return Enum(HashTable<int>::operator[](name));
        }
 
        //- Return the name of the given enumeration element
        const char* operator[](const Enum e) const
        {
            return names[e];
        }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
#   include "NamedEnum.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //