Interface HistorianRpcFunctions


public interface HistorianRpcFunctions
RPC functions the Designer and clients call on the gateway historian module: browsing, queries, aggregate catalogs and stores.
  • Method Details

    • browse

      Results<Result> browse(@Nullable QualifiedPath path, @Nullable BrowseFilter filter)
      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, or null to browse providers.
      filter - the browse filter, or null for the default.
      Returns:
      the browse results.
    • queryDataPoints

      void queryDataPoints(DataPointQueryOptions<?> queryOptions, ResultWriterOptions writerOptions)
      Runs a data point query and writes the results.
      Parameters:
      queryOptions - the query settings.
      writerOptions - how to write the results.
    • queryAnnotations

      Results<AnnotationPoint> queryAnnotations(AnnotationQueryOptions queryOptions)
      Queries annotations.
      Parameters:
      queryOptions - the query settings.
      Returns:
      the matching annotations.
    • queryMetadata

      Results<MetadataPoint> queryMetadata(MetadataQueryOptions queryOptions)
      Queries metadata points.
      Parameters:
      queryOptions - the query settings.
      Returns:
      the matching metadata points.
    • engineCapabilitiesForProvider

      @Nullable EngineCapabilities engineCapabilitiesForProvider(String providerId)
      Returns an engine's capabilities, which shape the historian.query binding's Designer UI.
      Parameters:
      providerId - the historian provider id (the histprov: path component).
      Returns:
      the capabilities, or null if the provider is not configured.
    • aggregateDescriptorsForSource

      List<AggregateDescriptor> aggregateDescriptorsForSource(QualifiedPath path)
      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's histprov: component.
      Parameters:
      path - the source path in canonical form.
      Returns:
      the descriptors; empty if the path does not resolve to a configured provider.
    • nativeAggregateDescriptorsForSource

      List<AggregateDescriptor> nativeAggregateDescriptorsForSource(QualifiedPath path)
      Returns only the native subset of aggregateDescriptorsForSource(QualifiedPath).
    • platformFallbackAggregateDescriptors

      List<AggregateDescriptor> platformFallbackAggregateDescriptors(DataType inputType)
      Returns the engine-independent platform fallback aggregates for a data type.
      Parameters:
      inputType - the tag's data type.
      Returns:
      the descriptors.
    • storeDataPoints

      QualityCode storeDataPoints(List<AtomicPoint<?>> dataPoints, boolean blockForResult)
      Stores data points.
      Parameters:
      dataPoints - the points to store.
      blockForResult - whether to wait until storage has been attempted.
      Returns:
      the result.
    • storeAnnotations

      QualityCode storeAnnotations(List<AnnotationPoint> annotations, boolean blockForResult)
      Stores annotations.
      Parameters:
      annotations - the annotations to store.
      blockForResult - whether to wait until storage has been attempted.
      Returns:
      the result.
    • storeMetadata

      QualityCode storeMetadata(List<MetadataPoint> metadata, boolean blockForResult)
      Stores metadata points.
      Parameters:
      metadata - the points to store.
      blockForResult - whether to wait until storage has been attempted.
      Returns:
      the result.
    • applyAnnotationChanges

      QualityCode applyAnnotationChanges(List<AnnotationChangePoint> changes, boolean blockForResult)
      Applies annotation changes.
      Parameters:
      changes - the changes to apply.
      blockForResult - whether to wait until the changes have been applied.
      Returns:
      the result.
    • applyHistoricalSourceChanges

      QualityCode applyHistoricalSourceChanges(List<SourceChangePoint> changes, boolean blockForResult)
      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.