Module Metadata

The metadata are standard parameter files which can be opened by the class ParameterFile.

You can edit these files via text editor or, more confortable with the object inspector paraminspektor(.exe) .

Object description

If you want to use a class (node type) it in this project, you have to provide information about input/output slots and the configurable parameters. Multiple objects send their results to each other via these slots. Connected slots have to be of the same data type, so this type has also to be specified.

Required parameters

• inputs: list of input slots
• output: list of output slots
• parameters: list of configurable parameters

If an object has no inputs or outputs, set the corresponding parameter to an emtpy string.

Each parameter given in one of the lists above, has to be of a certain type. So you have to set <typename>.<parametername>.type to this type.

Optional parameters

After having specified the required parameters, you can add default values (to parameters listed in the parameters list) setting <typename>.<parametername> to the desired default value. You can also add documentation by entering a docstring to <typename>.<parametername>.doc or by providing an URL to a text file containing the documentation (you can use html markup). URLs have to be given at the <typename>.<parametername>.docfile. The docfile URLs have to be given either as absolute paths or relative to the configuration directory (the class file is also located in the configuration directory). You can also provide both information (doc and docfile). The docfile property is (actually) only used for class documentation (not for parameters), there, the docstring is used as a brief summary at the top of the documentation page and the content of the docfile is pasted below. The docstrings for parameters are shown as tooltip in the object inspector and as a short description for each parameter in the class documentation (like in this doxygen documentation).

Summary:

• <typename>.<parametername>: default value
• <typename>.<parametername>.doc: docstring
• <typename>.<parametername>.docfile: URL to doc file

Example metadata file

Here we describe a simple class that reads some image data from file. No input slot is needed, so filereader.inputs is set to an empty value. The data output is named data and given in the list filereader.outputs. The only configurable parameter is the filename to load from. The given default value, filereader.filename, docstrings and docfiles are optional.

example class description

parameter	value	remarks
filereader.inputs		no inputs avaiable
filereader.outputs	data	one output slot named "data"
filereader.parameters	filename	one configurable parameter named "filename"
filereader.filename	sample.cimg	default value for "filename"
filereader.filename.type	filename	This type is actually only interpreted as a string
filereader.filename.doc	Name of the file to read from.	short docstring
filereader.data.type	image	slot data type (to check for matching slots)
filereader.data.doc	Data output.	short description of this output slot
filereader.doc	Reads data from file.	brief class desctiption
filereader.docfile	doc/classes/filereader.txt	URL to detailed documentation (relative to config dir)

A more complex example (which is used as default class configuration) can be found at sampleclasses.wrp.