VTK  9.0.1
vtkGlobFileNames.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkGlobFileNames.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
36 #ifndef vtkGlobFileNames_h
37 #define vtkGlobFileNames_h
38 
39 #include "vtkIOCoreModule.h" // For export macro
40 #include "vtkObject.h"
41 
42 class vtkStringArray;
43 
44 class VTKIOCORE_EXPORT vtkGlobFileNames : public vtkObject
45 {
46 public:
48 
51  vtkTypeMacro(vtkGlobFileNames, vtkObject);
53 
57  static vtkGlobFileNames* New();
58 
62  void PrintSelf(ostream& os, vtkIndent indent) override;
63 
67  void Reset();
68 
70 
77  vtkSetStringMacro(Directory);
78  vtkGetStringMacro(Directory);
80 
87  int AddFileNames(const char* pattern);
88 
90 
93  vtkSetMacro(Recurse, vtkTypeBool);
94  vtkBooleanMacro(Recurse, vtkTypeBool);
95  vtkGetMacro(Recurse, vtkTypeBool);
97 
102 
106  const char* GetNthFileName(int index);
107 
109 
112  vtkGetObjectMacro(FileNames, vtkStringArray);
114 
115 protected:
117 
120  vtkSetStringMacro(Pattern);
121  vtkGetStringMacro(Pattern);
123 
125  ~vtkGlobFileNames() override;
126 
127 private:
128  char* Directory; // Directory for search.
129  char* Pattern; // Wildcard pattern
130  vtkTypeBool Recurse; // Recurse into subdirectories
131  vtkStringArray* FileNames; // VTK array of files
132 
133 private:
134  vtkGlobFileNames(const vtkGlobFileNames&) = delete;
135  void operator=(const vtkGlobFileNames&) = delete;
136 };
137 
138 #endif
find files that match a wildcard pattern
void Reset()
Reset the glob by clearing the list of output filenames.
static vtkGlobFileNames * New()
Create a new vtkGlobFileNames object.
int GetNumberOfFileNames()
Return the number of files found.
~vtkGlobFileNames() override
const char * GetNthFileName(int index)
Return the file at the given index, the indexing is 0 based.
void PrintSelf(ostream &os, vtkIndent indent) override
Print directory to stream.
int AddFileNames(const char *pattern)
Search for all files that match the given expression, sort them, and add them to the output.
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:54
a vtkAbstractArray subclass for strings
@ index
Definition: vtkX3D.h:252
int vtkTypeBool
Definition: vtkABI.h:69