resqpy.organize.RockFluidUnitFeature

class resqpy.organize.RockFluidUnitFeature(parent_model, uuid=None, phase=None, feature_name=None, top_boundary_feature=None, base_boundary_feature=None, extra_metadata=None)

Bases: BaseResqpy

Class for RESQML Rock Fluid Unit Feature organizational objects.

Public Data Attributes:

resqml_type

feature_name

Alias for title

valid_phases

Inherited from BaseResqpy

resqml_type

part

Standard part name corresponding to self.uuid.

root

XML node corresponding to self.uuid.

citation_title

Citation block title equivalent to self.title.

Methods:

__init__(parent_model[, uuid, phase, ...])

Initialises a rock fluid unit feature organisational object.

is_equivalent(other[, check_extra_metadata])

Returns True if this feature is essentially the same as the other; otherwise False.

create_xml([add_as_part, add_relationships, ...])

Creates a rock fluid unit feature organisational xml node from this rock fluid unit feature object.

Inherited from BaseResqpy

__init__(parent_model[, uuid, phase, ...])

Initialises a rock fluid unit feature organisational object.

try_reuse()

Look for an equivalent existing RESQML object and modify the uuid of this object if found.

create_xml([add_as_part, add_relationships, ...])

Creates a rock fluid unit feature organisational xml node from this rock fluid unit feature object.

append_extra_metadata(meta_dict)

Append a given dictionary of metadata to the existing metadata.

__eq__(other)

Implements equals operator; uses is_equivalent() otherwise compares class type and uuid.

__ne__(other)

Implements not equal operator.

__repr__()

String representation.


__init__(parent_model, uuid=None, phase=None, feature_name=None, top_boundary_feature=None, base_boundary_feature=None, extra_metadata=None)[source]

Initialises a rock fluid unit feature organisational object.

append_extra_metadata(meta_dict)

Append a given dictionary of metadata to the existing metadata.

property citation_title

Citation block title equivalent to self.title.

create_xml(add_as_part=True, add_relationships=True, originator=None, reuse=True)[source]

Creates a rock fluid unit feature organisational xml node from this rock fluid unit feature object.

property feature_name

Alias for title

is_equivalent(other, check_extra_metadata=True)[source]

Returns True if this feature is essentially the same as the other; otherwise False.

property part

Standard part name corresponding to self.uuid.

property root

XML node corresponding to self.uuid.

try_reuse()

Look for an equivalent existing RESQML object and modify the uuid of this object if found.

Returns

boolean – True if an equivalent object was found, False if not

Note

by design this method may change this object’s uuid as a side effect

title

Citation title

originator

Creator of object. By default, user id.

uuid

Unique identifier