Source code for kappa_sdk.pta_extraction

from datetime import datetime
from .vector import Vector




class PTAExtraction:
    """
    Class to store the result of a PTA Extraction from Shut-in. This class is read-only.
    """

    def __init__(self, start_date: datetime, end_date: datetime, pressure_id: str, log_log_dp: Vector, bourdet_derivative: Vector, last_flowing_pressure: float,
                 reference_rate: float, reference_rate_user_measure: str, is_multiphase_extraction: bool):
        self.__start_date: datetime = start_date
        self.__end_date: datetime = end_date
        self.__pressure_id = pressure_id
        self.__log_log_dp: Vector = log_log_dp
        self.__bourdet_derivative: Vector = bourdet_derivative
        self.__last_flowing_pressure: float = last_flowing_pressure
        self.__reference_rate: float = reference_rate
        self.__reference_rate_user_measure: str = reference_rate_user_measure
        self.__is_multiphase_extraction: bool = is_multiphase_extraction

    @property
    def start_date(self) -> datetime:
        """ Gets the start date for this :class:`PTAExtractionIdentifier`."""
        return self.__start_date

    @property
    def end_date(self) -> datetime:
        """ Gets the end date for this :class:`PTAExtractionIdentifier`."""
        return self.__end_date

    @property
    def pressure_id(self) -> str:
        """ Gets the pressure id for this :class:`PTAExtractionIdentifier`."""
        return self.__pressure_id

    @property
    def log_log_dp(self) -> Vector:
        """ Gets the loglog for this :class:`PTAExtraction`."""
        return self.__log_log_dp

    @property
    def bourdet_derivative(self) -> Vector:
        """ Gets the bourdet derivative for this :class:`PTAExtraction`."""
        return self.__bourdet_derivative

    @property
    def last_flowing_pressure(self) -> float:
        """ Gets the last flowing pressure for this :class:`PTAExtractionProperties`."""
        return self.__last_flowing_pressure

    @property
    def reference_rate(self) -> float:
        """ Gets the reference rate for this :class:`PTAExtractionProperties`."""
        return self.__reference_rate

    @property
    def reference_rate_user_measure(self) -> str:
        """ Gets the reference rate user measure for this :class:`PTAExtractionProperties`."""
        return self.__reference_rate_user_measure

    @property
    def is_multiphase_extraction(self) -> bool:
        """ If :class:`PTAExtractionProperties` is multiphase extraction or not."""
        return self.__is_multiphase_extraction