File: vtkPDirectory.h

package info (click to toggle)
paraview 5.1.2%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 221,108 kB
  • ctags: 236,092
  • sloc: cpp: 2,416,026; ansic: 190,891; python: 99,856; xml: 81,001; tcl: 46,915; yacc: 5,039; java: 4,413; perl: 3,108; sh: 1,974; lex: 1,926; f90: 748; asm: 471; pascal: 228; makefile: 198; objc: 83; fortran: 31
file content (91 lines) | stat: -rw-r--r-- 3,068 bytes parent folder | download
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
/*=========================================================================

  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.

  =========================================================================*/
// .NAME vtkPDirectory -- parallel wrapper for VTK Directory and vtkDirectory
// .SECTION Description
// 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);

  // Description:
  // 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);

  // Description:
  // Return the number of files in the current directory.
  vtkIdType GetNumberOfFiles() const;

  // Description:
  // Return the file at the given index, the indexing is 0 based
  const char* GetFile(vtkIdType index) const;

  // Description:
  // 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);

  // Description:
  // Get an array that contains all the file names.
  vtkGetObjectMacro(Files, vtkStringArray);

  // Description:
  // Return the path to Open'ed directory
  const char* GetPath() const;

  // Description:
  // 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&);  // Not implemented.
  void operator=(const vtkPDirectory&);  // Not implemented.
}; // End Class: vtkPDirectory

#endif