helper to help reload a reader.
More...
#include <vtkSMReaderReloadHelper.h>
Inherits vtkObject.
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 36 of file vtkSMReaderReloadHelper.h.
◆ Superclass
◆ vtkSMReaderReloadHelper()
vtkSMReaderReloadHelper::vtkSMReaderReloadHelper |
( |
| ) |
|
|
protected |
◆ ~vtkSMReaderReloadHelper()
vtkSMReaderReloadHelper::~vtkSMReaderReloadHelper |
( |
| ) |
|
|
protected |
◆ New()
◆ 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 |
◆ SafeDownCast()
◆ PrintSelf()
void vtkSMReaderReloadHelper::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
| |
◆ 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()
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: