VTK  9.4.20250107
vtkPythonArchiver.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
28#ifndef vtkPythonArchiver_h
29#define vtkPythonArchiver_h
30#if !defined(__VTK_WRAP__) || defined(__VTK_WRAP_HIERARCHY__) || defined(__VTK_WRAP_PYTHON__)
31
32#include "vtkPython.h" // Must be first
33
34#include "vtkArchiver.h"
35#include "vtkCommonPythonModule.h" // For export macro
36
37VTK_ABI_NAMESPACE_BEGIN
38class vtkSmartPyObject;
39
40class VTKCOMMONPYTHON_EXPORT vtkPythonArchiver : public vtkArchiver
41{
42public:
45 void PrintSelf(ostream& os, vtkIndent indent) override;
46
52
54
57 void OpenArchive() override;
59
61
64 void CloseArchive() override;
66
68
72 const std::string& relativePath, const char* data, std::size_t size) override;
74
76
79 bool Contains(const std::string& relativePath) override;
81
82protected:
85
86private:
87 vtkPythonArchiver(const vtkPythonArchiver&) = delete;
88 void operator=(const vtkPythonArchiver&) = delete;
89
90 int CheckResult(const char* method, const vtkSmartPyObject& res);
91
92 PyObject* Object;
93};
94
95VTK_ABI_NAMESPACE_END
96#endif
97#endif
Writes an archive.
Definition vtkArchiver.h:29
a simple class to control print indentation
Definition vtkIndent.h:108
A version of vtkArchiver that can be implemented in Python.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
bool Contains(const std::string &relativePath) override
Checks if relativePath represents an entry in the archive.
void InsertIntoArchive(const std::string &relativePath, const char *data, std::size_t size) override
Insert data of size size into the archive at relativePath.
~vtkPythonArchiver() override
static vtkPythonArchiver * New()
void SetPythonObject(PyObject *obj)
Specify the Python object to use to perform the archiving.
void OpenArchive() override
Open the archive for writing.
void CloseArchive() override
Close the archive.
struct _object PyObject