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
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkArchiver.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm 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 vtkPythonArchiver
* @brief A version of vtkArchiver that can be implemented in Python
*
* vtkPythonArchiver is an implementation of vtkArchiver that calls a Python
* object to do the actual work.
* It defers the following methods to Python:
* - OpenArchive()
* - CloseArchive()
* - InsertIntoArchive()
* - Contains()
*
* Python signature of these methods is as follows:
* - OpenArchive(self, vtkself) : vtkself is the vtk object
* - CloseArchive(self, vtkself)
* - InsertIntoArchive(self, vtkself, relativePath, data, size)
* - Contains()
*
* @sa
* vtkPythonArchiver
*/
#ifndef vtkPythonArchiver_h
#define vtkPythonArchiver_h
#if !defined(__VTK_WRAP__) || defined(__VTK_WRAP_HIERARCHY__) || defined(__VTK_WRAP_PYTHON__)
#include "vtkPython.h" // Must be first
#include "vtkArchiver.h"
#include "vtkCommonPythonModule.h" // For export macro
VTK_ABI_NAMESPACE_BEGIN
class vtkSmartPyObject;
class VTKCOMMONPYTHON_EXPORT vtkPythonArchiver : public vtkArchiver
{
public:
static vtkPythonArchiver* New();
vtkTypeMacro(vtkPythonArchiver, vtkArchiver);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Specify the Python object to use to perform the archiving. A reference will
* be taken on the object.
*/
void SetPythonObject(PyObject* obj);
///@{
/**
* Open the archive for writing.
*/
void OpenArchive() override;
///@}
///@{
/**
* Close the archive.
*/
void CloseArchive() override;
///@}
///@{
/**
* Insert \p data of size \p size into the archive at \p relativePath.
*/
void InsertIntoArchive(
const std::string& relativePath, const char* data, std::size_t size) override;
///@}
///@{
/**
* Checks if \p relativePath represents an entry in the archive.
*/
bool Contains(const std::string& relativePath) override;
///@}
protected:
vtkPythonArchiver();
~vtkPythonArchiver() override;
private:
vtkPythonArchiver(const vtkPythonArchiver&) = delete;
void operator=(const vtkPythonArchiver&) = delete;
int CheckResult(const char* method, const vtkSmartPyObject& res);
PyObject* Object;
};
VTK_ABI_NAMESPACE_END
#endif
#endif
|
