File: vtkPSystemTools.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 (107 lines) | stat: -rw-r--r-- 4,381 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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkPSystemTools.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 vtkPSystemTools - System tools for file system introspection
// .SECTION Description
// A class with only static methods for doing parallel file system
// introspection. It limits doing file stats on process 0 and
// broadcasting the results to other processes. It is built on VTK's
// SystemTools class and uses the global controller for communication.
// It uses blocking collective communication operations.

#ifndef vtkPSystemTools_h
#define vtkPSystemTools_h

#include "vtkParallelCoreModule.h" // For export macro
#include "vtkObject.h"
#include <string> // for string functions in SystemTools

class VTKPARALLELCORE_EXPORT vtkPSystemTools : public vtkObject
{
 public:
  static vtkPSystemTools *New();
  vtkTypeMacro(vtkPSystemTools,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // Given a string on process proc, broadcast that string to
  // all of the other processes. This method does not have a
  // correspondence to anything in SystemTools.

  static void BroadcastString(std::string&, int proc);

  // Description:
  // Given a path to a file or directory, convert it to a full path.
  // This collapses away relative paths relative to the cwd argument
  // (which defaults to the current working directory).  The full path
  // is returned.

  static std::string CollapseFullPath(const std::string& in_relative);
  static std::string CollapseFullPath(const std::string& in_relative,
                                      const char* in_base);

  // Description:
  // Return true if a file exists in the current directory.
  // If isFile = true, then make sure the file is a file and
  // not a directory.  If isFile = false, then return true
  // if it is a file or a directory.  Note that the file will
  // also be checked for read access.  (Currently, this check
  // for read access is only done on POSIX systems.)
  static bool FileExists(const char* filename, bool isFile);
  static bool FileExists(const std::string& filename, bool isFile);
  static bool FileExists(const char* filename);
  static bool FileExists(const std::string& filename);

  // Description:
  // Return true if the file is a directory
  static bool FileIsDirectory(const std::string& name);

  // Description:
  // Given argv[0] for a unix program find the full path to a running
  // executable.  argv0 can be null for windows WinMain programs
  // in this case GetModuleFileName will be used to find the path
  // to the running executable.  If argv0 is not a full path,
  // then this will try to find the full path.  If the path is not
  // found false is returned, if found true is returned.  An error
  // message of the attempted paths is stored in errorMsg.
  // exeName is the name of the executable.
  // buildDir is a possibly null path to the build directory.
  // installPrefix is a possibly null pointer to the install directory.
  static bool FindProgramPath(const char* argv0,
                              std::string& pathOut,
                              std::string& errorMsg,
                              const char* exeName = 0,
                              const char* buildDir = 0,
                              const char* installPrefix = 0);

  // Description:
  // Get current working directory CWD
  static std::string GetCurrentWorkingDirectory(bool collapse =true);

  // Description:
  // Given the path to a program executable, get the directory part of
  // the path with the file stripped off.  If there is no directory
  // part, the empty string is returned.
  static std::string GetProgramPath(const std::string&);

protected:
  vtkPSystemTools() {}
  ~vtkPSystemTools() {}

private:
  vtkPSystemTools(const vtkPSystemTools&);  // Not implemented.
  void operator=(const vtkPSystemTools&);  // Not implemented.
};

#endif