resqpy.organize.GeobodyBoundaryInterpretation¶

class resqpy.organize.GeobodyBoundaryInterpretation(parent_model, uuid=None, title=None, genetic_boundary_feature=None, domain='depth', boundary_relation_list=None, originator=None, extra_metadata=None)¶

Bases: BaseResqpy

Class for RESQML Geobody Boundary Interpretation organizational objects.

Public Data Attributes:

`resqml_type`
`valid_domains`
`valid_boundary_relations`

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, title, ...])	Instantiate a GeobodyBoundaryInterpretation object.
`is_equivalent`(other[, check_extra_metadata])	Returns True if this interpretation is essentially the same as the other; otherwise False.
`create_xml`([genetic_boundary_feature_root, ...])	Create a organisational xml node from a geobody boundary interpretation object.

Inherited from BaseResqpy

`__init__`(parent_model[, uuid, title, ...])	Instantiate a GeobodyBoundaryInterpretation object.
`try_reuse`()	Look for an equivalent existing RESQML object and modify the uuid of this object if found.
`create_xml`([genetic_boundary_feature_root, ...])	Create a organisational xml node from a geobody boundary interpretation 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, title=None, genetic_boundary_feature=None, domain='depth', boundary_relation_list=None, originator=None, extra_metadata=None)[source]¶

Instantiate a GeobodyBoundaryInterpretation object.

Parameters

parent_model (model.Model) – Model to which the feature belongs
uuid (UUID, Optional) – The UUID of an existing Geobody Boundary Interpretation object; if present, all the other optional arguments are ignored
title (str, Optional) – Citation title when creating a new object
genetic_boundary_feature (GeneticBoundaryFeature,Optional) – Interpreted feature when creating a new object
domain (str,Optional) – One of (‘depth’, ‘time’, ‘mixed’) when creating a new object
boundary_relation_list (list,Optional) – Set of (‘conformable’, ‘unconformable below and above’, ‘unconformable above’, ‘unconformable below’) when creating a new object
extra_metadata (dict,Optional) – Extra metadata items added when creating a new 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(genetic_boundary_feature_root=None, add_as_part=True, add_relationships=True, originator=None, title_suffix=None, reuse=True)[source]¶: Create a organisational xml node from a geobody boundary interpretation object.

is_equivalent(other, check_extra_metadata=True)[source]¶: Returns True if this interpretation 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