VTK
|
OS independent class for access and manipulation of system directories. More...
#include <vtkDirectory.h>
Public Types | |
typedef vtkObject | Superclass |
Return the class name as a string. More... | |
Public Member Functions | |
virtual int | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkDirectory * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Print directory to stream. More... | |
int | Open (const char *dir) |
Open the specified directory and load the names of the files in that directory. More... | |
vtkIdType | GetNumberOfFiles () |
Return the number of files in the current directory. More... | |
const char * | GetFile (vtkIdType index) |
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 vtkStringArray * | GetFiles () |
Get an array that contains all the file names. More... | |
![]() | |
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) |
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) |
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) |
![]() | |
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 int | IsTypeOf (const char *type) |
static vtkDirectory * | SafeDownCast (vtkObjectBase *o) |
static vtkDirectory * | New () |
Create a new vtkDirectory object. More... | |
static const char * | GetCurrentWorkingDirectory (char *buf, unsigned int len) |
Get the current working directory. More... | |
static int | MakeDirectory (const char *dir) |
Create directory. More... | |
static int | DeleteDirectory (const char *dir) |
Remove a directory. More... | |
static int | Rename (const char *oldname, const char *newname) |
Rename a file or directory. More... | |
![]() | |
static vtkObject * | New () |
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 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 vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
void | CleanUpFilesAndPath () |
vtkDirectory () | |
~vtkDirectory () override | |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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.
Definition at line 34 of file vtkDirectory.h.
typedef vtkObject vtkDirectory::Superclass |
Return the class name as a string.
Definition at line 41 of file vtkDirectory.h.
|
protected |
|
overrideprotected |
|
static |
|
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.
|
static |
|
protectedvirtual |
vtkDirectory* vtkDirectory::NewInstance | ( | ) | const |
|
static |
Create a new vtkDirectory object.
|
overridevirtual |
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 |
Get an array that contains all the file names.
|
static |
Get the current working directory.
|
static |
Create directory.
|
static |
Remove a directory.
|
static |
Rename a file or directory.
|
protected |