Entryset Module
Introduction
The Entryset Module exposes an interface to two different types of interaction with the entryset. The first is modification: adding, deleting, editing, and appending entries to an entryset. The second is access: selecting individual values and entire entries out of an entryset. Using index values, an Entryset Module tracks a "Selected Entry" that designates which rows are edited, deleted, or retrieved by the "Selected Entry" output connectors.
The Entryset Module also provides access to individual cells in an entryset. A selected cell is tracked, and can be set using the "Selected Cell" input connectors. The value of the selected cell can be retrieved using the "Get Selected Cell Data" output connector.
The Entryset Module allows an index value of one greater than the number of entries currently in the target entryset. Editing an entry via a "Selected Entry Connectors → [Attribute] → Set Value" input connector at that one-greater index value will create a new entry. When created, this new entry will only contain a value for a single attribute.
Values can be sent to the "Selected Entry Connectors → [Attribute] → Set Value" connectors to set those attribute values once the entry is created. Incrementing the "Selected Entry" index will enable the creation of another new entry.
The Entryset Module can be used to create a new entryset. First configure the Property Panel to specify an attribute schema. Then create entries using the "Set Value" input connectors for each attribute or append entries with identical attribute schemas using the "Append Entryset" connector.
Property Panel:
- Selected Entry
- Specifies the index of the currently selected entry in the entryset.
Define Entryset Structure...
- Name
- Specifies the name of the attribute. If a name is left blank, it is filled in according to Excel's naming logic - 'A','B', ..., 'AA', 'AB', etc.
- Hidden
- Specifies whether the attribute is hidden or not.
- Type
- Constrains the data type that an attribute can contain.
- Default Value
- This drop-down menu selects the initial value that a new entry in the created entryset will contain.
- Import From ProtoDB...
- Pressing this button opens a window that allows you to select a ProtoDB and copy its attribute schema.
Input Menu:
Set Entryset
Sets the entryset to edit or select values from.
Accepted Datatypes:
- Entryset
Triggered Outputs:
- Output Message:
- Get Entryset
- Output Message:
- Get Entryset Size
- Output Message:
- Get Selected Entry
- Output Message:
- Get Selected Entry Attributes → [Attribute]
Selected Entry → Set Index
Sets the selected entry in the current entryset according to its index value.
Accepted Datatypes:
- Number
Triggered Outputs:
- Output Message:
- Get Selected Entry
- Output Message:
- Get Selected Index
- Output Message:
- Get Selected Entry Attributes → [Attribute]
Selected Cell → Set Attribute by Name
Sets the selected attribute in the selected entry of the current entryset according to its attribute name.
Accepted Datatypes:
- Text
Triggered Outputs:
- Output Message:
- Get Selected Cell Data
Selected Cell → Set Attribute by Position
Sets the selected cell in the selected entry in the current entryset according to its index value within the entry.
Accepted Datatypes:
- Number
Triggered Outputs:
- Output Message:
- Get Selected Cell Data
Selected Cell → Set Entry Index
Sets the selected entry in the current entryset according to its index value.
Accepted Datatypes:
- Number
Triggered Outputs:
- Output Message:
- Get Selected Cell Data
- Output Message:
- Get Entryset
- Output Message:
- Get Entryset Size
Selected Cell → Set Selected Cell Data
Sets the data in the selected cell in the current entryset.
Accepted Datatypes:
- Any
Triggered Outputs:
- Output Message:
- Get Entryset
- Output Message:
- Get Selected Cell Data
Delete Selected Entry
Deletes the currently selected entry from the entryset.
Accepted Datatypes:
- True/false
Triggered Outputs:
- Output Message:
- Get Entryset
- Output Message:
- Get Entryset Size
Selected Entry Connectors → [Attribute] → Set Editor Plug-in (Dynamic Menu)
Sets a "value" plug-ins that can both display and input values into an entryset. This is described in more detail in the Plug-in Feature
Accepted Datatypes:
- Module
- One of the modules that implement the "value" interface: Text Box, Slider, Check Box, and Date Chooser.
Triggered Outputs:
- Output Message:
- Get Entryset
- Output Message:
- Get Selected Entry
- Output Message:
- Get Selected Entry Attributes → [Attribute]
Selected Entry Connectors → [Attribute] → Set Value (Dynamic Menu)
Sets the value for [Attribute] in the selected entry.
Accepted Datatypes:
- Any
- Requires data compatible with the attribute's data type.
Triggered Outputs:
- Output Message:
- Get Entryset
- Output Message:
- Get Selected Entry
- Output Message:
- Get Selected Entry Attributes → [Attribute]
Append Entryset
Appends the entries contained in the incoming entryset to the current entryset.
Accepted Datatypes:
- Entryset
- An entryset matching the schema of the Entryset Module's current entryset.
Triggered Outputs:
- Output Message:
- Get Entryset
- Output Message:
- Get Entryset Size
Output Menu:
Get Entryset
Gets the current entryset.
Output Datatype:
- Entryset
Triggered By:
- Input Message:
- Entryset
- Input Message:
- Append Entryset
- Input Message:
- Delete Selected Entry
- Input Message:
- Selected Entry Connectors → [Attribute] → Set Value
- Action:
- Fire-On-Connect
Get Selected Entry
Gets an entryset containing only the single, selected entry.
Output Datatype:
- Entryset
Triggered By:
- Input Message:
- Set Entryset
- Input Message:
- Selected Entry → Set Index
- Input Message:
- Selected Entry Connectors → [Attribute] → Set Value
- Action:
- Fire-On-Connect
Get Selected Entry Transposed
Gets an entryset containing the selected entry, but with each of its attributes and corresponding value as a single entry in the output entryset.
Output Datatype:
- Entryset
- An entryset with the attributes "Attributes" and "Values".
Triggered By:
- Input Message:
- Set Entryset
- Input Message:
- Selected Entry → Set Index
- Input Message:
- Selected Entry Connectors → [Attribute] → Set Value
- Action:
- Fire-On-Connect
Get Selected Cell Data
Gets the value of the data from the currently selected cell.
Output Datatype:
- Any
- The data type will be that of whatever value is in the selected cell
Triggered By:
- Input Message:
- Entryset
- Input Message:
- Selected Cell → Set Attribute by Name
- Input Message:
- Selected Cell → Set Attribute by Position
- Input Message:
- Selected Cell → Set Entry Index
- Input Message:
- Selected Cell → Set Selected Cell Data
Get Attribute List
Gets a list of all attributes in the current entryset as entries in a single attribute entryset.
Output Datatype:
- Entryset
- A single attribute entryset with an entry corresponding to each attribute in the current entryset.
Triggered By:
- Input Message:
- Set Entryset
- Action:
- Fire-On-Connect
Get Selected Index
Gets the index value of the selected entry.
Output Datatype:
- Number
Triggered By:
- Input Message:
- Selected Entry → Set Index
- Action:
- Fire-On-Connect
Get Entryset Size
Gets the current number of entries in the entryset.
Output Datatype:
- Number
Triggered By:
- Input Message:
- Set Entryset
- Input Message:
- Append Entryset
- Input Message:
- Delete Selected Entry
- Action:
- Fire-On-Connect
Get Selected Entry Attributes → [Attribute] (Dynamic Menu)
Gets the value for [Attribute] in the selected entry.
Output Datatype:
- Any
- The data type of [Attribute]
Triggered By:
- Input Message:
- Set Entryset
- Input Message:
- Selected Entry → Set Index
- Input Message:
- Selected Entry Connectors → [Attribute] → Set Value
- Action:
- Fire-On-Connect
Get Selected Entry Attributes by Number → Get Attribute [x] Value (Dynamic Menu)
Gets the value for attribute [x] in the selected entry, where [x] is the index of the attribute when counting left to right.
Output Datatype:
- Any
- The data type of attribute [x]
Triggered By:
- Input Message:
- Set Entryset
- Input Message:
- Selected Entry → Set Index
- Input Message:
- Selected Entry Connectors → [Attribute] → Set Value
- Action:
- Fire-On-Connect