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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*=========================================================================
Program: ParaView
Module: vtkSMLoadStateOptionsProxy.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 vtkSMLoadStateOptionsProxy
* @brief proxy for managing data files when loading a state file.
*
*
* vtkSMLoadStateOptionsProxy provides a dialog to allow a user to change the
* locations of data files when loading a state file. The user can give a directory
* where the data files reside or explicitly change the path for each data file.
*/
#ifndef vtkSMLoadStateOptionsProxy_h
#define vtkSMLoadStateOptionsProxy_h
#include "vtkNew.h" // for vtkNew
#include "vtkPVServerManagerDefaultModule.h" //needed for exports
#include "vtkSMProxy.h"
#include <vector> // needed for std::vector
class VTKPVSERVERMANAGERDEFAULT_EXPORT vtkSMLoadStateOptionsProxy : public vtkSMProxy
{
public:
static vtkSMLoadStateOptionsProxy* New();
vtkTypeMacro(vtkSMLoadStateOptionsProxy, vtkSMProxy);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Set the state file to load. This may read the file and collect information
* about the file. Returns false if the filename is invalid or cannot be read.
*/
virtual bool PrepareToLoad(const char* statefilename);
/**
* Check if state file has any data files.
* @returns whether the state file refers to any data files to be loaded.
*/
virtual bool HasDataFiles();
/**
* Do the state loading.
*/
virtual bool Load();
enum
{
USE_FILES_FROM_STATE = 0,
USE_DATA_DIRECTORY = 1,
CHOOSE_FILES_EXPLICITLY = 2
};
vtkSetClampMacro(DataFileOptions, int, USE_FILES_FROM_STATE, CHOOSE_FILES_EXPLICITLY);
vtkSetMacro(OnlyUseFilesInDataDirectory, bool);
protected:
vtkSMLoadStateOptionsProxy();
~vtkSMLoadStateOptionsProxy();
/**
* Locates the files in the user specified directory and updates the paths
* in the state file XML. If the clearFilenameIfNotFound option is set to true
* it will set the filenames that are not in the directory to empty string
* rather than leave them as the filenames from the state file XML.
*
* @returns false if any of the files were not found
*/
bool LocateFilesInDirectory(std::vector<std::string>& filepaths, bool clearFilenameIfNotFound);
vtkSetStringMacro(StateFileName);
char* StateFileName;
/**
* The three options for how to specify the data file locations.
*/
int DataFileOptions;
/**
* When the number of parent directories for a file series reaches this number assume it will
* match for the rest of the file series.
*/
int PathMatchingThreshold;
/**
* When this is set to true, USE_DATA_DIRECTORY mode will fail when a file is not in the
* data directory rather than defaulting back to the absolute path in the state file.
*/
bool OnlyUseFilesInDataDirectory;
private:
class vtkInternals;
vtkInternals* Internals;
vtkSMLoadStateOptionsProxy(const vtkSMLoadStateOptionsProxy&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMLoadStateOptionsProxy&) VTK_DELETE_FUNCTION;
};
#endif
|
