OS independent class for access and manipulation of system directories. More...

#include <vtkDirectory.h>

Inheritance diagram for vtkDirectory:

Collaboration diagram for vtkDirectory:

Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent) override
	Print directory to stream.

int	Open (VTK_FILEPATH const char *dir)
	Open the specified directory and load the names of the files in that directory.

vtkIdType	GetNumberOfFiles ()
	Return the number of files in the current directory.

VTK_FILEPATH const char *	GetFile (vtkIdType index)
	Return the file at the given index, the indexing is 0 based.

int	FileIsDirectory (VTK_FILEPATH const char *name)
	Return true if the file is a 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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

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.

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.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkDirectory *	New ()
	Create a new vtkDirectory object.

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 (vtkTypeBool 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 vtkTypeBool	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
void	CleanUpFilesAndPath ()

	vtkDirectory ()

	~vtkDirectory () 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 *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

typedef vtkObject	Superclass
	Return the class name as a string.

static vtkTypeBool	IsTypeOf (const char *type)
	Return the class name as a string.

static vtkDirectory *	SafeDownCast (vtkObjectBase *o)
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *type)
	Return the class name as a string.

vtkDirectory *	NewInstance () const
	Return the class name as a string.

virtual vtkObjectBase *	NewInstanceInternal () const
	Return the class name as a string.

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

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

OS independent class for access and manipulation of system directories.

vtkDirectory provides a portable way of finding the names of the files in a system directory. It also provides methods of manipulating directories.

Warning: vtkDirectory works with windows and unix only.

Online Examples:

FilenameFunctions

Tests:: vtkDirectory (Tests)

Definition at line 46 of file vtkDirectory.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkDirectory::Superclass

Return the class name as a string.

Definition at line 53 of file vtkDirectory.h.

Constructor & Destructor Documentation

◆ vtkDirectory()

vtkDirectory::vtkDirectory ( )

protected

◆ ~vtkDirectory()

vtkDirectory::~vtkDirectory ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

Return the class name as a string.

◆ IsA()

virtual vtkTypeBool vtkDirectory::IsA ( const char * type )

virtual

Return the class name as a string.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

Return the class name as a string.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDirectory::NewInstanceInternal ( ) const

protectedvirtual

Return the class name as a string.

◆ NewInstance()

vtkDirectory * vtkDirectory::NewInstance ( ) const

Return the class name as a string.

◆ New()

static vtkDirectory * vtkDirectory::New ( )

static

Create a new vtkDirectory object.

◆ PrintSelf()

void vtkDirectory::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Print directory to stream.

Reimplemented from vtkObjectBase.

◆ Open()

int vtkDirectory::Open ( VTK_FILEPATH const char * dir )

Open the specified directory and load the names of the files in that directory.

0 is returned if the directory can not be opened, 1 if it is opened.

◆ GetNumberOfFiles()

vtkIdType vtkDirectory::GetNumberOfFiles ( )

Return the number of files in the current directory.

◆ GetFile()

VTK_FILEPATH const char * vtkDirectory::GetFile ( vtkIdType index )

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

◆ FileIsDirectory()

int vtkDirectory::FileIsDirectory ( VTK_FILEPATH 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 * vtkDirectory::GetFiles ( )

virtual

Get an array that contains all the file names.

◆ GetCurrentWorkingDirectory()

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

static

Get the current working directory.

Returns nullptr on failure, or if the provided buffer is too small.

◆ MakeDirectory()

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

static

Create directory.

◆ DeleteDirectory()

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

static

Remove a directory.

◆ Rename()

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

static

Rename a file or directory.

◆ CleanUpFilesAndPath()

void vtkDirectory::CleanUpFilesAndPath ( )

protected

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

Common/System/vtkDirectory.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkDirectory()

◆ ~vtkDirectory()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ New()

◆ PrintSelf()

◆ Open()

◆ GetNumberOfFiles()

◆ GetFile()

◆ FileIsDirectory()

◆ GetFiles()

◆ GetCurrentWorkingDirectory()

◆ MakeDirectory()

◆ DeleteDirectory()

◆ Rename()

◆ CleanUpFilesAndPath()