resqpy.organize.FluidBoundaryFeature¶
- class resqpy.organize.FluidBoundaryFeature(parent_model, uuid=None, kind=None, feature_name=None, originator=None, extra_metadata=None)¶
Bases:
BaseResqpy
Class for RESQML Fluid Boundary Feature (contact) organizational objects.
Public Data Attributes:
resqml_type
Alias for title
valid_kinds
Inherited from
BaseResqpy
resqml_type
Standard part name corresponding to self.uuid.
XML node corresponding to self.uuid.
Citation block title equivalent to self.title.
Methods:
__init__
(parent_model[, uuid, kind, ...])Initialises a fluid boundary feature (contact) 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, originator, reuse])Creates a fluid boundary feature organisational xml node from this fluid boundary feature object.
Inherited from
BaseResqpy
__init__
(parent_model[, uuid, kind, ...])Initialises a fluid boundary feature (contact) organisational object.
Look for an equivalent existing RESQML object and modify the uuid of this object if found.
create_xml
([add_as_part, originator, reuse])Creates a fluid boundary feature organisational xml node from this fluid boundary 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, kind=None, feature_name=None, originator=None, extra_metadata=None)[source]¶
Initialises a fluid boundary feature (contact) 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, originator=None, reuse=True)[source]¶
Creates a fluid boundary feature organisational xml node from this fluid boundary 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