Package com.inductiveautomation.historian.gateway.rpc

Class GatewayRpcFunctions

java.lang.Object

com.inductiveautomation.historian.gateway.rpc.GatewayRpcFunctions

All Implemented Interfaces:

HistorianRpcFunctions

public class GatewayRpcFunctions
extends Object
implements HistorianRpcFunctions

Constructor Summary

Constructors

Constructor	Description
GatewayRpcFunctions(com.inductiveautomation.historian.gateway.scripting.GatewayHistorianFunctions functions)

Method Summary

Modifier and Type	Method	Description
QualityCode	applyAnnotationChanges(List<AnnotationChangePoint> changes, boolean blockForResult)	Applies the provided list of annotation changes.
QualityCode	applyHistoricalSourceChanges(List<SourceChangePoint> changes, boolean blockForResult)	Applies the provided list of historical source changes.
Results<Result>	browse(QualifiedPath path, BrowseFilter filter)	Browses the specified path using the provided filter.
Results<AnnotationPoint>	queryAnnotations(AnnotationQueryOptions queryOptions)	Queries annotations based on the provided query options.
void	queryDataPoints(DataPointQueryOptions<?> queryOptions, ResultWriterOptions writerOptions)	Queries data points based on the provided query options and writes the results using the specified writer options.
Results<MetadataPoint>	queryMetadata(MetadataQueryOptions queryOptions)	Queries metadata points based on the provided query options.
QualityCode	storeAnnotations(List<AnnotationPoint> annotations, boolean blockForResult)	Stores the provided list of annotations.
QualityCode	storeDataPoints(List<AtomicPoint<?>> dataPoints, boolean blockForResult)	Stores the provided list of data points.
QualityCode	storeMetadata(List<MetadataPoint> metadata, boolean blockForResult)	Stores the provided list of metadata points.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GatewayRpcFunctions

public GatewayRpcFunctions(com.inductiveautomation.historian.gateway.scripting.GatewayHistorianFunctions functions)

Method Details

browse

public Results<Result> browse(QualifiedPath path,
 BrowseFilter filter)

Description copied from interface: HistorianRpcFunctions

Browses the specified path using the provided filter.

Specified by:

browse in interface HistorianRpcFunctions

Parameters:

path - The QualifiedPath to browse.

filter - The BrowseFilter to apply during browsing.

Returns:

A Results object containing the browse results.

queryDataPoints

public void queryDataPoints(DataPointQueryOptions<?> queryOptions,
 ResultWriterOptions writerOptions)

Description copied from interface: HistorianRpcFunctions

Queries data points based on the provided query options and writes the results using the specified writer options.

Specified by:

queryDataPoints in interface HistorianRpcFunctions

Parameters:

queryOptions - The DataPointQueryOptions specifying the query parameters.

writerOptions - The ResultWriterOptions specifying how to write the results.

queryAnnotations

public Results<AnnotationPoint> queryAnnotations(AnnotationQueryOptions queryOptions)

Description copied from interface: HistorianRpcFunctions

Queries annotations based on the provided query options.

Specified by:

queryAnnotations in interface HistorianRpcFunctions

Parameters:

queryOptions - The AnnotationQueryOptions specifying the query parameters.

Returns:

A Results object containing the queried annotations.

queryMetadata

public Results<MetadataPoint> queryMetadata(MetadataQueryOptions queryOptions)

Description copied from interface: HistorianRpcFunctions

Queries metadata points based on the provided query options.

Specified by:

queryMetadata in interface HistorianRpcFunctions

Parameters:

queryOptions - The MetadataQueryOptions specifying the query parameters.

Returns:

A Results object containing the queried metadata points.

storeDataPoints

public QualityCode storeDataPoints(List<AtomicPoint<?>> dataPoints,
 boolean blockForResult)

Description copied from interface: HistorianRpcFunctions

Stores the provided list of data points.

Specified by:

storeDataPoints in interface HistorianRpcFunctions

Parameters:

dataPoints - A List of AtomicPoint objects to store.

blockForResult - A flag indicating whether the result should be obtained after confirmation that storage has been attempted.

Returns:

A QualityCode indicating the result of the operation.

storeAnnotations

public QualityCode storeAnnotations(List<AnnotationPoint> annotations,
 boolean blockForResult)

Description copied from interface: HistorianRpcFunctions

Stores the provided list of annotations.

Specified by:

storeAnnotations in interface HistorianRpcFunctions

Parameters:

annotations - A List of AnnotationPoint objects to store.

blockForResult - A flag indicating whether the result should be obtained after confirmation that storage has been attempted.

Returns:

A QualityCode indicating the result of the operation.

storeMetadata

public QualityCode storeMetadata(List<MetadataPoint> metadata,
 boolean blockForResult)

Description copied from interface: HistorianRpcFunctions

Stores the provided list of metadata points.

Specified by:

storeMetadata in interface HistorianRpcFunctions

Parameters:

metadata - A List of MetadataPoint objects to store.

blockForResult - A flag indicating whether the result should be obtained after confirmation that storage has been attempted.

Returns:

A QualityCode indicating the result of the operation.

applyAnnotationChanges

public QualityCode applyAnnotationChanges(List<AnnotationChangePoint> changes,
 boolean blockForResult)

Description copied from interface: HistorianRpcFunctions

Applies the provided list of annotation changes.

Specified by:

applyAnnotationChanges in interface HistorianRpcFunctions

Parameters:

changes - A List of AnnotationChangePoint objects representing the changes to apply.

blockForResult - A flag indicating whether the result should be obtained after confirmation that the changes have been applied.

Returns:

A QualityCode indicating the result of the operation.

applyHistoricalSourceChanges

public QualityCode applyHistoricalSourceChanges(List<SourceChangePoint> changes,
 boolean blockForResult)

Description copied from interface: HistorianRpcFunctions

Applies the provided list of historical source changes.

Specified by:

applyHistoricalSourceChanges in interface HistorianRpcFunctions

Parameters:

changes - A List of SourceChangePoint objects representing the changes to apply.

blockForResult - A flag indicating whether the result should be obtained after confirmation that the changes have been applied.

Returns:

A QualityCode indicating the result of the operation.