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
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkSerializer
* @brief Serialize VTK objects to JSON.
*/
#ifndef vtkSerializer_h
#define vtkSerializer_h
#include "vtkObject.h"
#include "vtkCommonCoreModule.h" // for export macro
#include "vtkLogger.h" // for vtkLogger::Verbosity enum
#include "vtkMarshalContext.h" // for vtkMarshalContext
#include "vtkSmartPointer.h" // for vktSmartPointer
// clang-format off
#include "vtk_nlohmannjson.h" // for json
#include VTK_NLOHMANN_JSON(json.hpp) // for json
// clang-format on
#include <memory> // for unique_ptr
#include <typeinfo> // for type_info
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONCORE_EXPORT vtkSerializer : public vtkObject
{
public:
static vtkSerializer* New();
vtkTypeMacro(vtkSerializer, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) override;
using HandlerType = std::function<nlohmann::json(vtkObjectBase*, vtkSerializer*)>;
/**
* Serialize the VTK object
*/
nlohmann::json SerializeJSON(vtkObjectBase* objectBase);
///@{
/**
* The handlers are invoked to serialize an object of type `type`.
*
* @note
* If `type` does not have a handler, the serializer will
* print a stack trace to help you understand the reason for failure.
*/
void RegisterHandler(const std::type_info& type, HandlerType handler);
HandlerType GetHandler(const std::type_info& type) const;
bool UnRegisterHandler(const std::type_info& type);
///@}
///@{
/**
* Get/Set the marshalling context.
* The vtkSerializer does not track state of any object.
* However, it leverages the context to prevent re-serialization
* when there are circular dependencies among VTK objects.
* The context does much more than just preventing recursive serialization.
* The serializer records parent-child relationships
* in the context using it's ScopedParentTracker API.
*/
vtkSetSmartPointerMacro(Context, vtkMarshalContext);
vtkGetSmartPointerMacro(Context, vtkMarshalContext);
///@}
///@{
/**
* Set/Get the log verbosity of messages that are emitted when data is uploaded to GPU memory.
* The GetSerializerLogVerbosity looks up system environment for
* `VTK_SERIALIZER_LOG_VERBOSITY` that shall be used to set initial logger verbosity. The
* default value is TRACE.
*
* Accepted string values are OFF, ERROR, WARNING, INFO, TRACE, MAX, INVALID or ASCII
* representation for an integer in the range [-9,9].
*
* @note This method internally uses vtkLogger::ConvertToVerbosity(const char*) to parse the
* value from environment variable.
*/
void SetSerializerLogVerbosity(vtkLogger::Verbosity verbosity);
vtkLogger::Verbosity GetSerializerLogVerbosity();
///@}
protected:
vtkSerializer();
~vtkSerializer() override;
vtkSmartPointer<vtkMarshalContext> Context;
vtkLogger::Verbosity SerializerLogVerbosity = vtkLogger::VERBOSITY_INVALID;
private:
vtkSerializer(const vtkSerializer&) = delete;
void operator=(const vtkSerializer&) = delete;
class vtkInternals;
std::unique_ptr<vtkInternals> Internals;
};
VTK_ABI_NAMESPACE_END
#endif
|
