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

#include <vtkPDirectory.h>

Inheritance diagram for vtkPDirectory:
[legend]
Collaboration diagram for vtkPDirectory:
[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...
 
vtkPDirectoryNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool Load (const std::string &)
 Open/Load the specified directory and load the names of the files in that directory. More...
 
int Open (const char *dir)
 
vtkIdType GetNumberOfFiles () const
 Return the number of files in the current directory. More...
 
const char * GetFile (vtkIdType index) const
 Return the file at the given index, the indexing is 0 based. More...
 
int FileIsDirectory (const char *name)
 Return true if the file is a directory. More...
 
virtual vtkStringArrayGetFiles ()
 Get an array that contains all the file names. More...
 
const char * GetPath () const
 Return the path to Open'ed directory. More...
 
void Clear ()
 Clear the internal structure. 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 vtkPDirectoryNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPDirectorySafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkPDirectory ()
 
 ~vtkPDirectory () 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

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.

Tests:
vtkPDirectory (Tests)

Definition at line 37 of file vtkPDirectory.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkPDirectory.h.

Constructor & Destructor Documentation

◆ vtkPDirectory()

vtkPDirectory::vtkPDirectory ( )
protected

◆ ~vtkPDirectory()

vtkPDirectory::~vtkPDirectory ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPDirectory* vtkPDirectory::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPDirectory::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 vtkPDirectory* vtkPDirectory::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPDirectory::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkPDirectory* vtkPDirectory::NewInstance ( ) const

◆ PrintSelf()

void vtkPDirectory::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.

◆ Load()

bool vtkPDirectory::Load ( const std::string &  )

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.

◆ Open()

int vtkPDirectory::Open ( const char *  dir)

◆ GetNumberOfFiles()

vtkIdType vtkPDirectory::GetNumberOfFiles ( ) const

Return the number of files in the current directory.

◆ GetFile()

const char* vtkPDirectory::GetFile ( vtkIdType  index) const

Return the file at the given index, the indexing is 0 based.

◆ FileIsDirectory()

int vtkPDirectory::FileIsDirectory ( const char *  name)

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.

◆ GetFiles()

virtual vtkStringArray* vtkPDirectory::GetFiles ( )
virtual

Get an array that contains all the file names.

◆ GetPath()

const char* vtkPDirectory::GetPath ( ) const

Return the path to Open'ed directory.

◆ Clear()

void vtkPDirectory::Clear ( )

Clear the internal structure.

Used internally at beginning of Load(...) to clear the cache.


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