Class TieInCapacityResult

java.lang.Object
neqsim.process.fielddevelopment.tieback.capacity.TieInCapacityResult
All Implemented Interfaces:
Serializable
public final class TieInCapacityResult extends Object implements Serializable
Aggregated result from a host tie-in capacity and holdback study.
Version:
1.0
Author:
ESOL
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serialization version UID.
      See Also:

    • hostName

      private final String hostName
      Host name.

    • allocationPolicy

      private final CapacityAllocationPolicy allocationPolicy
      Allocation policy used.

    • holdbackPolicy

      private final HoldbackPolicy holdbackPolicy
      Holdback policy used.

    • periodResults

      private final List<TieInPeriodResult> periodResults
      Period-by-period results.

    • debottleneckDecisions

      private final List<DebottleneckDecision> debottleneckDecisions
      Debottleneck decisions.

    • summary

      private final String summary
      Text summary.

  • Constructor Details

    • TieInCapacityResult

      public TieInCapacityResult(String hostName, CapacityAllocationPolicy allocationPolicy, HoldbackPolicy holdbackPolicy, List<TieInPeriodResult> periodResults, List<DebottleneckDecision> debottleneckDecisions, String summary)
      Creates an aggregated capacity result.
      Parameters:
      hostName - host facility name
      allocationPolicy - allocation policy used
      holdbackPolicy - holdback policy used
      periodResults - period-by-period results
      debottleneckDecisions - debottleneck decisions
      summary - summary text

  • Method Details

    • getHostName

      public String getHostName()
      Gets the host name.
      Returns:
      host name

    • getAllocationPolicy

      public CapacityAllocationPolicy getAllocationPolicy()
      Gets the allocation policy.
      Returns:
      allocation policy

    • getHoldbackPolicy

      public HoldbackPolicy getHoldbackPolicy()
      Gets the holdback policy.
      Returns:
      holdback policy

    • getPeriodResults

      public List<TieInPeriodResult> getPeriodResults()
      Gets period results.
      Returns:
      unmodifiable period results

    • getDebottleneckDecisions

      public List<DebottleneckDecision> getDebottleneckDecisions()
      Gets debottleneck decisions.
      Returns:
      unmodifiable debottleneck decisions

    • hasHoldback

      public boolean hasHoldback()
      Checks whether any satellite production is held back.
      Returns:
      true if held-back gas, oil, water, or liquid exists

    • getTotalAcceptedGasMSm3

      public double getTotalAcceptedGasMSm3()
      Gets total accepted satellite gas volume.
      Returns:
      accepted satellite gas in MSm3

    • getTotalHeldBackGasMSm3

      public double getTotalHeldBackGasMSm3()
      Gets total held-back satellite gas volume.
      Returns:
      held-back satellite gas in MSm3

    • getTotalAcceptedOilBbl

      public double getTotalAcceptedOilBbl()
      Gets total accepted satellite oil volume.
      Returns:
      accepted satellite oil in barrels

    • getTotalHeldBackOilBbl

      public double getTotalHeldBackOilBbl()
      Gets total held-back satellite oil volume.
      Returns:
      held-back satellite oil in barrels

    • getTotalHeldBackWaterM3

      public double getTotalHeldBackWaterM3()
      Gets total held-back satellite water volume.
      Returns:
      held-back satellite water in m3

    • getTotalHeldBackLiquidM3

      public double getTotalHeldBackLiquidM3()
      Gets total held-back satellite liquid volume.
      Returns:
      held-back satellite liquid in m3

    • getTotalDeferredValueMusd

      public double getTotalDeferredValueMusd()
      Gets total deferred value before discounting.
      Returns:
      deferred value in MUSD

    • getTotalDeferredValueNpvMusd

      public double getTotalDeferredValueNpvMusd()
      Gets total discounted deferred value.
      Returns:
      discounted deferred value in MUSD

    • getPrimaryBottleneck

      public String getPrimaryBottleneck()
      Gets the primary bottleneck from the most constrained period.
      Returns:
      primary bottleneck name, or "None" if no period has a bottleneck

    • getSummary

      public String getSummary()
      Gets the result summary.
      Returns:
      summary text

    • toMarkdownTable

      public String toMarkdownTable()
      Formats the period results as a Markdown table.
      Returns:
      Markdown table

    • toCsv

      public String toCsv()
      Formats the period results as CSV.
      Returns:
      CSV table