VTK  9.3.20240614
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkDeserializer Class Reference

Deserialize VTK objects from JSON. More...

#include <vtkDeserializer.h>

Inheritance diagram for vtkDeserializer:
[legend]
Collaboration diagram for vtkDeserializer:
[legend]

Public Types

typedef vtkObject Superclass
 
using HandlerType = std::function< void(const nlohmann::json &, vtkObjectBase *, vtkDeserializer *)>
 
using ConstructorType = std::function< vtkObjectBase *()>
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkDeserializerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkObjectBaseConstructObject (const std::string &className, const std::vector< std::string > &superClassNames)
 Constructs an object of type className.
 
bool DeserializeJSON (const vtkTypeUInt32 &identifier, vtkSmartPointer< vtkObjectBase > &objectBase)
 Deserialize a state registered with the context at identifier into objectBase.
 
void RegisterConstructor (const std::string &className, ConstructorType constructor)
 The constructors are invoked to construct an instance of className.
 
ConstructorType GetConstructor (const std::string &className, const std::vector< std::string > &superClassNames)
 The constructors are invoked to construct an instance of className.
 
void UnRegisterConstructor (const std::string &className)
 The constructors are invoked to construct an instance of className.
 
void RegisterHandler (const std::type_info &type, HandlerType deserializer)
 The handlers are invoked to deserialize a json state into a vtkObjectBase derived instance of type type.
 
HandlerType GetHandler (const std::type_info &type) const
 The handlers are invoked to deserialize a json state into a vtkObjectBase derived instance of type type.
 
bool UnRegisterHandler (const std::type_info &type)
 The handlers are invoked to deserialize a json state into a vtkObjectBase derived instance of type type.
 
 vtkSetSmartPointerMacro (Context, vtkMarshalContext)
 Get/Set the marshalling context.
 
 vtkGetSmartPointerMacro (Context, vtkMarshalContext)
 Get/Set the marshalling context.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkDeserializerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDeserializerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDeserializer ()
 
 ~vtkDeserializer () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkMarshalContextContext
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Deserialize VTK objects from JSON.

Definition at line 26 of file vtkDeserializer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 30 of file vtkDeserializer.h.

◆ HandlerType

using vtkDeserializer::HandlerType = std::function<void(const nlohmann::json&, vtkObjectBase*, vtkDeserializer*)>

Definition at line 33 of file vtkDeserializer.h.

◆ ConstructorType

Definition at line 34 of file vtkDeserializer.h.

Constructor & Destructor Documentation

◆ vtkDeserializer()

vtkDeserializer::vtkDeserializer ( )
protected

◆ ~vtkDeserializer()

vtkDeserializer::~vtkDeserializer ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkDeserializer * vtkDeserializer::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkDeserializer::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkDeserializer::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkDeserializer * vtkDeserializer::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDeserializer::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkDeserializer * vtkDeserializer::NewInstance ( ) const

◆ PrintSelf()

void vtkDeserializer::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObjectBase.

◆ ConstructObject()

vtkObjectBase * vtkDeserializer::ConstructObject ( const std::string &  className,
const std::vector< std::string > &  superClassNames 
)

Constructs an object of type className.

If a constructor is not found for className, the GetConstructor walks through each item in superClassNames and attempts to contruct an instance of that type. This is useful when the VTK build of the serializer side and the deserializer side are on entirely different platforms by taking advantage of the object factory mechanism.

Example of usefulness of superClassNames:

Let's suppose in a Windows VTK application, the vtkSerializer serialized an instance of vtkWin32RenderWindowInteractor into json which was then transferred over the network to a macOS machine. Over there, seeing that the state refers to the vtkWin32RenderWindowInteractor calss the vtkDeserializer will attempt to find a constructor for win32 class and fail. It then checks if the super class (here vtkRenderWindowInteractor) has a constructor and constructs a new instance of that type. Due to the object factory mechanism, the macOS build of VTK constructs a vtkCocoaRenderWindowInteractor and it all works as expected!

◆ DeserializeJSON()

bool vtkDeserializer::DeserializeJSON ( const vtkTypeUInt32 &  identifier,
vtkSmartPointer< vtkObjectBase > &  objectBase 
)

Deserialize a state registered with the context at identifier into objectBase.

This function lets you pass a non-null object into objectBase typically obtained from vtkMarshalContext::GetObjectAtId. In that case, the constructor is not invoked. Otherwise, a new object will be constructed and available in objectBase.

This method returns true if the state was successfully deserialized and false when an error occurs. This method returns true if the state was already deserialized into an object.

◆ RegisterConstructor()

void vtkDeserializer::RegisterConstructor ( const std::string &  className,
ConstructorType  constructor 
)

The constructors are invoked to construct an instance of className.

Note
If className does not have a registered constructor, the deserializer will print a stack trace to help you understand the reason for failure.

◆ GetConstructor()

ConstructorType vtkDeserializer::GetConstructor ( const std::string &  className,
const std::vector< std::string > &  superClassNames 
)

The constructors are invoked to construct an instance of className.

Note
If className does not have a registered constructor, the deserializer will print a stack trace to help you understand the reason for failure.

◆ UnRegisterConstructor()

void vtkDeserializer::UnRegisterConstructor ( const std::string &  className)

The constructors are invoked to construct an instance of className.

Note
If className does not have a registered constructor, the deserializer will print a stack trace to help you understand the reason for failure.

◆ RegisterHandler()

void vtkDeserializer::RegisterHandler ( const std::type_info &  type,
HandlerType  deserializer 
)

The handlers are invoked to deserialize a json state into a vtkObjectBase derived instance of type type.

Note
If a class does not have a handler, this class will print a stack trace to help you understand the reason for failure.

◆ GetHandler()

HandlerType vtkDeserializer::GetHandler ( const std::type_info &  type) const

The handlers are invoked to deserialize a json state into a vtkObjectBase derived instance of type type.

Note
If a class does not have a handler, this class will print a stack trace to help you understand the reason for failure.

◆ UnRegisterHandler()

bool vtkDeserializer::UnRegisterHandler ( const std::type_info &  type)

The handlers are invoked to deserialize a json state into a vtkObjectBase derived instance of type type.

Note
If a class does not have a handler, this class will print a stack trace to help you understand the reason for failure.

◆ vtkSetSmartPointerMacro()

vtkDeserializer::vtkSetSmartPointerMacro ( Context  ,
vtkMarshalContext   
)

Get/Set the marshalling context.

The vtkDeserializer does not track state of any object. However, it leverages the context to prevent re-deserialization when there are circular dependencies among the VTK objects. The context does much more than just preventing recursive de-serialization. The deserializer records parent-child relationships in the context using it's ScopedParentTracker API.

◆ vtkGetSmartPointerMacro()

vtkDeserializer::vtkGetSmartPointerMacro ( Context  ,
vtkMarshalContext   
)

Get/Set the marshalling context.

The vtkDeserializer does not track state of any object. However, it leverages the context to prevent re-deserialization when there are circular dependencies among the VTK objects. The context does much more than just preventing recursive de-serialization. The deserializer records parent-child relationships in the context using it's ScopedParentTracker API.

Member Data Documentation

◆ Context

vtkSmartPointer<vtkMarshalContext> vtkDeserializer::Context
protected

Definition at line 115 of file vtkDeserializer.h.


The documentation for this class was generated from the following file: