vtkPDirectory Class Reference

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

#include <vtkPDirectory.h>

Inheritance diagram for vtkPDirectory:

Collaboration diagram for vtkPDirectory:

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.
vtkPDirectory *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkIdType	GetNumberOfFiles () const
	Return the number of files in the current directory.
VTK_FILEPATH const char *	GetFile (vtkIdType index) const
	Return the file at the given index, the indexing is 0 based.
int	FileIsDirectory (const char *name)
	Return true if the file is a directory.
VTK_FILEPATH const char *	GetPath () const
	Return the path to Open'ed directory.
void	Clear ()
	Clear the internal structure.
bool	Load (const std::string &)
	Open/Load the specified directory and load the names of the files in that directory.
int	Open (const char *dir)
	Open/Load the specified directory and load the names of the files in that directory.
virtual vtkStringArray *	GetFiles ()
	Get an array that contains all the file names.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkPDirectory *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPDirectory *	SafeDownCast (vtkObjectBase *o)
static VTK_FILEPATH const char *	GetCurrentWorkingDirectory (char *buf, unsigned int len)
	Get the current working directory.
static int	MakeDirectory (VTK_FILEPATH const char *dir)
	Create directory.
static int	DeleteDirectory (VTK_FILEPATH const char *dir)
	Remove a directory.
static int	Rename (VTK_FILEPATH const char *oldname, VTK_FILEPATH const char *newname)
	Rename a file or directory.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
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.

Definition at line 34 of file vtkPDirectory.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkPDirectory::Superclass

Definition at line 38 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

)

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.

GetNumberOfFiles()

vtkIdType vtkPDirectory::GetNumberOfFiles

(

)

const

Return the number of files in the current directory.

GetFile()

VTK_FILEPATH 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()

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

GetCurrentWorkingDirectory()

static VTK_FILEPATH const char * vtkPDirectory::GetCurrentWorkingDirectory ( char *  buf, unsigned int  len  )

static

Get the current working directory.

MakeDirectory()

static int vtkPDirectory::MakeDirectory ( VTK_FILEPATH const char *  dir )

static

Create directory.

DeleteDirectory()

static int vtkPDirectory::DeleteDirectory ( VTK_FILEPATH const char *  dir )

static

Remove a directory.

Rename()

static int vtkPDirectory::Rename ( VTK_FILEPATH const char *  oldname, VTK_FILEPATH const char *  newname  )

static

Rename a file or directory.

---

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

• Parallel/Core/vtkPDirectory.h