ResSimpy.Nexus.DataModels.Network.NexusNode.NexusNode

class ResSimpy.Nexus.DataModels.Network.NexusNode.NexusNode(properties_dict: 'dict[str, None | int | str | float]')

Bases: Node

Public Data Attributes:

x_pos
y_pos
number
temp
station

Inherited from Node

name
type
depth
date
unit_system

Inherited from DataObjectMixin

id	Unique identifier for each object.

Methods:

__init__(properties_dict)
get_keyword_mapping()	Gets the mapping of nexus keywords to attribute definitions.
update(input_dictionary)	Updates a node based on a dictionary of attributes.
__repr__()	Return repr(self).
__eq__(other)	Return self==value.

Inherited from Node

__init__([_DataObjectMixin__id, name, type, ...])
__repr__()	Return repr(self).
__eq__(other)	Return self==value.

Inherited from DataObjectMixin

__init__(properties_dict)
to_dict([keys_in_keyword_style, add_date, ...])	Returns a dictionary of the attributes of the object.
to_table_line(headers)	Takes a generic Nexus object and returns the attribute values as a string in the order of headers provided.
get_keyword_mapping()	Gets the mapping of keywords to attribute definitions.
__repr__()	Return repr(self).
__eq__(other)	Return self==value.

---

__init__(properties_dict: dict[str, None | int | str | float]) → None

static get_keyword_mapping() → dict[str, tuple[str, type]]

Gets the mapping of nexus keywords to attribute definitions.

update(input_dictionary: dict[str, None | float | int | str]) → None

Updates a node based on a dictionary of attributes.

property id: UUID

Unique identifier for each object.

to_dict(keys_in_keyword_style: bool = False, add_date: bool = True, add_units: bool = True, include_nones: bool = True) → dict[str, None | str | int | float]

Returns a dictionary of the attributes of the object.

Parameters:

• include_nones (bool) –

• keys_in_keyword_style (bool) – if True returns the key values as simulator keywords, otherwise returns the attribute name as stored by ressimpy.

Returns:

a dictionary keyed by attributes and values as the value of the attribute

to_table_line(headers: list[str]) → str

Takes a generic Nexus object and returns the attribute values as a string in the order of headers provided. Requires an implemented to_dict method and get_keyword_mapping() method.

Parameters:

headers (list[str]) – list of header values in keyword format

Returns:

string of the values in the order of the headers provided.