com.inductiveautomation.ignition.alarming.pipelines

Interface AlarmPipelineManager

public interface AlarmPipelineManager

Method Summary

Modifier and Type	Method and Description
void	evaluate(java.lang.String pipelineName, AlarmEvent alarmEvent) Put an AlarmEvent onto a AlarmPipeline for evaluation.
java.util.List<java.lang.String>	getPipelineNames()
com.google.common.collect.Multimap<java.lang.String,TrackingContext>	getTrackingContexts()
void	registerBlockFactory(PipelineBlockFactory factory) Register a PipelineBlockFactory.
void	unregisterBlockFactory(java.lang.String factoryId) Unregister a PipelineBlockFactory.

Method Detail

getPipelineNames

java.util.List<java.lang.String> getPipelineNames()

Returns:

The names of the available, active pipelines, not null

evaluate

void evaluate(java.lang.String pipelineName,
              AlarmEvent alarmEvent)

Put an AlarmEvent onto a AlarmPipeline for evaluation.

Parameters:

pipelineName - The name of the AlarmPipeline.

alarmEvent - The AlarmEvent to evaluate.

registerBlockFactory

void registerBlockFactory(PipelineBlockFactory factory)

Register a PipelineBlockFactory. All PipelineBlocks must have an associated PipelineBlockFactory that constructs them.

Parameters:

factory - A PipelineBlockFactory.

unregisterBlockFactory

void unregisterBlockFactory(java.lang.String factoryId)

Unregister a PipelineBlockFactory.

Parameters:

factoryId - The id (PipelineBlockFactory.getId()) of the factory to unregister.

getTrackingContexts

com.google.common.collect.Multimap<java.lang.String,TrackingContext> getTrackingContexts()

Returns:

A copy of the root TrackingContexts for all outstanding AlarmEvents, grouped by pipeline name.