VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkPSystemTools Class Reference

System tools for file system introspection. More...

#include <vtkPSystemTools.h>

Inheritance diagram for vtkPSystemTools:
[legend]
Collaboration diagram for vtkPSystemTools:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkPSystemToolsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkPSystemToolsNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPSystemToolsSafeDownCast (vtkObjectBase *o)
 
static void BroadcastString (std::string &, int proc)
 Given a string on process proc, broadcast that string to all of the other processes. More...
 
static std::string CollapseFullPath (const std::string &in_relative)
 Given a path to a file or directory, convert it to a full path. More...
 
static std::string CollapseFullPath (const std::string &in_relative, const char *in_base)
 
static bool FileExists (const char *filename, bool isFile)
 Return true if a file exists in the current directory. More...
 
static bool FileExists (const std::string &filename, bool isFile)
 
static bool FileExists (const char *filename)
 
static bool FileExists (const std::string &filename)
 
static bool FileIsDirectory (const std::string &name)
 Return true if the file is a directory. More...
 
static bool FindProgramPath (const char *argv0, std::string &pathOut, std::string &errorMsg, const char *exeName=nullptr, const char *buildDir=nullptr, const char *installPrefix=nullptr)
 Given argv[0] for a unix program find the full path to a running executable. More...
 
static std::string GetCurrentWorkingDirectory (bool collapse=true)
 Get current working directory CWD. More...
 
static std::string GetProgramPath (const std::string &)
 Given the path to a program executable, get the directory part of the path with the file stripped off. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPSystemTools ()
 
 ~vtkPSystemTools () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

System tools for file system introspection.

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.

Definition at line 33 of file vtkPSystemTools.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkPSystemTools.h.

Constructor & Destructor Documentation

◆ vtkPSystemTools()

vtkPSystemTools::vtkPSystemTools ( )
inlineprotected

Definition at line 107 of file vtkPSystemTools.h.

◆ ~vtkPSystemTools()

vtkPSystemTools::~vtkPSystemTools ( )
inlineoverrideprotected

Definition at line 108 of file vtkPSystemTools.h.

Member Function Documentation

◆ New()

static vtkPSystemTools* vtkPSystemTools::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkPSystemTools::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkPSystemTools::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkPSystemTools* vtkPSystemTools::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPSystemTools::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkPSystemTools* vtkPSystemTools::NewInstance ( ) const

◆ PrintSelf()

void vtkPSystemTools::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ BroadcastString()

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

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.

◆ CollapseFullPath() [1/2]

static std::string vtkPSystemTools::CollapseFullPath ( const std::string &  in_relative)
static

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.

◆ CollapseFullPath() [2/2]

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

◆ FileExists() [1/4]

static bool vtkPSystemTools::FileExists ( const char *  filename,
bool  isFile 
)
static

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.)

◆ FileExists() [2/4]

static bool vtkPSystemTools::FileExists ( const std::string &  filename,
bool  isFile 
)
static

◆ FileExists() [3/4]

static bool vtkPSystemTools::FileExists ( const char *  filename)
static

◆ FileExists() [4/4]

static bool vtkPSystemTools::FileExists ( const std::string &  filename)
static

◆ FileIsDirectory()

static bool vtkPSystemTools::FileIsDirectory ( const std::string &  name)
static

Return true if the file is a directory.

◆ FindProgramPath()

static bool vtkPSystemTools::FindProgramPath ( const char *  argv0,
std::string &  pathOut,
std::string &  errorMsg,
const char *  exeName = nullptr,
const char *  buildDir = nullptr,
const char *  installPrefix = nullptr 
)
static

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.

◆ GetCurrentWorkingDirectory()

static std::string vtkPSystemTools::GetCurrentWorkingDirectory ( bool  collapse = true)
static

Get current working directory CWD.

◆ GetProgramPath()

static std::string vtkPSystemTools::GetProgramPath ( const std::string &  )
static

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.


The documentation for this class was generated from the following file: