kappa_sdk.WellProperty#

class kappa_sdk.WellProperty(alias, name, well_property_type, measure=None, comment='', is_built_in=False, to_be_extracted=False, xml_path=None)[source]#

Well Property object.

Presents a KAPPA Automate Well Property object.

Attributes

WellProperty.alias

Gets the alias of the WellProperty object.

WellProperty.comment

Gets the comment of the WellProperty object.

WellProperty.is_built_in

if the WellProperty object is a built-in Well Property.

WellProperty.measure

Gets the measure of the WellProperty object.

WellProperty.name

Gets the name of the WellProperty object.

WellProperty.to_be_extracted

if the WellProperty object is to be extracted during ipta.

WellProperty.type

Gets the type of the WellProperty object.

WellProperty.xml_path

The xml path of the WellProperty object.

Methods

Parameters:

  • alias (str)

  • name (str)

  • well_property_type (WellPropertyType)

  • measure (str | MeasureEnum | None)

  • comment (str)

  • is_built_in (bool)

  • to_be_extracted (bool)

  • xml_path (str | None)

__init__(alias, name, well_property_type, measure=None, comment='', is_built_in=False, to_be_extracted=False, xml_path=None)[source]#
Parameters:

  • alias (str)

  • name (str)

  • well_property_type (WellPropertyType)

  • measure (str | MeasureEnum | None)

  • comment (str)

  • is_built_in (bool)

  • to_be_extracted (bool)

  • xml_path (str | None)

property alias: str#

Gets the alias of the WellProperty object.

property name: str#

Gets the name of the WellProperty object.

property type: WellPropertyType#

Gets the type of the WellProperty object.

property measure: str | MeasureEnum | None#

Gets the measure of the WellProperty object.

property comment: str#

Gets the comment of the WellProperty object.

property is_built_in: bool#

if the WellProperty object is a built-in Well Property.

property to_be_extracted: bool#

if the WellProperty object is to be extracted during ipta.

property xml_path: str | None#

The xml path of the WellProperty object. Only works is to be extracted is set up to true.