vtkModuleWrapClientServer.cmake File Reference

Go to the source code of this file.

Functions
function	_vtk_module_wrap_client_server_sources (module, sources, classes)
	.md vtkModuleWrapClientServer More...
function	_vtk_module_wrap_client_server_library (name)
	.md INTERNAL Generating a client server library More...
function	vtk_module_wrap_client_server ()
	.md Wrapping a set of VTK modules for ClientServer More...
function	vtk_module_client_server_exclude ()
	.md Excluding a module from wrapping More...

Function Documentation

_vtk_module_wrap_client_server_sources()

function _vtk_module_wrap_client_server_sources	(	module	,
		sources	,
		classes
	)

.md

vtkModuleWrapClientServer

This module includes logic necessary in order to wrap VTK modules using ParaView's ClientServer "language". This allows for classes in the module to be used as proxies between ParaView client and server programs. .md INTERNAL

Wrapping a single module

This function generates the wrapped sources for a module. It places the list of generated source files and classes in variables named in the second and third arguments, respectively.

_vtk_module_wrap_client_server_sources(<module> <sources> <classes>)

Definition at line 28 of file vtkModuleWrapClientServer.cmake.

_vtk_module_wrap_client_server_library()

function _vtk_module_wrap_client_server_library

(

name

)

.md INTERNAL

Generating a client server library

A client server library may consist of the wrappings of multiple VTK modules. This is useful for kit-based builds where the modules part of the same kit belong to the same client server library as well.

_vtk_module_wrap_client_server_library(<name> <module>...)

The first argument is the name of the client server library. The remaining arguments are VTK modules to include in the library.

The remaining information it uses is assumed to be provided by the vtk_module_wrap_client_server function.

Definition at line 182 of file vtkModuleWrapClientServer.cmake.

vtk_module_wrap_client_server()

function vtk_module_wrap_client_server

(

)

.md

Wrapping a set of VTK modules for ClientServer

vtk_module_wrap_client_server(
  MODULES <module>...
  TARGET <target>
  [WRAPPED_MODULES <varname>]

  [FUNCTION_NAME <function>]
  [DESTINATION <destination>]

  [INSTALL_EXPORT <export>]
  [COMPONENT <component>]

  [WARNINGS <warning>...]
)

• MODULES: (Required) The list of modules to wrap.
• TARGET: (Required) The target to create which represents all wrapped ClientServer modules. This is used to provide the function used to initialize the bindings.
• WRAPPED_MODULES: (Recommended) Not all modules are wrappable. This variable will be set to contain the list of modules which were wrapped.
• FUNCTION_NAME: (Recommended) (Defaults to <TARGET>_initialize) The function name to generate in order to initialize the client server bindings.A header with the name <TARGET>.h should be included in order to access the initialization function.
• DESTINATION: (Defaults to ${CMAKE_INSTALL_LIBDIR}) Where to install the generated libraries.
• INSTALL_EXPORT: If provided, installs will add the installed libraries and generated interface target to the provided export set.
• COMPONENT: (Defaults to development) All install rules created by this function will use this installation component.
• WARNINGS: Warnings to enable. Supported warnings: empty.

Definition at line 317 of file vtkModuleWrapClientServer.cmake.

vtk_module_client_server_exclude()

function vtk_module_client_server_exclude

(

)

.md

Excluding a module from wrapping

Some modules should not be wrapped using client server bindings. Since this is independent of general wrapping facilities, an additional property is used to check. This may be set using the vtk_module_client_server_exclude function.

vtk_module_client_server_exclude(
  [MODULE <module>])

The MODULE defaults to the module currently being built. If a module is not being built when this function is called, it must be provided.

Definition at line 481 of file vtkModuleWrapClientServer.cmake.