1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
/*=========================================================================
Program: ParaView
Module: vtkSMReaderReloadHelper.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkSMReaderReloadHelper
* @brief 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.
*/
#ifndef vtkSMReaderReloadHelper_h
#define vtkSMReaderReloadHelper_h
#include "vtkObject.h"
#include "vtkPVServerManagerDefaultModule.h" //needed for exports
class vtkSMSourceProxy;
class VTKPVSERVERMANAGERDEFAULT_EXPORT vtkSMReaderReloadHelper : public vtkObject
{
public:
static vtkSMReaderReloadHelper* New();
vtkTypeMacro(vtkSMReaderReloadHelper, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* 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.
*/
virtual bool SupportsReload(vtkSMSourceProxy* proxy);
/**
* Returns true if the reader supports file series.
*/
virtual bool SupportsFileSeries(vtkSMSourceProxy* proxy);
/**
* 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.
*/
virtual bool ReloadFiles(vtkSMSourceProxy* proxy);
/**
* 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.
*/
virtual bool ExtendFileSeries(vtkSMSourceProxy* proxy);
protected:
vtkSMReaderReloadHelper();
~vtkSMReaderReloadHelper();
private:
vtkSMReaderReloadHelper(const vtkSMReaderReloadHelper&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMReaderReloadHelper&) VTK_DELETE_FUNCTION;
};
#endif
|
