resqpy.organize.OrganizationFeature

class resqpy.organize.OrganizationFeature(parent_model, uuid=None, feature_name=None, organization_kind=None, originator=None, extra_metadata=None)

Bases: BaseResqpy

Class for generic RESQML Organization Feature objects.

Public Data Attributes:

resqml_type
valid_kinds
feature_name	Alias for title

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__(parent_model[, uuid, feature_name, ...])	Initialises an organization feature 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 an organization feature xml node from this organization feature object.

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__(parent_model, uuid=None, feature_name=None, organization_kind=None, originator=None, extra_metadata=None)

Initialises an organization feature 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)

Creates an organization feature xml node from this organization feature object.

property feature_name

Alias for title

is_equivalent(other, check_extra_metadata=True)

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