Package com.inductiveautomation.historian.common.rpc

Interface HistorianRpcFunctions

All Known Implementing Classes:

GatewayRpcFunctions

public interface HistorianRpcFunctions

Defines the RPC (Remote Procedure Call) functions for the Historian module.

This interface provides methods for browsing, querying, and storing data points, annotations, and metadata, as well as applying changes to annotations and historical sources. It is annotated with RpcInterface to indicate its use in remote communication.

Method Summary

Modifier and Type	Method	Description
QualityCode	applyAnnotationChanges(List<AnnotationChangePoint> changes)	Applies the provided list of annotation changes.
QualityCode	applyHistoricalSourceChanges(List<SourceChangePoint> changes)	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)	Stores the provided list of annotations.
QualityCode	storeDataPoints(List<AtomicPoint<?>> dataPoints)	Stores the provided list of data points.
QualityCode	storeMetadata(List<MetadataPoint> metadata)	Stores the provided list of metadata points.

Method Details

browse

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

Browses the specified path using the provided filter.

Parameters:

path - The QualifiedPath to browse.

filter - The BrowseFilter to apply during browsing.

Returns:

A Results object containing the browse results.

queryDataPoints

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

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

Parameters:

queryOptions - The DataPointQueryOptions specifying the query parameters.

writerOptions - The ResultWriterOptions specifying how to write the results.

queryAnnotations

Results<AnnotationPoint> queryAnnotations(AnnotationQueryOptions queryOptions)

Queries annotations based on the provided query options.

Parameters:

queryOptions - The AnnotationQueryOptions specifying the query parameters.

Returns:

A Results object containing the queried annotations.

queryMetadata

Results<MetadataPoint> queryMetadata(MetadataQueryOptions queryOptions)

Queries metadata points based on the provided query options.

Parameters:

queryOptions - The MetadataQueryOptions specifying the query parameters.

Returns:

A Results object containing the queried metadata points.

storeDataPoints

QualityCode storeDataPoints(List<AtomicPoint<?>> dataPoints)

Stores the provided list of data points.

Parameters:

dataPoints - A List of AtomicPoint objects to store.

Returns:

A QualityCode indicating the result of the operation.

storeAnnotations

QualityCode storeAnnotations(List<AnnotationPoint> annotations)

Stores the provided list of annotations.

Parameters:

annotations - A List of AnnotationPoint objects to store.

Returns:

A QualityCode indicating the result of the operation.

storeMetadata

QualityCode storeMetadata(List<MetadataPoint> metadata)

Stores the provided list of metadata points.

Parameters:

metadata - A List of MetadataPoint objects to store.

Returns:

A QualityCode indicating the result of the operation.

applyAnnotationChanges

QualityCode applyAnnotationChanges(List<AnnotationChangePoint> changes)

Applies the provided list of annotation changes.

Parameters:

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

Returns:

A QualityCode indicating the result of the operation.

applyHistoricalSourceChanges

QualityCode applyHistoricalSourceChanges(List<SourceChangePoint> changes)

Applies the provided list of historical source changes.

Parameters:

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

Returns:

A QualityCode indicating the result of the operation.