VTK
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  =========================================================================*/
28 #ifndef vtkPDirectory_h
29 #define vtkPDirectory_h
30 
31 #include "vtkParallelCoreModule.h" // For export macro
32 #include "vtkObject.h"
33 #include <string> // for string functions in Directory
34 
35 class vtkStringArray;
36 
37 class VTKPARALLELCORE_EXPORT vtkPDirectory : public vtkObject
38 {
39  public:
40  static vtkPDirectory *New();
41  vtkTypeMacro(vtkPDirectory,vtkObject);
42  void PrintSelf(ostream& os, vtkIndent indent);
43 
45 
52  bool Load(const std::string&);
53  int Open(const char* dir);
55 
60 
64  const char* GetFile(vtkIdType index) const;
65 
72  int FileIsDirectory(const char *name);
73 
75 
78  vtkGetObjectMacro(Files, vtkStringArray);
80 
84  const char* GetPath() const;
85 
90  void Clear();
91 
92  protected:
95 
96  private:
97  // Array of Files
98  vtkStringArray *Files; // VTK array of files
99 
100  // Path to Open'ed directory
101  std::string Path;
102 
103  vtkPDirectory(const vtkPDirectory&) VTK_DELETE_FUNCTION;
104  void operator=(const vtkPDirectory&) VTK_DELETE_FUNCTION;
105 }; // End Class: vtkPDirectory
106 
107 #endif
vtkPDirectory::~vtkPDirectory
~vtkPDirectory()
vtkIdType
int vtkIdType
Definition: vtkType.h:287
vtkPDirectory::Open
int Open(const char *dir)
vtkPDirectory::GetFile
const char * GetFile(vtkIdType index) const
Return the file at the given index, the indexing is 0 based.
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkX3D::dir
@ dir
Definition: vtkX3D.h:324
vtkPDirectory::GetPath
const char * GetPath() const
Return the path to Open'ed directory.
vtkPDirectory::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkPDirectory
vtkPDirectory provides a portable way of finding the names of the files in a system directory where p...
Definition: vtkPDirectory.h:38
vtkPDirectory::New
static vtkPDirectory * New()
vtkPDirectory::Load
bool Load(const std::string &)
Open/Load the specified directory and load the names of the files in that directory.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkX3D::name
@ name
Definition: vtkX3D.h:219
vtkObject.h
vtkX3D::string
@ string
Definition: vtkX3D.h:490
vtkPDirectory::FileIsDirectory
int FileIsDirectory(const char *name)
Return true if the file is a directory.
vtkPDirectory::GetNumberOfFiles
vtkIdType GetNumberOfFiles() const
Return the number of files in the current directory.
vtkStringArray
a vtkAbstractArray subclass for strings
Definition: vtkStringArray.h:43
vtkPDirectory::vtkPDirectory
vtkPDirectory()
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkPDirectory::Clear
void Clear()
Clear the internal structure.