VTK  9.3.0
vtkDirectory.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
26 #ifndef vtkDirectory_h
27 #define vtkDirectory_h
28 
29 #include "vtkCommonSystemModule.h" // For export macro
30 #include "vtkObject.h"
31 
32 VTK_ABI_NAMESPACE_BEGIN
33 class vtkStringArray;
34 
35 class VTKCOMMONSYSTEM_EXPORT vtkDirectory : public vtkObject
36 {
37 public:
39 
42  vtkTypeMacro(vtkDirectory, vtkObject);
44 
48  static vtkDirectory* New();
49 
53  void PrintSelf(ostream& os, vtkIndent indent) override;
54 
60  int Open(VTK_FILEPATH const char* dir);
61 
66 
71 
78  int FileIsDirectory(VTK_FILEPATH const char* name);
79 
81 
84  vtkGetObjectMacro(Files, vtkStringArray);
86 
90  static VTK_FILEPATH const char* GetCurrentWorkingDirectory(char* buf, unsigned int len);
91 
95  static int MakeDirectory(VTK_FILEPATH const char* dir);
96 
100  static int DeleteDirectory(VTK_FILEPATH const char* dir);
101 
105  static int Rename(VTK_FILEPATH const char* oldname, VTK_FILEPATH const char* newname);
106 
107 protected:
108  // delete the Files and Path ivars and set
109  // NumberOfFiles to 0
112  ~vtkDirectory() override;
113 
114 private:
115  char* Path; // Path to Open'ed directory
116  vtkStringArray* Files; // VTK array of files
117 
118  static int CreateDirectoryInternal(const char* dir);
119 
120  vtkDirectory(const vtkDirectory&) = delete;
121  void operator=(const vtkDirectory&) = delete;
122 };
123 
124 VTK_ABI_NAMESPACE_END
125 #endif
OS independent class for access and manipulation of system directories.
Definition: vtkDirectory.h:36
vtkIdType GetNumberOfFiles()
Return the number of files in the current directory.
static int Rename(VTK_FILEPATH const char *oldname, VTK_FILEPATH const char *newname)
Rename a file or directory.
int FileIsDirectory(VTK_FILEPATH const char *name)
Return true if the file is a directory.
void CleanUpFilesAndPath()
static int MakeDirectory(VTK_FILEPATH const char *dir)
Create directory.
static int DeleteDirectory(VTK_FILEPATH const char *dir)
Remove a directory.
static VTK_FILEPATH const char * GetCurrentWorkingDirectory(char *buf, unsigned int len)
Get the current working directory.
int Open(VTK_FILEPATH const char *dir)
Open the specified directory and load the names of the files in that directory.
VTK_FILEPATH const char * GetFile(vtkIdType index)
Return the file at the given index, the indexing is 0 based.
static vtkDirectory * New()
Create a new vtkDirectory object.
~vtkDirectory() override
void PrintSelf(ostream &os, vtkIndent indent) override
Print directory to stream.
a simple class to control print indentation
Definition: vtkIndent.h:38
abstract base class for most VTK objects
Definition: vtkObject.h:61
a vtkAbstractArray subclass for strings
@ dir
Definition: vtkX3D.h:324
@ name
Definition: vtkX3D.h:219
@ index
Definition: vtkX3D.h:246
int vtkIdType
Definition: vtkType.h:315
#define VTK_FILEPATH