vtkDirectory Class Reference

#include <vtkDirectory.h>

Inheritance diagram for vtkDirectory:

[legend]Collaboration diagram for vtkDirectory:

[legend]List of all members.

---

Detailed Description

OS independent class for access to system directories.

vtkDirectory provides a portable way of finding the names of the files in a system directory.

Warning:

vtkDirectory works with windows and unix only.

Tests:

vtkDirectory (Tests)

Definition at line 35 of file vtkDirectory.h.

typedef vtkObject	Superclass
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
static int	IsTypeOf (const char *type)
static vtkDirectory *	SafeDownCast (vtkObject *o)
Public Member Functions
virtual void	PrintSelf (ostream &os, vtkIndent indent)
int	Open (const char *dir)
int	GetNumberOfFiles ()
const char *	GetFile (int index)
int	FileIsDirectory (const char *name)
virtual vtkStringArray *	GetFiles ()
Static Public Member Functions
static vtkDirectory *	New ()
static const char *	GetCurrentWorkingDirectory (char *buf, unsigned int len)
static int	MakeDirectory (const char *dir)
static int	CreateDirectory (const char *dir)
Protected Member Functions
void	CleanUpFilesAndPath ()
	vtkDirectory ()
	~vtkDirectory ()

---

Member Typedef Documentation

typedef vtkObject vtkDirectory::Superclass

Return the class name as a string. Reimplemented from vtkObject. Definition at line 40 of file vtkDirectory.h.

---

Constructor & Destructor Documentation

vtkDirectory::vtkDirectory (   )  [protected]

vtkDirectory::~vtkDirectory (   )  [protected]

---

Member Function Documentation

virtual const char* vtkDirectory::GetClassName (   )  [virtual]

Return the class name as a string. Reimplemented from vtkObject.

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

Return the class name as a string. Reimplemented from vtkObject.

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

Return the class name as a string. Reimplemented from vtkObject.

static vtkDirectory* vtkDirectory::SafeDownCast (  vtkObject *  o  )  [static]

Return the class name as a string. Reimplemented from vtkObject.

static vtkDirectory* vtkDirectory::New (   )  [static]

Create a new vtkDirectory object. Reimplemented from vtkObject.

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.

int vtkDirectory::GetNumberOfFiles (   )

Return the number of files in the current directory.

const char* vtkDirectory::GetFile (  int  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. Needs rework to do all the testing and to work on all platforms.

static int vtkDirectory::CreateDirectory (  const char *  dir  )  [static]

Deprecated: Replaced by vtkDirectory::MakeDirectory() as of VTK 5.0.

void vtkDirectory::CleanUpFilesAndPath (   )  [protected]

---

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

• dox/Common/vtkDirectory.h

---