vtkModuleSerialization#

vtk_module_generate_library_serdes_registrar#

Generate functions that register (de)serialization functions for all classes in a library. module-serialization

vtk_module_generate_library_serdes_registrar(
  MODULE             <module>
  EXPORT_MACRO_NAME  <export_macro_name>
  EXPORT_FILE_NAME   <export_file_name>
  REGISTRAR_HEADER   <registrar_header>
  REGISTRAR_SOURCE   <registrar_source>
  CLASSES            <class>...)

Declares registrar function for MODULE in REGISTRAR_HEADER and writes implementation of the registrar in REGISTRAR_SOURCE.

  • MODULE: The name of a module.

  • EXPORT_MACRO_NAME: The name of the export macro for MODULE.

  • EXPORT_FILE_NAME: The name of the header file which defines EXPORT_MACRO_NAME for MODULE.

  • REGISTRAR_HEADER: This file will hold the declaration of regsitrar function for MODULE.

  • REGISTRAR_SOURCE: This file will contain the implementation of regsitrar function for MODULE.

  • CLASSES: List of classes that will be registered with (de)serializer in this library.

vtk_module_generate_libraries_serdes_registrar#

Generate functions that register (de)serialization handlers for a collection of modules. module-serialization

vtk_module_generate_libraries_serdes_registrar(
  REGISTRAR_NAME     <registrar_name>
  REGISTRAR_SOURCE   <registrar_source>
  [MANDATORY_MODULES  <module>...]
  [OPTIONAL_MODULES   <module>...])

Invokes registrar functions for all modules from OPTIONAL_MODULES and MANDATORY_MODULES. Code is generated in REGISTRAR_SOURCE.

  • REGISTRAR_NAME: The name of the registrar function.

  • REGISTRAR_SOURCE: This file will contain the implementation of regsitrar function which registers handlers for all MANDATORY_MODULES and OPTIONAL_MODULES.

  • MANDATORY_MODULES: A list of PUBLIC or PRIVATE dependencies of the module which REGISTRAR_SOURCE is compiled into.

  • OPTIONAL_MODULES: A list of optional dependencies of the module which REGISTRAR_SOURCE is compiled into.

_vtk_module_serdes_generate_sources#

Generate (de)serialization functions for classes that belong to MODULE in SERDES_SOURCES. module-serialization

_vtk_module_serdes_generate_sources(
  MODULE              <module>
  SERIALIZED_CLASSES  <serialzied_classes>
  SERDES_SOURCES      <serdes_sources>)

  • MODULE: Generates serialization sources for all classes in MODULE

  • SERIALIZED_CLASSES: This variable will contain the list of all classes that were serialized.

  • SERDES_SOURCES: This variable will contain the list of all sources that were generated for SERIALIZED_CLASSES in MODULE.

vtk_module_serdes#

Generate (de)serialization code for all classes in a MODULE. module-serialization

vtk_module_serdes(
  MODULE            <module>
  EXPORT_MACRO_NAME <export_macro_name>
  EXPORT_FILE_NAME  <export_file_name>
  REGISTRAR_HEADER  <header>
  REGISTRAR_SOURCE  <source>
  SERDES_SOURCES    <serdes_sources>)

  • MODULE: The name of a module.

  • EXPORT_MACRO_NAME: The name of the export macro for MODULE.

  • EXPORT_FILE_NAME: The name of the header file which defines EXPORT_MACRO_NAME for MODULE.

  • REGISTRAR_HEADER: This file will contain declaration of regsitrar function for MODULE.

  • REGISTRAR_SOURCE: This file will contain implementation of regsitrar function for MODULE.

  • SERDES_SOURCES: This variable holds the list of generated source files with vtkWrapSerDes for all classes in MODULE.