VTK  9.0.1
vtkPDirectory.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPDirectory.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  =========================================================================*/
25 #ifndef vtkPDirectory_h
26 #define vtkPDirectory_h
27 
28 #include "vtkObject.h"
29 #include "vtkParallelCoreModule.h" // For export macro
30 #include <string> // for string functions in Directory
31 
32 class vtkStringArray;
33 
34 class VTKPARALLELCORE_EXPORT vtkPDirectory : public vtkObject
35 {
36 public:
37  static vtkPDirectory* New();
38  vtkTypeMacro(vtkPDirectory, vtkObject);
39  void PrintSelf(ostream& os, vtkIndent indent) override;
40 
42 
49  bool Load(const std::string&);
50  int Open(const char* dir);
52 
57 
61  const char* GetFile(vtkIdType index) const;
62 
69  int FileIsDirectory(const char* name);
70 
72 
75  vtkGetObjectMacro(Files, vtkStringArray);
77 
81  const char* GetPath() const;
82 
87  void Clear();
88 
89 protected:
91  ~vtkPDirectory() override;
92 
93 private:
94  // Array of Files
95  vtkStringArray* Files; // VTK array of files
96 
97  // Path to Open'ed directory
98  std::string Path;
99 
100  vtkPDirectory(const vtkPDirectory&) = delete;
101  void operator=(const vtkPDirectory&) = delete;
102 }; // End Class: vtkPDirectory
103 
104 #endif
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:63
vtkPDirectory provides a portable way of finding the names of the files in a system directory where p...
Definition: vtkPDirectory.h:35
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static vtkPDirectory * New()
const char * GetFile(vtkIdType index) const
Return the file at the given index, the indexing is 0 based.
int Open(const char *dir)
~vtkPDirectory() override
bool Load(const std::string &)
Open/Load the specified directory and load the names of the files in that directory.
void Clear()
Clear the internal structure.
const char * GetPath() const
Return the path to Open'ed directory.
vtkIdType GetNumberOfFiles() const
Return the number of files in the current directory.
int FileIsDirectory(const char *name)
Return true if the file is a directory.
a vtkAbstractArray subclass for strings
@ dir
Definition: vtkX3D.h:330
@ name
Definition: vtkX3D.h:225
@ index
Definition: vtkX3D.h:252
@ string
Definition: vtkX3D.h:496
int vtkIdType
Definition: vtkType.h:338