Attribute Calculator
Introduction
The Attribute Calculator sets the values of one attribute in an entryset based on the values of other attributes in that entryset. An Attribute Calculator must be used in conjunction with a Formula or a Custom Module that implements the "calculator" interface. One of these modules must be connected with its "Use Module As Plug-in" output connector to the Attribute Calculator's "Set Calculation Plug-In" input connector. Once a Formula and a source entryset are connected, a range of source attributes and a single destination attribute are specified. The input entryset supplies the values of the variables in the "calculator", while the destination attribute receives the output of the processed Formula for each entry.
Property Panel:
Define Input Mapping
- Plug-In Inputs
- The variable of the module used as the "calculator" plug-in.
- Entryset Source Range
- The value to send to the variable specified in the "Plug-in Inputs" column. Click the "Edit Range" button to specify a specific attribute or a range of attributes to use as input to the variable.
Define Output Mapping
- Plug-in Outputs
- The output of the module used as the 'Calculator' plug-in.
- Entyset Destination Attribute
- One of the attributes from the entryset input by the "Get Processed Entryset" connector must be chosen from the drop down menu as the destination for the Formula's calculated output.
Start and End Index
- Specify a Start and End Index for Processing
- Determines the range of entries that are calculated. If no start and end index are specified, the attribute calculator will process every entry in the entryset.
- Start and End Index
- Specifies the beginning and end of the range of processed values based on their index in the entryset.
Input Menu:
Set Entryset
Sets the source entryset that contains data for processing as well as a destination attribute to place the calculated values.
Accepted Datatypes:
- Entryset
Triggered Outputs:
- Output Message:
- Get Processed Entryset
Set Calculation Plug-in
Sets the 'calculator' that will be applied to each entry according to the Property Panel configuration.
Accepted Datatypes:
- Formula Module
- A Formula or compatible Custom Module that implements the 'calculator' interface.
Triggered Outputs:
- Output Message:
- Get Processed Entryset
Output Menu:
Get Processed Entryset
Gets the resulting entryset with the newly calculated entry values.
Output Datatype:
- Entryset
Triggered By:
- Input Message:
- Set Entryset
- Input Message:
- Set Calculation Plug-in
- Action:
- Changing the value of the incoming entryset or the expression the attached Formula plug-in.