1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
.. _chap-api-documentation:
VisTrails API Documentation
***************************
Module Definition
=================
Module
^^^^^^
.. py:module:: vistrails.core.modules.vistrails_module
.. autoclass:: vistrails.core.modules.vistrails_module.Module
:members: compute, set_output, get_input, has_input, check_input,
get_input_list, force_get_input_list, force_get_input, annotate
:member-order: bysource
.. py:attribute:: _input_ports
Class attribute that stores the list of input ports for the module. May include instances of :py:class:`~vistrails.core.modules.config.InputPort` and :py:class:`.CompoundInputPort`.
.. py:attribute:: _output_ports
Class attribute that defines the list of output ports for the module. May include instances of :py:class:`~vistrails.core.modules.config.OutputPort` and :py:class:`.CompoundOutputPort`.
.. py:attribute:: _settings
Class attribute that stores a :py:class:`.ModuleSettings` object that controls appearance, configuration widgets, and other module settings.
ModuleError
^^^^^^^^^^^
.. autoclass:: vistrails.core.modules.vistrails_module.ModuleError
ModuleSettings
^^^^^^^^^^^^^^
.. py:module:: vistrails.core.modules.config
.. autoclass:: vistrails.core.modules.config.ModuleSettings
Port Specification
==================
InputPort (IPort)
^^^^^^^^^^^^^^^^^
.. autoclass:: vistrails.core.modules.config.InputPort
.. py:class:: vistrails.core.modules.config.IPort
Synonym for :py:class:`~vistrails.core.modules.config.InputPort`
OutputPort (OPort)
^^^^^^^^^^^^^^^^^^
.. autoclass:: vistrails.core.modules.config.OutputPort
.. py:class:: vistrails.core.modules.config.OPort
Synonym for :py:class:`~vistrails.core.modules.config.OutputPort`
CompoundInputPort (CIPort)
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: vistrails.core.modules.config.CompoundInputPort
.. py:class:: vistrails.core.modules.config.CIPort
Synonym for :py:class:`~vistrails.core.modules.config.CompoundInputPort`
CompoundOutputPort (COPort)
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: vistrails.core.modules.config.CompoundOutputPort
.. py:class:: vistrails.core.modules.config.COPort
Synonym for :py:class:`~vistrails.core.modules.config.CompundOutputPort`
InputPortItem (IPItem)
^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: vistrails.core.modules.config.InputPortItem
.. py:class:: vistrails.core.modules.config.IPItem
Synonym for :py:class:`~vistrails.core.modules.config.InputPortItem`
OutputPortItem (OPItem)
^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: vistrails.core.modules.config.OutputPortItem
.. py:class:: vistrails.core.modules.config.OPItem
Synonym for :py:class:`~vistrails.core.modules.config.OutputPortItem`
Parameter Widget Configuration
==============================
ConstantWidgetConfig
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: vistrails.core.modules.config.ConstantWidgetConfig
QueryWidgetConfig
^^^^^^^^^^^^^^^^^
.. autoclass:: vistrails.core.modules.config.QueryWidgetConfig
ParamExpWidgetConfig
^^^^^^^^^^^^^^^^^^^^
.. autoclass:: vistrails.core.modules.config.ParamExpWidgetConfig
|
