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

utility to locate resource files. More...

#include <vtkResourceFileLocator.h>

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

Public Types

typedef vtkObject Superclass
 

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...
 
vtkResourceFileLocatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetPrintDebugInformation (bool)
 Enable/disable printing of testing of various path during Locate to stdout. More...
 
bool GetPrintDebugInformation ()
 Enable/disable printing of testing of various path during Locate to stdout. More...
 
void PrintDebugInformationOn ()
 Enable/disable printing of testing of various path during Locate to stdout. More...
 
void PrintDebugInformationOff ()
 Enable/disable printing of testing of various path during Locate to stdout. More...
 
virtual void SetLogVerbosity (int)
 The log verbosity to use when logging information about the resource searching. More...
 
virtual int GetLogVerbosity ()
 The log verbosity to use when logging information about the resource searching. More...
 
virtual std::string Locate (const std::string &anchor, const std::string &landmark, const std::string &defaultDir=std::string())
 Given a starting anchor directory, look for the landmark file relative to the anchor. More...
 
virtual std::string Locate (const std::string &anchor, const std::vector< std::string > &landmark_prefixes, const std::string &landmark, const std::string &defaultDir=std::string())
 This variant is used to look for landmark relative to the anchor using additional prefixes for the landmark file. 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkResourceFileLocatorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkResourceFileLocatorSafeDownCast (vtkObjectBase *o)
 
static std::string GetLibraryPathForSymbolUnix (const char *symbolname)
 Returns the name of the library providing the symbol. More...
 
static std::string GetLibraryPathForSymbolWin32 (const void *fptr)
 Returns the name of the library providing the symbol. 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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
 
 vtkResourceFileLocator ()
 
 ~vtkResourceFileLocator () 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- 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

utility to locate resource files.

VTK based application often need to locate resource files, such configuration files, Python modules, etc. vtkResourceFileLocator provides methods that can be used to locate such resource files at runtime.

Using Locate, one can locate files relative to an anchor directory such as the executable directory, or the library directory.

GetLibraryPathForSymbolUnix and GetLibraryPathForSymbolWin32 methods can be used to locate the library that provides a particular symbol. For example, this is used by vtkPythonInterpreter to ensure that the vtk Python package is located relative the VTK libraries, irrespective of the application location.

Definition at line 41 of file vtkResourceFileLocator.h.

Member Typedef Documentation

Definition at line 45 of file vtkResourceFileLocator.h.

Constructor & Destructor Documentation

vtkResourceFileLocator::vtkResourceFileLocator ( )
protected
vtkResourceFileLocator::~vtkResourceFileLocator ( )
overrideprotected

Member Function Documentation

static vtkResourceFileLocator* vtkResourceFileLocator::New ( )
static
static vtkTypeBool vtkResourceFileLocator::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkResourceFileLocator::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.

static vtkResourceFileLocator* vtkResourceFileLocator::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkResourceFileLocator::NewInstanceInternal ( ) const
protectedvirtual
vtkResourceFileLocator* vtkResourceFileLocator::NewInstance ( ) const
void vtkResourceFileLocator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

void vtkResourceFileLocator::SetPrintDebugInformation ( bool  )

Enable/disable printing of testing of various path during Locate to stdout.

Deprecated:
Instead use SetLogVerbosity to specify the verbosity at which this instance should log trace information. Default is vtkLogger::VERBOSITY_TRACE.
bool vtkResourceFileLocator::GetPrintDebugInformation ( )

Enable/disable printing of testing of various path during Locate to stdout.

Deprecated:
Instead use SetLogVerbosity to specify the verbosity at which this instance should log trace information. Default is vtkLogger::VERBOSITY_TRACE.
void vtkResourceFileLocator::PrintDebugInformationOn ( )

Enable/disable printing of testing of various path during Locate to stdout.

Deprecated:
Instead use SetLogVerbosity to specify the verbosity at which this instance should log trace information. Default is vtkLogger::VERBOSITY_TRACE.
void vtkResourceFileLocator::PrintDebugInformationOff ( )

Enable/disable printing of testing of various path during Locate to stdout.

Deprecated:
Instead use SetLogVerbosity to specify the verbosity at which this instance should log trace information. Default is vtkLogger::VERBOSITY_TRACE.
virtual void vtkResourceFileLocator::SetLogVerbosity ( int  )
virtual

The log verbosity to use when logging information about the resource searching.

Default is vtkLogger::VERBOSITY_TRACE.

virtual int vtkResourceFileLocator::GetLogVerbosity ( )
virtual

The log verbosity to use when logging information about the resource searching.

Default is vtkLogger::VERBOSITY_TRACE.

virtual std::string vtkResourceFileLocator::Locate ( const std::string &  anchor,
const std::string &  landmark,
const std::string &  defaultDir = std::string() 
)
virtual

Given a starting anchor directory, look for the landmark file relative to the anchor.

If found return the anchor. If not found, go one directory up and then look the landmark file again.

virtual std::string vtkResourceFileLocator::Locate ( const std::string &  anchor,
const std::vector< std::string > &  landmark_prefixes,
const std::string &  landmark,
const std::string &  defaultDir = std::string() 
)
virtual

This variant is used to look for landmark relative to the anchor using additional prefixes for the landmark file.

For example, if you're looking for vtk/__init__.py, but it can be placed relative to your anchor location (let's say the executable directory), under "lib" or "lib/python", then use this variant with "lib", and "lib/python" passed in as the landmark prefixes. On success, the returned value will be anchor + matching prefix.

static std::string vtkResourceFileLocator::GetLibraryPathForSymbolUnix ( const char *  symbolname)
static

Returns the name of the library providing the symbol.

For example, if you want to locate where the VTK libraries located call GetLibraryPathForSymbolUnix("GetVTKVersion") on Unixes and GetLibraryPathForSymbolWin32(GetVTKVersion) on Windows. Alternatively, you can simply use the vtkGetLibraryPathForSymbol(GetVTKVersion) macro that makes the appropriate call as per the current platform.

static std::string vtkResourceFileLocator::GetLibraryPathForSymbolWin32 ( const void *  fptr)
static

Returns the name of the library providing the symbol.

For example, if you want to locate where the VTK libraries located call GetLibraryPathForSymbolUnix("GetVTKVersion") on Unixes and GetLibraryPathForSymbolWin32(GetVTKVersion) on Windows. Alternatively, you can simply use the vtkGetLibraryPathForSymbol(GetVTKVersion) macro that makes the appropriate call as per the current platform.


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