VTK
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 =========================================================================*/
39 #ifndef vtkGlobFileNames_h
40 #define vtkGlobFileNames_h
41 
42 #include "vtkIOCoreModule.h" // For export macro
43 #include "vtkObject.h"
44 
45 class vtkStringArray;
46 
47 class VTKIOCORE_EXPORT vtkGlobFileNames : public vtkObject
48 {
49 public:
51 
54  vtkTypeMacro(vtkGlobFileNames,vtkObject);
56 
60  static vtkGlobFileNames *New();
61 
65  void PrintSelf(ostream& os, vtkIndent indent) override;
66 
70  void Reset();
71 
73 
80  vtkSetStringMacro(Directory);
81  vtkGetStringMacro(Directory);
83 
90  int AddFileNames(const char* pattern);
91 
93 
96  vtkSetMacro(Recurse, vtkTypeBool);
97  vtkBooleanMacro(Recurse, vtkTypeBool);
98  vtkGetMacro(Recurse, vtkTypeBool);
100 
105 
109  const char* GetNthFileName(int index);
110 
112 
115  vtkGetObjectMacro(FileNames, vtkStringArray);
117 
118 protected:
120 
123  vtkSetStringMacro(Pattern);
124  vtkGetStringMacro(Pattern);
126 
128  ~vtkGlobFileNames() override;
129 
130 private:
131  char* Directory; // Directory for search.
132  char* Pattern; // Wildcard pattern
133  vtkTypeBool Recurse; // Recurse into subdirectories
134  vtkStringArray *FileNames; // VTK array of files
135 
136 private:
137  vtkGlobFileNames(const vtkGlobFileNames&) = delete;
138  void operator=(const vtkGlobFileNames&) = delete;
139 };
140 
141 #endif
vtkGlobFileNames::New
static vtkGlobFileNames * New()
Create a new vtkGlobFileNames object.
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkGlobFileNames::GetNumberOfFileNames
int GetNumberOfFileNames()
Return the number of files found.
vtkGlobFileNames::Reset
void Reset()
Reset the glob by clearing the list of output filenames.
vtkGlobFileNames::GetNthFileName
const char * GetNthFileName(int index)
Return the file at the given index, the indexing is 0 based.
vtkGlobFileNames::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Print directory to stream.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkGlobFileNames
find files that match a wildcard pattern
Definition: vtkGlobFileNames.h:48
vtkObject.h
vtkGlobFileNames::vtkGlobFileNames
vtkGlobFileNames()
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:43
vtkGlobFileNames::~vtkGlobFileNames
~vtkGlobFileNames() override
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkGlobFileNames::AddFileNames
int AddFileNames(const char *pattern)
Search for all files that match the given expression, sort them, and add them to the output.