Package org.sensorhub.api.data

Interface IObsData

All Known Implementing Classes:
ObsData
public interface IObsData

Represents observation data generated by an output interface

  • Field Details

    • NO_FOI

      static final BigId NO_FOI

  • Method Details

    • getDataStreamID

      BigId getDataStreamID()
      Returns:
      The internal ID of the data stream that the observation is part of.

    • getFoiID

      BigId getFoiID()
      Returns:
      The ID of the feature of interest that was observed.
      This can be 0 if no feature of interest was reported.

    • hasFoi

      default boolean hasFoi()

    • getPhenomenonTime

      Instant getPhenomenonTime()
      Returns:
      The time of occurrence of the measured phenomenon (e.g. for many automated sensor devices, this is typically the sampling time).
      This field cannot be null.

    • getResultTime

      Instant getResultTime()
      Returns:
      The time at which the observation result was obtained.
      This is typically the same as the phenomenon time for many automated in-situ and remote sensors doing the sampling and actual measurement (almost) simultaneously, but different for measurements made in a lab on samples that were collected previously. It is also different for models and simulations outputs (e.g. for a model, this is the run time).
      If no result time was explicitly set, this returns the phenomenon time

    • getParameters

      Map<String,Object> getParameters()
      Returns:
      Observation parameters map

    • getPhenomenonLocation

      org.locationtech.jts.geom.Geometry getPhenomenonLocation()
      Returns:
      Area or volume (2D or 3D) where the observation was made.
      If value is null, FoI geometry is used instead when provided. If neither geometry is provided, observation will never be selected when filtering on geometry.
      In a given data store, all geometries must be expressed in the same coordinate reference system.

    • getResult

      DataBlock getResult()
      Returns:
      Observation result data record