src/meshLibrary/utilities/helperFunctions/helperFunctionsStringConversion.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | cfMesh: A library for mesh generation
   4    \\    /   O peration     |
   5     \\  /    A nd           | Author: Franjo Juretic (franjo.juretic@c-fields.com)
   6      \\/     M anipulation  | Copyright (C) Creative Fields, Ltd.
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of cfMesh.
  10
  11     cfMesh 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.
  15
  16     cfMesh 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 cfMesh.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 InNamespace
  25     Foam::help
  26
  27 Description
  28     String conversion functions
  29
  30 SourceFiles
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef helperFunctionsStringConversion_H
  35 #define helperFunctionsStringConversion_H
  36
  37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  38
  39 #include "word.H"
  40 #include "label.H"
  41 #include "scalar.H"
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                     Namespace help functions Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 namespace help
  51 {
  52
  53     //- convert the text to scalar
  54     scalar textToScalar(const word& w);
  55
  56     //- convert the text to label
  57     label textToLabel(const word& w);
  58
  59     //- convert the scalar value into text
  60     word scalarToText(const scalar s);
  61
  62     //- convert the integer value into text
  63     word labelToText(const label l);
  64
  65 } // End namespace help
  66
  67 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  68
  69 } // End namespace Foam
  70
  71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  72
  73 #endif
  74
  75 // ************************************************************************* //