ensightVarName.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2016-2020 OpenCFD Ltd.
-------------------------------------------------------------------------------
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::ensight::VarName
 
Description
    Specification of a valid Ensight variable-name.
 
    Illegal characters
    \code
        space !#%()*+,-./;@[]^
    \endcode
    If spaces exist, they must be quoted
 
    Variable names cannot start with a digit.
    The maximum part name length (in GUI: 49 chars) - not addressed.
    The maximum variable length (in GUI: 49 chars) - not addressed.
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_ensightVarName_H
#define Foam_ensightVarName_H
 
#include "word.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace ensight
{
 
/*---------------------------------------------------------------------------*\
                      Class ensight::VarName Declaration
\*---------------------------------------------------------------------------*/
 
class VarName
:
    public word
{
public:
 
    // Generated Methods
 
        //- Copy construct
        VarName(const VarName&) = default;
 
        //- Move construct
        VarName(VarName&&) = default;
 
 
    // Constructors
 
        //- Construct as copy of character array
        inline explicit VarName(const char* s);
 
        //- Copy construct from std::string
        inline explicit VarName(const std::string& s);
 
        //- Move construct from std::string
        inline explicit VarName(std::string&& s);
 
 
    // Member Functions
 
        //- Is this character valid for an ensight var-name
        inline static bool valid(char c);
 
        //- Strip invalid characters
        inline void stripInvalid();
 
 
    // Member Operators
 
        // Assignment (disabled)
 
        void operator=(const word&) = delete;
        void operator=(const string&) = delete;
        void operator=(const std::string&) = delete;
        void operator=(const char*) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace ensight
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
//- Hashing for VarName is the same as string
template<> struct Hash<ensight::VarName> : string::hasher {};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "ensightVarNameI.H"
 
#endif
 
// ************************************************************************* //