ParaViewServerManager.cmake File Reference

Go to the source code of this file.

Functions
function	paraview_add_server_manager_xmls ()
	.md Server Manager XMLs More...
function	paraview_server_manager_process ()
	.md Building XML files More...
function	paraview_server_manager_process_files ()
	.md The second way to process XML files directly. More...

Function Documentation

paraview_add_server_manager_xmls()

function paraview_add_server_manager_xmls

(

)

.md

Server Manager XMLs

ParaView uses XML files to describe filters available in its user interface. Modules may add filters to the UI by providing XML files.

TODO: Document the ServerManager XML format. .md

Adding XMLs to modules

Modules may have associated XML files. They can be added to the module target using this function.

paraview_add_server_manager_xmls(
  XMLS <xml>...)

Definition at line 24 of file ParaViewServerManager.cmake.

paraview_server_manager_process()

function paraview_server_manager_process

(

)

.md

Building XML files

There are two functions offered to build server manager XML files. The first uses modules:

paraview_server_manager_process(
  MODULES <module>...
  TARGET <target>
  [INSTALL_EXPORT <export>]
  [FILES <file>...]
  [XML_FILES  <variable>]
  [TRANSLATIONS_DIRECTORY <directory>]
  [TRANSLATIONS_TARGET <target>])

The MODULES argument contains the modules to include in the server manager target. The function gathers the XML files declared using paraview_add_server_manager_xmls and then calls paraview_server_manager_process_files. If additional, non-module related XML files are required, they may be passed via FILES.

If XML_FILES is given, the list of process XML files are set on the given variable.

If INSTALL_EXPORT is given, the interface target will be added to the given export set.

Definition at line 86 of file ParaViewServerManager.cmake.

paraview_server_manager_process_files()

function paraview_server_manager_process_files

(

)

.md The second way to process XML files directly.

paraview_server_manager_process_files(
  FILES <file>...
  TARGET <target>
  [INSTALL_EXPORT <export>])

The files passed to the FILES argument will be processed in to functions which are then consumed by ParaView applications.

The name of the target is given to the TARGET argument. By default, the filename is <TARGET>.h and it contains a function named <TARGET>_initialize. They may be changed using the FILE_NAME and FUNCTION_NAME arguments. The target has an interface usage requirement that will allow the generated header to be included.

If INSTALL_EXPORT is given, the interface target will be added to the given export set.

Definition at line 248 of file ParaViewServerManager.cmake.