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
virtual void	PrintSelf (ostream &os, vtkIndent indent)

int	Open (const char *dir)

vtkIdType	GetNumberOfFiles ()

const char *	GetFile (vtkIdType index)

int	FileIsDirectory (const char *name)


virtual vtkStringArray *	GetFiles ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkDirectory *	New ()

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

static int	MakeDirectory (const char *dir)

static int	DeleteDirectory (const char *dir)

static int	Rename (const char oldname, const char newname)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
void	CleanUpFilesAndPath ()

	vtkDirectory ()

	~vtkDirectory ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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

typedef vtkObject	Superclass

static int	IsTypeOf (const char *type)

static vtkDirectory *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkDirectory *	NewInstance () const

virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	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.

Tests:: vtkDirectory (Tests)

Definition at line 36 of file vtkDirectory.h.

Member Typedef Documentation

typedef vtkObject vtkDirectory::Superclass

Return the class name as a string.

Definition at line 41 of file vtkDirectory.h.

Constructor & Destructor Documentation

vtkDirectory::vtkDirectory ( )

protected

vtkDirectory::~vtkDirectory ( )

protected

Member Function Documentation

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

static

Return the class name as a string.

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

virtual

Return the class name as a string.

Reimplemented from vtkObject.

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

static

Return the class name as a string.

virtual vtkObjectBase* vtkDirectory::NewInstanceInternal ( ) const

protectedvirtual

Return the class name as a string.

Reimplemented from vtkObject.

vtkDirectory* vtkDirectory::NewInstance ( ) const

Return the class name as a string.

static vtkDirectory* vtkDirectory::New ( )

static

Create a new vtkDirectory object.

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

virtual

Print directory to stream.

Reimplemented from vtkObject.

int vtkDirectory::Open ( 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.

vtkIdType vtkDirectory::GetNumberOfFiles ( )

Return the number of files in the current directory.

const char* vtkDirectory::GetFile ( vtkIdType index )

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

int vtkDirectory::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.

virtual vtkStringArray* vtkDirectory::GetFiles ( )

virtual

Get an array that contains all the file names.

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

static

Get the current working directory.

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

static

Create directory.

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

static

Remove a directory.

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

static

Rename a file or directory.

void vtkDirectory::CleanUpFilesAndPath ( )

protected

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/System/vtkDirectory.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation