resqpy.organize.structural_organization_interpretation.StructuralOrganizationInterpretation

class resqpy.organize.structural_organization_interpretation.StructuralOrganizationInterpretation[source]

Bases: BaseResqpy

Class for RESQML Structural Organization Interpretation organizational objects.

Public Data Attributes:

resqml_type

Inherited from BaseResqpy

`resqml_type`	Definition of which RESQML object the class represents.
`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__()

Initialise a structural organisation interpretation.

Inherited from BaseResqpy

`__init__`(model[, uuid, title, originator, ...])	Load an existing resqml object, or create new.
`try_reuse`()	Look for an equivalent existing RESQML object and modify the uuid of this object if found.
`create_xml`([title, originator, ...])	Write citation block to XML.
`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__()[source]: Initialise a structural organisation interpretation.

ordering_criterion: one of ‘age’ (youngest to oldest!), ‘apparent depth’, or ‘measured depth’

fault_uuid_list: list of uuids of fault interpretation which intersect the structural object

horizon_tuple_list: list of horizon interpretation uuids along with index and rank

sides_uuid_list: list of uuids of interpretation objects for sides of structural object

top_frontier_uuid_list: list of uuids of interpretation objects for top of structural object

bottom_frontier_uuid_list: list of uuids of interpretation objects for base of structural object

contact_interpretations: list of contact interpretations

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(title=None, originator=None, extra_metadata=None, add_as_part=False)

Write citation block to XML.

Note

add_as_part is False by default in this base method. Derived classes should typically extend this method to complete the XML representation, and then finally ensure the node is added as a part to the model.

Parameters:

title (string) – used as the citation Title text
originator (string, optional) – the name of the human being who created the deviation survey part; default is to use the login name
extra_metadata (dict, optional) – extra metadata items to be added
add_as_part (boolean) – if True, the newly created xml node is added as a part in the model

Returns:

node – the newly created root node

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