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
 Return the class name as a string. More...
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkGlobFileNamesNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Print directory to stream. More...
 
void Reset ()
 Reset the glob by clearing the list of output filenames. More...
 
virtual void SetDirectory (const char *)
 Set the directory in which to perform the glob. More...
 
virtual char * GetDirectory ()
 
int AddFileNames (const char *pattern)
 Search for all files that match the given expression, sort them, and add them to the output. More...
 
virtual void SetRecurse (vtkTypeBool)
 Recurse into subdirectories. More...
 
virtual void RecurseOn ()
 
virtual void RecurseOff ()
 
virtual vtkTypeBool GetRecurse ()
 
int GetNumberOfFileNames ()
 Return the number of files found. More...
 
const char * GetNthFileName (int index)
 Return the file at the given index, the indexing is 0 based. More...
 
virtual vtkStringArrayGetFileNames ()
 Get an array that contains all the file names. More...
 
- Public Member Functions inherited from vtkObject
 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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
- Public Member Functions inherited from vtkObjectBase
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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkGlobFileNamesSafeDownCast (vtkObjectBase *o)
 
static vtkGlobFileNamesNew ()
 Create a new vtkGlobFileNames object. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
virtual void SetPattern (const char *)
 Set the wildcard pattern. More...
 
virtual char * GetPattern ()
 
 vtkGlobFileNames ()
 
 ~vtkGlobFileNames () 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. More...
 
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
std::atomic< int32_t > 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 47 of file vtkGlobFileNames.h.

Member Typedef Documentation

◆ Superclass

Return the class name as a string.

Definition at line 54 of file vtkGlobFileNames.h.

Constructor & Destructor Documentation

◆ vtkGlobFileNames()

vtkGlobFileNames::vtkGlobFileNames ( )
protected

◆ ~vtkGlobFileNames()

vtkGlobFileNames::~vtkGlobFileNames ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGlobFileNames::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkGlobFileNames* vtkGlobFileNames::NewInstance ( ) const

◆ New()

static vtkGlobFileNames* vtkGlobFileNames::New ( )
static

Create a new vtkGlobFileNames object.

◆ PrintSelf()

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

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 ( vtkTypeBool  )
virtual

Recurse into subdirectories.

◆ RecurseOn()

virtual void vtkGlobFileNames::RecurseOn ( )
virtual

◆ RecurseOff()

virtual void vtkGlobFileNames::RecurseOff ( )
virtual

◆ GetRecurse()

virtual vtkTypeBool 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: