Source code for kappa_sdk.plots_enum

from enum import Enum
from pydantic import BaseModel
from .measure_enum import MeasureEnum
from typing import Optional


class PlotProperties(BaseModel):
    show_symbols: Optional[bool] = None
    show_lines: bool = True
    channel_name: Optional[str] = None
    is_by_step: bool = False
    x_measure: Optional[MeasureEnum] = MeasureEnum.no_unit
    y_measure: Optional[MeasureEnum] = MeasureEnum.no_unit
    is_y_log: bool = False
    first_x: Optional[str] = None
    use_elapsed: bool = False
    hide_in_legend: bool = False
    is_raw: bool = False




class LineAspectEnum(Enum):
    empty = "Empty"
    solid = "Solid"
    dash = "Dash"
    dot = "Dot"
    dash_dot = "DashDot"
    dash_dot_dot = "DashDotDot"





class SymbolAspectEnum(Enum):
    non = "None"
    square = "Square"
    circle = "Circle"
    plus = "Plus"
    cross = "Cross"
    star = "Star"
    diamond = "Diamond"
    triangle = "Triangle"
    inv_triangle = "InvTriangle"
    crossed_square = "CrossedSquare"
    crossed_circle = "CrossedCircle"
    crossed_triangle = "CrossedTriangle"
    crossed_inv_triangle = "CrossedInvTriangle"
    plus_circle = "PlusCircle"
    plus_triangle = "PlusTriangle"
    plus_inv_triangle = "PlusInvTriangle"
    arrow_up = "ArrowUp"
    arrow_down = "ArrowDown"
    vertical_dash = "VerticalDash"
    left_triangle = "LeftTriangle"
    right_triangle = "RightTriangle"





class DrawingStyle(Enum):
    as_channel = "AsChannel"
    as_vertical_line = "AsVerticalLine"
    as_bar = "AsBar"





class PlotDataTypesEnum(Enum):
    """
    Unit enumeration.

    An enumeration of the data types that are supported by the :class:'Plot'.

    """
    production_time = "t"
    absolute_time = "tabs"
    gas_rate_surface = "qg"
    oil_rate_surface = "qo"
    water_rate_surface = "qw"
    total_liquid_rate = "ql"
    liquid_rate_surface = "qsl"
    surface_injection_gas_rate = "qgi"
    gas_rate_downhole = "qgd"
    oil_rate_downhole = "qod"
    water_rate_downhole = "qwd"
    gas_volume = "Qg"
    oil_volume = "Qo"
    water_volume = "Qw"
    total_liquid_volume = "Ql"
    pressure = "P"
    bottom_hole_pressure = "BHP"
    wellhead_pressure = "WHP"
    casing_head_pressure = "CHP"
    casing_then_tubing_pressure = "CTP"
    tubing_head_pressure = "THP"
    total_static_pressure = "TSP"
    gas_injection_pressure = "Pgi"
    bottom_hole_temperature = "BHT"
    wellhead_temperature = "WHT"
    casing_head_temperature = "CHT"
    casing_then_tubing_temperature = "CTT"
    tubing_head_temperature = "THT"
    gas_oil_ratio = "GOR"
    water_cut = "WC"
    water_oil_ratio = "WOR"
    water_gas_ratio = "WGR"
    liquid_gas_ratio = "LGR"
    condensate_gas_ratio = "CGR"
    choke_size = "ID"
    shutin = "SI"
    fraction = "frac"
    logical = "lo"
    power = "po"
    frequency = "freq"
    oil_productivity_index = "PIo"
    gas_productivity_index = "PIg"
    water_productivity_index = "PIw"
    unspecified_datatype = "Unspecified"