Interface HistorianRpcFunctions
public interface HistorianRpcFunctions
RPC functions the Designer and clients call on the gateway historian module: browsing, queries,
aggregate catalogs and stores.
-
Method Summary
Modifier and TypeMethodDescriptionReturns the aggregates available for a source: the engine's native aggregates for the tag's data type plus the platform fallbacks for that type.applyAnnotationChanges(List<AnnotationChangePoint> changes, boolean blockForResult) Applies annotation changes.applyHistoricalSourceChanges(List<SourceChangePoint> changes, boolean blockForResult) Applies historical source changes, such as renames and retirements.browse(@Nullable QualifiedPath path, @Nullable BrowseFilter filter) Browses a path.@Nullable EngineCapabilitiesengineCapabilitiesForProvider(String providerId) Returns an engine's capabilities, which shape thehistorian.querybinding's Designer UI.Returns only the native subset ofaggregateDescriptorsForSource(QualifiedPath).platformFallbackAggregateDescriptors(DataType inputType) Returns the engine-independent platform fallback aggregates for a data type.queryAnnotations(AnnotationQueryOptions queryOptions) Queries annotations.voidqueryDataPoints(DataPointQueryOptions<?> queryOptions, ResultWriterOptions writerOptions) Runs a data point query and writes the results.queryMetadata(MetadataQueryOptions queryOptions) Queries metadata points.storeAnnotations(List<AnnotationPoint> annotations, boolean blockForResult) Stores annotations.storeDataPoints(List<AtomicPoint<?>> dataPoints, boolean blockForResult) Stores data points.storeMetadata(List<MetadataPoint> metadata, boolean blockForResult) Stores metadata points.
-
Method Details
-
browse
Browses a path. Both arguments are nullable so a Designer can request a root-level browse without serializing a sentinel path.- Parameters:
path- the path to browse, ornullto browse providers.filter- the browse filter, ornullfor the default.- Returns:
- the browse results.
-
queryDataPoints
Runs a data point query and writes the results.- Parameters:
queryOptions- the query settings.writerOptions- how to write the results.
-
queryAnnotations
Queries annotations.- Parameters:
queryOptions- the query settings.- Returns:
- the matching annotations.
-
queryMetadata
Queries metadata points.- Parameters:
queryOptions- the query settings.- Returns:
- the matching metadata points.
-
engineCapabilitiesForProvider
Returns an engine's capabilities, which shape thehistorian.querybinding's Designer UI.- Parameters:
providerId- the historian provider id (thehistprov:path component).- Returns:
- the capabilities, or
nullif the provider is not configured.
-
aggregateDescriptorsForSource
Returns the aggregates available for a source: the engine's native aggregates for the tag's data type plus the platform fallbacks for that type. The engine is the path'shistprov:component.- Parameters:
path- the source path in canonical form.- Returns:
- the descriptors; empty if the path does not resolve to a configured provider.
-
nativeAggregateDescriptorsForSource
Returns only the native subset ofaggregateDescriptorsForSource(QualifiedPath). -
platformFallbackAggregateDescriptors
Returns the engine-independent platform fallback aggregates for a data type.- Parameters:
inputType- the tag's data type.- Returns:
- the descriptors.
-
storeDataPoints
Stores data points.- Parameters:
dataPoints- the points to store.blockForResult- whether to wait until storage has been attempted.- Returns:
- the result.
-
storeAnnotations
Stores annotations.- Parameters:
annotations- the annotations to store.blockForResult- whether to wait until storage has been attempted.- Returns:
- the result.
-
storeMetadata
Stores metadata points.- Parameters:
metadata- the points to store.blockForResult- whether to wait until storage has been attempted.- Returns:
- the result.
-
applyAnnotationChanges
Applies annotation changes.- Parameters:
changes- the changes to apply.blockForResult- whether to wait until the changes have been applied.- Returns:
- the result.
-
applyHistoricalSourceChanges
Applies historical source changes, such as renames and retirements.- Parameters:
changes- the changes to apply.blockForResult- whether to wait until the changes have been applied.- Returns:
- the result.
-