Class TieInPeriodResult

java.lang.Object
neqsim.process.fielddevelopment.tieback.capacity.TieInPeriodResult
All Implemented Interfaces:
Serializable
public final class TieInPeriodResult extends Object implements Serializable
Capacity, holdback, and bottleneck result for one host tie-in planning period.
Version:
1.0
Author:
ESOL
See Also:

  • Field Details

    • serialVersionUID

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

    • periodName

      private final String periodName
      Period name used in reports.

    • year

      private final int year
      Calendar year for the period.

    • baseRequest

      private final ProductionLoad baseRequest
      Requested base-host production.

    • acceptedBase

      private final ProductionLoad acceptedBase
      Accepted base-host production.

    • scheduledSatellite

      private final ProductionLoad scheduledSatellite
      Satellite production scheduled for this period before deferred backlog.

    • deferredIntoPeriod

      private final ProductionLoad deferredIntoPeriod
      Deferred satellite backlog entering this period.

    • satelliteRequest

      private final ProductionLoad satelliteRequest
      Satellite request including scheduled and deferred volumes.

    • acceptedSatellite

      private final ProductionLoad acceptedSatellite
      Accepted satellite production.

    • heldBackSatellite

      private final ProductionLoad heldBackSatellite
      Satellite production not accepted in this period.

    • deferredToNextPeriod

      private final ProductionLoad deferredToNextPeriod
      Satellite backlog carried to the next period.

    • satelliteAllocationScale

      private final double satelliteAllocationScale
      Nameplate allocation scale applied to the satellite request.

    • nameplateBottleneck

      private final String nameplateBottleneck
      Nameplate bottleneck category.

    • processModelUsed

      private final boolean processModelUsed
      True if an attached process model was used.

    • processCapacityAvailable

      private final boolean processCapacityAvailable
      True if the process model was feasible after any process holdback.

    • processBottleneck

      private final String processBottleneck
      Process-model bottleneck name.

    • processBottleneckUtilization

      private final double processBottleneckUtilization
      Process-model bottleneck utilization fraction.

    • processUtilizationSummary

      private final Map<String,Double> processUtilizationSummary
      Equipment utilization summary from the process model.

    • deferredValueMusd

      private final double deferredValueMusd
      Undiscounted deferred or curtailed value in million USD.

    • deferredValueNpvMusd

      private final double deferredValueNpvMusd
      Discounted deferred or curtailed value in million USD.

    • summary

      private final String summary
      Concise result summary.

  • Constructor Details

    • TieInPeriodResult

      public TieInPeriodResult(String periodName, int year, ProductionLoad baseRequest, ProductionLoad acceptedBase, ProductionLoad scheduledSatellite, ProductionLoad deferredIntoPeriod, ProductionLoad satelliteRequest, ProductionLoad acceptedSatellite, ProductionLoad heldBackSatellite, ProductionLoad deferredToNextPeriod, double satelliteAllocationScale, String nameplateBottleneck, boolean processModelUsed, boolean processCapacityAvailable, String processBottleneck, double processBottleneckUtilization, Map<String,Double> processUtilizationSummary, double deferredValueMusd, double deferredValueNpvMusd, String summary)
      Creates a period result.
      Parameters:
      periodName - period name used in reports
      year - calendar year
      baseRequest - requested base-host production
      acceptedBase - accepted base-host production
      scheduledSatellite - scheduled satellite production before deferred backlog
      deferredIntoPeriod - deferred satellite backlog entering the period
      satelliteRequest - satellite request including scheduled and deferred production
      acceptedSatellite - accepted satellite production
      heldBackSatellite - satellite production not accepted in this period
      deferredToNextPeriod - satellite backlog carried to the next period
      satelliteAllocationScale - allocation scale applied to satellite production
      nameplateBottleneck - nameplate bottleneck category
      processModelUsed - true if an attached process model was checked
      processCapacityAvailable - true if process model capacity is available
      processBottleneck - process-model bottleneck name
      processBottleneckUtilization - process-model bottleneck utilization fraction
      processUtilizationSummary - process utilization summary by equipment name in percent
      deferredValueMusd - deferred value in MUSD before discounting
      deferredValueNpvMusd - deferred value in MUSD after discounting
      summary - concise text summary

  • Method Details

    • getPeriodName

      public String getPeriodName()
      Gets the period name.
      Returns:
      period name

    • getYear

      public int getYear()
      Gets the year.
      Returns:
      calendar year

    • getBaseRequest

      public ProductionLoad getBaseRequest()
      Gets requested base production.
      Returns:
      base production request

    • getAcceptedBase

      public ProductionLoad getAcceptedBase()
      Gets accepted base production.
      Returns:
      accepted base production

    • getScheduledSatellite

      public ProductionLoad getScheduledSatellite()
      Gets scheduled satellite production before deferred backlog.
      Returns:
      scheduled satellite production

    • getDeferredIntoPeriod

      public ProductionLoad getDeferredIntoPeriod()
      Gets deferred production entering the period.
      Returns:
      deferred satellite backlog entering the period

    • getSatelliteRequest

      public ProductionLoad getSatelliteRequest()
      Gets satellite request including scheduled and deferred production.
      Returns:
      satellite production request

    • getAcceptedSatellite

      public ProductionLoad getAcceptedSatellite()
      Gets accepted satellite production.
      Returns:
      accepted satellite production

    • getHeldBackSatellite

      public ProductionLoad getHeldBackSatellite()
      Gets satellite production held back in the period.
      Returns:
      held-back satellite production

    • getDeferredToNextPeriod

      public ProductionLoad getDeferredToNextPeriod()
      Gets satellite production deferred to the next period.
      Returns:
      deferred satellite production

    • getSatelliteAllocationScale

      public double getSatelliteAllocationScale()
      Gets the satellite allocation scale.
      Returns:
      scale from zero to one for accepted satellite production

    • getNameplateBottleneck

      public String getNameplateBottleneck()
      Gets the nameplate bottleneck.
      Returns:
      nameplate bottleneck category

    • isProcessModelUsed

      public boolean isProcessModelUsed()
      Checks whether a process model was used.
      Returns:
      true if a process model was used

    • isProcessCapacityAvailable

      public boolean isProcessCapacityAvailable()
      Checks whether process capacity is available.
      Returns:
      true if process model capacity is available

    • getProcessBottleneck

      public String getProcessBottleneck()
      Gets the process bottleneck.
      Returns:
      process bottleneck name, or null if none exists

    • getProcessBottleneckUtilization

      public double getProcessBottleneckUtilization()
      Gets the process bottleneck utilization.
      Returns:
      process bottleneck utilization as a fraction

    • getPrimaryBottleneck

      public String getPrimaryBottleneck()
      Gets the primary bottleneck, preferring process constraints over nameplate categories.
      Returns:
      primary bottleneck name

    • getProcessUtilizationSummary

      public Map<String,Double> getProcessUtilizationSummary()
      Gets process utilization summary.
      Returns:
      unmodifiable utilization summary in percent

    • getDeferredValueMusd

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

    • getDeferredValueNpvMusd

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

    • getSummary

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