1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkPDirectory.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkPDirectory
*
* vtkPDirectory provides a portable way of finding the names of the files
* in a system directory where process 0 finds the information and
* broadcasts it to other processes. It tries to replicate the API for both
* Directory and vtkDirectory though there are slight mismatches between the
* two. This is a blocking collective operation.
*/
#ifndef vtkPDirectory_h
#define vtkPDirectory_h
#include "vtkParallelCoreModule.h" // For export macro
#include "vtkObject.h"
#include <string> // for string functions in Directory
class vtkStringArray;
class VTKPARALLELCORE_EXPORT vtkPDirectory : public vtkObject
{
public:
static vtkPDirectory *New();
vtkTypeMacro(vtkPDirectory,vtkObject);
void PrintSelf(ostream& os, vtkIndent indent);
//@{
/**
* Open/Load the specified directory and load the names of the files
* in that directory. false/0 is returned if the directory can not be
* opened, true/1 if it is opened. The reason that there are two versions
* of this is that Directory uses Load() and vtkDirectory uses Open()
* for this functionality.
*/
bool Load(const std::string&);
int Open(const char* dir);
//@}
/**
* Return the number of files in the current directory.
*/
vtkIdType GetNumberOfFiles() const;
/**
* Return the file at the given index, the indexing is 0 based
*/
const char* GetFile(vtkIdType index) const;
/**
* Return true if the file is a directory. If the file is not an
* absolute path, it is assumed to be relative to the opened
* directory. If no directory has been opened, it is assumed to
* be relative to the current working directory.
*/
int FileIsDirectory(const char *name);
//@{
/**
* Get an array that contains all the file names.
*/
vtkGetObjectMacro(Files, vtkStringArray);
//@}
/**
* Return the path to Open'ed directory
*/
const char* GetPath() const;
/**
* Clear the internal structure. Used internally at beginning of Load(...)
* to clear the cache.
*/
void Clear();
protected:
vtkPDirectory();
~vtkPDirectory();
private:
// Array of Files
vtkStringArray *Files; // VTK array of files
// Path to Open'ed directory
std::string Path;
vtkPDirectory(const vtkPDirectory&) VTK_DELETE_FUNCTION;
void operator=(const vtkPDirectory&) VTK_DELETE_FUNCTION;
}; // End Class: vtkPDirectory
#endif
|
