fileOperationInitialise.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) 2017-2018 OpenFOAM Foundation
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 Class
27  Foam::fileOperationInitialise
28 
29 \*---------------------------------------------------------------------------*/
30 
31 #ifndef fileOperationInitialise_H
32 #define fileOperationInitialise_H
33 
34 #include "runTimeSelectionTables.H"
35 
36 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
37 
38 namespace Foam
39 {
40 namespace fileOperations
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Class fileOperationInitialise Declaration
45 \*---------------------------------------------------------------------------*/
46 
48 {
49 public:
50 
51  //- Runtime type information
52  TypeName("fileOperationInitialise");
53 
54 
55  // Constructors
56 
57  //- Construct components
58  fileOperationInitialise(int& argc, char**& argv);
59 
60 
61  // Declare run-time constructor selection table
62 
64  (
65  autoPtr,
67  word,
68  (
69  int& argc, char**& argv
70  ),
71  (argc, argv)
72  );
73 
74 
75  // Selectors
76 
77  //- Select type
79  (
80  const word& type, int& argc, char**& argv
81  );
82 
83 
84  //- Destructor
85  virtual ~fileOperationInitialise() = default;
86 
87 
88  // Member Functions
89 
90  //- Needs threading
91  virtual bool needsThreading() const = 0;
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace fileOperations
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #endif
103 
104 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::fileOperations::fileOperationInitialise
Definition: fileOperationInitialise.H:46
Foam::fileOperations::fileOperationInitialise::needsThreading
virtual bool needsThreading() const =0
Needs threading.
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
runTimeSelectionTables.H
Macros to ease declaration of run-time selection tables.
Foam::type
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:590
Foam::fileOperations::fileOperationInitialise::TypeName
TypeName("fileOperationInitialise")
Runtime type information.
Foam::fileOperations::fileOperationInitialise::declareRunTimeSelectionTable
declareRunTimeSelectionTable(autoPtr, fileOperationInitialise, word,(int &argc, char **&argv),(argc, argv))
Foam::fileOperations::fileOperationInitialise::fileOperationInitialise
fileOperationInitialise(int &argc, char **&argv)
Construct components.
Definition: fileOperationInitialise.C:47
Foam::fileOperations::fileOperationInitialise::~fileOperationInitialise
virtual ~fileOperationInitialise()=default
Destructor.
Foam::fileOperations::fileOperationInitialise::New
static autoPtr< fileOperationInitialise > New(const word &type, int &argc, char **&argv)
Select type.
Definition: fileOperationInitialise.C:56