ensightFileNameI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2016-2020 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "error.H"
29 #include <cctype>
30 
31 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32 
34 :
35  fileName(s, false)
36 {
37  stripInvalid();
38 }
39 
40 
41 inline Foam::ensight::FileName::FileName(const std::string& s)
42 :
43  fileName(s, false)
44 {
45  stripInvalid();
46 }
47 
48 
49 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
50 
52 {
53  return
54  (
55  fileName::valid(c) // includes space, quotes
56  && c != '*' // wild-card
57  && c != '%' // structured block continuation
58  );
59 }
60 
61 
63 {
64  string::stripInvalid<FileName>(*this);
65 
66  // Avoid characters that upset Windows or others
67  string::replaceAny(":<>[]", '_');
68 
69  removeRepeated('/');
70  removeEnd('/');
71 
72  if (empty())
73  {
75  << "ensight::FileName empty after stripping" << nl
76  << exit(FatalError);
77  }
78 }
79 
80 
81 // ************************************************************************* //
Foam::fileName
A class for handling file names.
Definition: fileName.H:73
s
gmvFile<< "tracers "<< particles.size()<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().x()<< " ";}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().y()<< " ";}gmvFile<< nl;for(const passiveParticle &p :particles){ gmvFile<< p.position().z()<< " ";}gmvFile<< nl;forAll(lagrangianScalarNames, i){ word name=lagrangianScalarNames[i];IOField< scalar > s(IOobject(name, runTime.timeName(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
Definition: gmvOutputSpray.H:25
Foam::fileName::valid
static bool valid(char c)
Is this character valid for a fileName?
Definition: fileNameI.H:102
Foam::ensight::FileName::FileName
FileName(const FileName &)=default
Copy construct.
error.H
Foam::ensight::FileName::valid
static bool valid(char c)
Is this character valid for an ensight file-name.
Definition: ensightFileNameI.H:51
Foam::string::replaceAny
string & replaceAny(const std::string &s1, const char c2, size_type pos=0)
Definition: string.C:147
Foam::FatalError
error FatalError
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
Foam::nl
constexpr char nl
Definition: Ostream.H:404
Foam::constant::universal::c
const dimensionedScalar c
Speed of light in a vacuum.
Foam::ensight::FileName::stripInvalid
void stripInvalid()
Strip invalid characters.
Definition: ensightFileNameI.H:62