VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkGlobFileNames Class Reference

find files that match a wildcard pattern More...

#include <vtkGlobFileNames.h>

Inheritance diagram for vtkGlobFileNames:
[legend]
Collaboration diagram for vtkGlobFileNames:
[legend]

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkGlobFileNamesNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
void Reset ()
 
virtual void SetDirectory (const char *)
 
virtual char * GetDirectory ()
 
int AddFileNames (const char *pattern)
 
virtual void SetRecurse (int)
 
virtual void RecurseOn ()
 
virtual void RecurseOff ()
 
virtual int GetRecurse ()
 
int GetNumberOfFileNames ()
 
const char * GetNthFileName (int index)
 
virtual vtkStringArrayGetFileNames ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () 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)
 
vtkCommandGetCommand (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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
int GetReferenceCount ()
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkGlobFileNamesSafeDownCast (vtkObjectBase *o)
 
static vtkGlobFileNamesNew ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
virtual void SetPattern (const char *)
 
virtual char * GetPattern ()
 
 vtkGlobFileNames ()
 
 ~vtkGlobFileNames ()
 
- 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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

find files that match a wildcard pattern

vtkGlobFileNames is a utility for finding files and directories that match a given wildcard pattern. Allowed wildcards are , ?, [...], [!...]. The "*" wildcard matches any substring, the "?" matches any single character, the [...] matches any one of the enclosed characters, e.g. [abc] will match one of a, b, or c, while [0-9] will match any digit, and [!...] will match any single character except for the ones within the brackets. Special treatment is given to "/" (or "\" on Windows) because these are path separators. These are never matched by a wildcard, they are only matched with another file separator.

Warning
This function performs case-sensitive matches on UNIX and case-insensitive matches on Windows.
See also
vtkDirectory
Tests:
vtkGlobFileNames (Tests)

Definition at line 46 of file vtkGlobFileNames.h.

Member Typedef Documentation

◆ Superclass

Return the class name as a string.

Definition at line 51 of file vtkGlobFileNames.h.

Constructor & Destructor Documentation

◆ vtkGlobFileNames()

vtkGlobFileNames::vtkGlobFileNames ( )
protected

◆ ~vtkGlobFileNames()

vtkGlobFileNames::~vtkGlobFileNames ( )
protected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual int vtkGlobFileNames::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 vtkObject.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGlobFileNames::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

◆ NewInstance()

vtkGlobFileNames* vtkGlobFileNames::NewInstance ( ) const

◆ New()

static vtkGlobFileNames* vtkGlobFileNames::New ( )
static

Create a new vtkGlobFileNames object.

◆ PrintSelf()

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

Print directory to stream.

Reimplemented from vtkObject.

◆ Reset()

void vtkGlobFileNames::Reset ( )

Reset the glob by clearing the list of output filenames.

◆ SetDirectory()

virtual void vtkGlobFileNames::SetDirectory ( const char *  )
virtual

Set the directory in which to perform the glob. If this is not set, then the current directory will be used. Also, if you use a glob pattern that contains absolute path (one that starts with "/" or a drive letter) then that absolute path will be used and Directory will be ignored.

◆ GetDirectory()

virtual char* vtkGlobFileNames::GetDirectory ( )
virtual

◆ AddFileNames()

int vtkGlobFileNames::AddFileNames ( const char *  pattern)

Search for all files that match the given expression, sort them, and add them to the output. This method can be called repeatedly to add files matching additional patterns. Returns 1 if successful, otherwise returns zero.

◆ SetRecurse()

virtual void vtkGlobFileNames::SetRecurse ( int  )
virtual

Recurse into subdirectories.

◆ RecurseOn()

virtual void vtkGlobFileNames::RecurseOn ( )
virtual

◆ RecurseOff()

virtual void vtkGlobFileNames::RecurseOff ( )
virtual

◆ GetRecurse()

virtual int vtkGlobFileNames::GetRecurse ( )
virtual

◆ GetNumberOfFileNames()

int vtkGlobFileNames::GetNumberOfFileNames ( )

Return the number of files found.

◆ GetNthFileName()

const char* vtkGlobFileNames::GetNthFileName ( int  index)

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

◆ GetFileNames()

virtual vtkStringArray* vtkGlobFileNames::GetFileNames ( )
virtual

Get an array that contains all the file names.

◆ SetPattern()

virtual void vtkGlobFileNames::SetPattern ( const char *  )
protectedvirtual

Set the wildcard pattern.

◆ GetPattern()

virtual char* vtkGlobFileNames::GetPattern ( )
protectedvirtual

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