Class FlowGraphMultiGateBlock
Hierarchy (View Summary)
- FlowGraphExecutionBlock
- FlowGraphMultiGateBlock
Constructors
constructor
-
new FlowGraphMultiGateBlock(
config: IFlowGraphMultiGateBlockConfiguration,
): FlowGraphMultiGateBlockParameters
- config: IFlowGraphMultiGateBlockConfiguration
the configuration of the block
Returns FlowGraphMultiGateBlock
- config: IFlowGraphMultiGateBlockConfiguration
Properties
config
the configuration of the block
data
The data inputs of the block.
data
The data outputs of the block.
Readonlyerror
An output connection that can be used to signal an error, if the block defines it.
Readonlyin
Input connection: The input signal of the block.
Readonlylast
Output connection: The index of the current output flow.
metadata
Metadata that can be used by the block.
name
The name of the block.
Readonlyoutput
Output connections: The output signals.
Readonlypriority
The priority of the block. Higher priority blocks will be executed first. Note that priority cannot be change AFTER the block was added as sorting happens when the block is added to the execution queue.
Readonlyreset
Input connection: Resets the gate.
signal
Input connections that activate the block.
signal
Output connections that can activate downstream blocks.
unique
A randomly generated GUID for each block.
Methods
deserialize
-
Deserializes from an object
Parameters
- serializationObject: any
the object to deserialize from
Returns void
- serializationObject: any
get
-
Returns string
class name of the block.
get
-
Given the name of a data input, returns the connection if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphDataConnection<any> | undefined
the connection if it exists, undefined otherwise
- name: string
get
-
Given the name of a data output, returns the connection if it exists
Parameters
- name: string
the name of the output
Returns FlowGraphDataConnection<any> | undefined
the connection if it exists, undefined otherwise
- name: string
get
-
Given a name of a signal input, return that input if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphSignalConnection | undefined
if the input exists, the input. Otherwise, undefined.
- name: string
get
-
Given a name of a signal output, return that input if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphSignalConnection | undefined
if the input exists, the input. Otherwise, undefined.
- name: string
register
-
registerDataInput<T>(
name: string,
richType: RichType<T>,
defaultValue?: T,
): FlowGraphDataConnection<T>Registers a data input on the block.
Type Parameters
- T
Parameters
Returns FlowGraphDataConnection<T>
the created connection
register
-
registerDataOutput<T>(
name: string,
richType: RichType<T>,
defaultValue?: T,
): FlowGraphDataConnection<T>Registers a data output on the block.
Type Parameters
- T
Parameters
Returns FlowGraphDataConnection<T>
the created connection
serialize
-
Serializes the block.
Parameters
OptionalserializationObject: anythe object to serialize to.
Returns void
set
-
Sets the block's output signals. Would usually be passed from the constructor but can be changed afterwards.
Parameters
- numberOutputSignals: number = 1
the number of output flows
Returns void
- numberOutputSignals: number = 1
A block that has an input flow and routes it to any potential output flows, randomly or sequentially