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

helper to help reload a reader. More...

#include <vtkSMReaderReloadHelper.h>

Inheritance diagram for vtkSMReaderReloadHelper:
Inheritance graph
[legend]
Collaboration diagram for vtkSMReaderReloadHelper:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual bool SupportsReload (vtkSMSourceProxy *proxy)
 Returns true if its possible to reload data files for the given proxy i.e. More...
 
virtual bool SupportsFileSeries (vtkSMSourceProxy *proxy)
 Returns true if the reader supports file series. More...
 
virtual bool ReloadFiles (vtkSMSourceProxy *proxy)
 Make the reader reload its data file(s). More...
 
virtual bool ExtendFileSeries (vtkSMSourceProxy *proxy)
 Attempts to find more files in a file series specified on the reader proxy and all those files to the reader. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkSMReaderReloadHelperNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMReaderReloadHelperSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMReaderReloadHelper ()
 
 ~vtkSMReaderReloadHelper () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
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

helper to help reload a reader.

vtkSMReaderReloadHelper helps make a reader reload its files. There are two ways of reloading: reload existing data files, or extend the file series with any new files that are now available. This class supports both. Use vtkSMReaderReloadHelper::ReloadFiles() to reload existing files (potentially using a specific property on the reader proxy for reloading, if available). Use vtkSMReaderReloadHelper::ExtendFileSeries() to detect new files in a file series and update the reader to use those.

Definition at line 24 of file vtkSMReaderReloadHelper.h.

Member Typedef Documentation

◆ Superclass

Definition at line 28 of file vtkSMReaderReloadHelper.h.

Constructor & Destructor Documentation

◆ vtkSMReaderReloadHelper()

vtkSMReaderReloadHelper::vtkSMReaderReloadHelper ( )
protected

◆ ~vtkSMReaderReloadHelper()

vtkSMReaderReloadHelper::~vtkSMReaderReloadHelper ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMReaderReloadHelper* vtkSMReaderReloadHelper::New ( )
static

◆ GetClassName()

virtual const char* vtkSMReaderReloadHelper::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

virtual int vtkSMReaderReloadHelper::IsA ( const char *  type)
virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkSMReaderReloadHelper* vtkSMReaderReloadHelper::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

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

Reimplemented from vtkObject.

◆ SupportsReload()

virtual bool vtkSMReaderReloadHelper::SupportsReload ( vtkSMSourceProxy proxy)
virtual

Returns true if its possible to reload data files for the given proxy i.e.

checks if the proxy is a reader. If not, returns false.

◆ SupportsFileSeries()

virtual bool vtkSMReaderReloadHelper::SupportsFileSeries ( vtkSMSourceProxy proxy)
virtual

Returns true if the reader supports file series.

◆ ReloadFiles()

virtual bool vtkSMReaderReloadHelper::ReloadFiles ( vtkSMSourceProxy proxy)
virtual

Make the reader reload its data file(s).

If a reader supports API to support such reloads in a smart way, then the reader proxy should use the <ReloadFiles /> hint to name the property. In that case, this method will use that property. Otherwise, it will use vtkSMProxy::RecreateVTKObjects() to simply recreate the VTK object and update its state.

◆ ExtendFileSeries()

virtual bool vtkSMReaderReloadHelper::ExtendFileSeries ( vtkSMSourceProxy proxy)
virtual

Attempts to find more files in a file series specified on the reader proxy and all those files to the reader.

This should be called only when IsFileSeriesCapable() returns true.


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