import { DistanceUnitEnum } from "./distanceUnitEnum";
import { SequenceSource } from "./sequenceSource";
import { PhaseEnum } from "./phaseEnum";
import { WellTopSurface } from "./wellTopSurface";

/**
 * A collection of well tops for a given wellbore.
 */
export interface WellTops {
  /**
   * External id for the wellbore asset the well tops are associated with. Source for the wellbore and for the well tops must be the same.
   */
  wellboreAssetExternalId: string;
  /**
   * The matching id of the wellbore containing these lithostratigraphic units.
   */
  wellboreMatchingId: string;
  /**
   * The name of the wellbore containing these lithostratigraphic units.
   */
  wellboreName: string;
  source: SequenceSource;
  measuredDepthUnit: DistanceUnitEnum;
  trueVerticalDepthUnit: DistanceUnitEnum;
  phase?: PhaseEnum;
  /**
   * If `true`, this is the _definitive_ well tops for the wellbore it\'s associated with. At any time, a wellbore can only have one definitive well top. When well tops are used as a proxy for depth, only definitive well tops are used.
   */
  isDefinitive: boolean;
  tops: Array<WellTopSurface>;
}