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
17 #ifndef vtkDirectory_h
18 #define vtkDirectory_h
19 
20 #include "vtkCommonSystemModule.h" // For export macro
21 #include "vtkObject.h"
22 
23 VTK_ABI_NAMESPACE_BEGIN
24 class vtkStringArray;
25 
26 class VTKCOMMONSYSTEM_EXPORT vtkDirectory : public vtkObject
27 {
28 public:
30 
33  vtkTypeMacro(vtkDirectory, vtkObject);
35 
39  static vtkDirectory* New();
40 
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
51  int Open(VTK_FILEPATH const char* dir);
52 
57 
62 
69  int FileIsDirectory(VTK_FILEPATH const char* name);
70 
72 
75  vtkGetObjectMacro(Files, vtkStringArray);
77 
81  static VTK_FILEPATH const char* GetCurrentWorkingDirectory(char* buf, unsigned int len);
82 
86  static int MakeDirectory(VTK_FILEPATH const char* dir);
87 
91  static int DeleteDirectory(VTK_FILEPATH const char* dir);
92 
96  static int Rename(VTK_FILEPATH const char* oldname, VTK_FILEPATH const char* newname);
97 
98 protected:
99  // delete the Files and Path ivars and set
100  // NumberOfFiles to 0
103  ~vtkDirectory() override;
104 
105 private:
106  char* Path; // Path to Open'ed directory
107  vtkStringArray* Files; // VTK array of files
108 
109  static int CreateDirectoryInternal(const char* dir);
110 
111  vtkDirectory(const vtkDirectory&) = delete;
112  void operator=(const vtkDirectory&) = delete;
113 };
114 
115 VTK_ABI_NAMESPACE_END
116 #endif
OS independent class for access and manipulation of system directories.
Definition: vtkDirectory.h:27
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:29
abstract base class for most VTK objects
Definition: vtkObject.h:52
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