Overview

The input object is the input of a BRAHMS Matlab Process. The object passed in is constructed anew by the bindings before every call.

Fields

Notes
  • On the first event called, EVENT_MODULE_INIT, only the fields event and objects are present (this is because time and the input/output interfaces are not yet instantiated).
event
Analogous to the Event object passed to a native BRAHMS process. Sub-fields type and flags are as in Event. An additional bindings-only field continuation is present, and usually zero. It is explained in full under Continuation.
objects
Following a call to OPERATION_GET_UTILITY_OBJECT, the requested Utility object is returned in this field.
time
Component Time, converted to a Matlab representation.
iif
The process input interface, converted to a Matlab representation. In particular, any available data on the input interface are present in this field. The field has a sub-field for each input set, <set name>, described below. The sub-field default will always be present, representing the Default Set. If you don't use Sets, it is in this latter field that you will find all of your input ports.
iif.<set name>
The set structure has two sub-fields, index and ports, described below.
iif.<set name>.ports
Input ports are available in this 1xN struct object, in the order they sit in the set. Each entry is a structure having sub-fields for the name, class, structure and content (data) on the port.
iif.<set name>.index
It is possible to find named inputs by walking through the ports field, and checking the name of each port. This supplementary field provides an associative index to make it easier to find named ports, using the syntax port = iif.<set name>.ports(iif.<set name>.index.<port name>).
oif
The process output interface, which is presented to the wrapped function as an associative array of port handles. For example, the handle of the output port called "out" in the default output set will be available at input.oif.default.out. This handle can be passed to OPERATION_SET_CONTENT, to write the data in that port.