com.inductiveautomation.ignition.alarming.pipelines.blocks

Interface PipelineBlock

public interface PipelineBlock

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PipelineBlock.BlockEvaluationContext A PipelineBlock.BlockEvaluationContext is an "instance" for evaluating an incoming AlarmEvent against a PipelineBlock's configuration.

Method Summary

Modifier and Type	Method and Description
void	initialize(java.util.Queue<PipelineBlock.BlockEvaluationContext> evalQueue, java.util.Map<java.util.UUID,PipelineBlock> blockMap) Hang onto the evalQueue instance and resolve any outgoing connections using blockMap.
PipelineBlock.BlockEvaluationContext	newEvaluationContext(AlarmEvent alarmEvent, TrackingContext trackingContext) Create a new PipelineBlock.BlockEvaluationContext for the given AlarmEvent.

Method Detail

initialize

void initialize(java.util.Queue<PipelineBlock.BlockEvaluationContext> evalQueue,
                java.util.Map<java.util.UUID,PipelineBlock> blockMap)

Hang onto the evalQueue instance and resolve any outgoing connections using blockMap.

Parameters:

evalQueue - The evaluation queue to place the next PipelineBlock.BlockEvaluationContext when making a transition to the next block.

blockMap - A Map to resolve output block ids to block instances.

newEvaluationContext

PipelineBlock.BlockEvaluationContext newEvaluationContext(AlarmEvent alarmEvent,
                                                          TrackingContext trackingContext)

Create a new PipelineBlock.BlockEvaluationContext for the given AlarmEvent.

Parameters:

alarmEvent - The input AlarmEvent.

trackingContext - The TrackingContext to update when evaluation occurs. TrackingContext.transition() should already have been called.

Returns:

A PipelineBlock.BlockEvaluationContext for the given input.