zepben.ewb 1.0.0b1__py3-none-any.whl

zepben/ewb/model/cim/iec61968/assets/asset.py

@@ -0,0 +1,154 @@
+#  Copyright 2024 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+from __future__ import annotations
+
+__all__ = ["Asset"]
+
+from typing import Optional, Generator, List, TYPE_CHECKING
+
+from zepben.ewb.model.cim.iec61970.base.core.identified_object import IdentifiedObject
+from zepben.ewb.util import get_by_mrid, nlen, ngen, safe_remove
+
+if TYPE_CHECKING:
+    from zepben.ewb.model.cim.iec61968.assets.asset_organisation_role import AssetOrganisationRole
+    from zepben.ewb.model.cim.iec61968.common.location import Location
+    from zepben.ewb.model.cim.iec61970.base.core.power_system_resource import PowerSystemResource
+
+
+class Asset(IdentifiedObject):
+    """
+    Tangible resource of the utility, including power system equipment, various end devices, cabinets, buildings,
+    etc. For electrical network equipment, the role of the asset is defined through PowerSystemResource and its
+    subclasses, defined mainly in the Wires model (refer to IEC61970-301 and model package IEC61970::Wires). Asset
+    description places emphasis on the physical characteristics of the equipment fulfilling that role.
+    """
+
+    location: Optional[Location] = None
+    """`zepben.ewb.model.cim.iec61968.common.location.Location` of this asset"""
+
+    _organisation_roles: Optional[List[AssetOrganisationRole]] = None
+
+    _power_system_resources: Optional[List[PowerSystemResource]] = None
+
+    def __init__(self, organisation_roles: List[AssetOrganisationRole] = None, power_system_resources: List[PowerSystemResource] = None, **kwargs):
+        super(Asset, self).__init__(**kwargs)
+        if organisation_roles:
+            for role in organisation_roles:
+                self.add_organisation_role(role)
+
+        if power_system_resources:
+            for resource in power_system_resources:
+                self.add_power_system_resource(resource)
+
+    def num_organisation_roles(self) -> int:
+        """
+        Get the number of `AssetOrganisationRole`s associated with this `Asset`.
+        """
+        return nlen(self._organisation_roles)
+
+    @property
+    def organisation_roles(self) -> Generator[AssetOrganisationRole, None, None]:
+        """
+        The `AssetOrganisationRole`s of this `Asset`.
+        """
+        return ngen(self._organisation_roles)
+
+    def get_organisation_role(self, mrid: str) -> AssetOrganisationRole:
+        """
+        Get the `AssetOrganisationRole` for this asset identified by `mrid`.
+
+        `mrid` the mRID of the required `AssetOrganisationRole`
+        Returns The `AssetOrganisationRole` with the specified `mrid`.
+        Raises `KeyError` if `mrid` wasn't present.
+        """
+        return get_by_mrid(self._organisation_roles, mrid)
+
+    def add_organisation_role(self, role: AssetOrganisationRole) -> Asset:
+        """
+        `role` The `AssetOrganisationRole` to associate with this `Asset`.
+        Returns A reference to this `Asset` to allow fluent use.
+        Raises `ValueError` if another `AssetOrganisationRole` with the same `mrid` already exists in this `Asset`
+        """
+        if self._validate_reference(role, self.get_organisation_role, "An AssetOrganisationRole"):
+            return self
+
+        self._organisation_roles = list() if self._organisation_roles is None else self._organisation_roles
+        self._organisation_roles.append(role)
+        return self
+
+    def remove_organisation_role(self, role: AssetOrganisationRole) -> Asset:
+        """
+        Disassociate an `AssetOrganisationRole` from this `Asset`.
+
+        `role` the `AssetOrganisationRole` to disassociate from this `Asset`.
+        Raises `ValueError` if `role` was not associated with this `Asset`.
+        Returns A reference to this `Asset` to allow fluent use.
+        """
+        self._organisation_roles = safe_remove(self._organisation_roles, role)
+        return self
+
+    def clear_organisation_roles(self) -> Asset:
+        """
+        Clear all organisation roles.
+        Returns self
+        """
+        self._organisation_roles = None
+        return self
+
+    def num_power_system_resources(self) -> int:
+        """
+        Get the number of `PowerSystemResource`s associated with this `Asset`.
+        """
+        return nlen(self._power_system_resources)
+
+    @property
+    def power_system_resources(self) -> Generator[PowerSystemResource, None, None]:
+        """
+        The `PowerSystemResource`s of this `Asset`.
+        """
+        return ngen(self._power_system_resources)
+
+    def get_power_system_resource(self, mrid: str) -> PowerSystemResource:
+        """
+        Get the `PowerSystemResource` for this asset identified by `mrid`.
+
+        `mrid` the mRID of the required `PowerSystemResource`
+        Returns The `PowerSystemResource` with the specified `mrid`.
+        Raises `KeyError` if `mrid` wasn't present.
+        """
+        return get_by_mrid(self._power_system_resources, mrid)
+
+    def add_power_system_resource(self, resource: PowerSystemResource) -> Asset:
+        """
+        `resource` The `PowerSystemResource` to associate with this `Asset`.
+        Returns A reference to this `Asset` to allow fluent use.
+        Raises `ValueError` if another `PowerSystemResource` with the same `mrid` already exists in this `Asset`
+        """
+        if self._validate_reference(resource, self.get_power_system_resource, "An PowerSystemResource"):
+            return self
+
+        self._power_system_resources = list() if self._power_system_resources is None else self._power_system_resources
+        self._power_system_resources.append(resource)
+        return self
+
+    def remove_power_system_resource(self, resource: PowerSystemResource) -> Asset:
+        """
+        Disassociate an `PowerSystemResource` from this `Asset`.
+
+        `resource` the `PowerSystemResource` to disassociate from this `Asset`.
+        Raises `ValueError` if `resource` was not associated with this `Asset`.
+        Returns A reference to this `Asset` to allow fluent use.
+        """
+        self._power_system_resources = safe_remove(self._power_system_resources, resource)
+        return self
+
+    def clear_power_system_resources(self) -> Asset:
+        """
+        Clear all power system resources.
+        Returns self
+        """
+        self._power_system_resources = None
+        return self

zepben/ewb/model/cim/iec61968/assets/asset_container.py

@@ -0,0 +1,16 @@
+#  Copyright 2025 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["AssetContainer"]
+
+from zepben.ewb.model.cim.iec61968.assets.asset import Asset
+
+
+class AssetContainer(Asset):
+    """
+    Asset that is aggregation of other assets such as conductors, transformers, switchgear, land, fences, buildings,
+    equipment, vehicles, etc.
+    """
+    pass

zepben/ewb/model/cim/iec61968/assets/asset_function.py

@@ -0,0 +1,15 @@
+#  Copyright 2024 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["AssetFunction"]
+
+from zepben.ewb.model.cim.iec61970.base.core.identified_object import IdentifiedObject
+
+
+class AssetFunction(IdentifiedObject):
+    """
+    Function performed by an asset.
+    """
+    pass

zepben/ewb/model/cim/iec61968/assets/asset_info.py

@@ -0,0 +1,19 @@
+#  Copyright 2024 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["AssetInfo"]
+
+from zepben.ewb.model.cim.iec61970.base.core.identified_object import IdentifiedObject
+
+
+class AssetInfo(IdentifiedObject):
+    """
+    Set of attributes of an asset, representing typical datasheet information of a physical device that can be
+    instantiated and shared in different data exchange contexts:
+        - as attributes of an asset instance (installed or in stock)
+        - as attributes of an asset model (product by a manufacturer)
+        - as attributes of a type asset (generic type of an asset as used in designs/extension planning).
+    """
+    pass

zepben/ewb/model/cim/iec61968/assets/asset_organisation_role.py

@@ -0,0 +1,13 @@
+#  Copyright 2024 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["AssetOrganisationRole"]
+
+from zepben.ewb.model.cim.iec61968.common.organisation_role import OrganisationRole
+
+
+class AssetOrganisationRole(OrganisationRole):
+    """ Role an organisation plays with respect to asset. """
+    pass

zepben/ewb/model/cim/iec61968/assets/asset_owner.py

@@ -0,0 +1,13 @@
+#  Copyright 2025 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["AssetOwner"]
+
+from zepben.ewb.model.cim.iec61968.assets.asset_organisation_role import AssetOrganisationRole
+
+
+class AssetOwner(AssetOrganisationRole):
+    """ Owner of the Asset """
+    pass

zepben/ewb/model/cim/iec61968/assets/streetlight.py

@@ -0,0 +1,29 @@
+#  Copyright 2024 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["Streetlight"]
+
+from typing import Optional, TYPE_CHECKING
+
+from zepben.ewb.model.cim.iec61968.assets.asset import Asset
+from zepben.ewb.model.cim.iec61968.infiec61968.infassets.streetlight_lamp_kind import StreetlightLampKind
+
+if TYPE_CHECKING:
+    from zepben.ewb.model.cim.iec61968.infiec61968.infassets.pole import Pole
+
+
+class Streetlight(Asset):
+    """
+    A Streetlight asset.
+    """
+
+    pole: Optional['Pole'] = None
+    """The `zepben.ewb.model.cim.iec61968.assets.pole.Pole` this Streetlight is attached to."""
+
+    light_rating: Optional[int] = None
+    """The power rating of the light in watts."""
+
+    lamp_kind: StreetlightLampKind = StreetlightLampKind.UNKNOWN
+    """The kind of lamp."""

zepben/ewb/model/cim/iec61968/assets/structure.py

@@ -0,0 +1,16 @@
+#  Copyright 2024 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["Structure"]
+
+from zepben.ewb.model.cim.iec61968.assets.asset_container import AssetContainer
+
+
+class Structure(AssetContainer):
+    """
+    Construction holding assets such as conductors, transformers, switchgear, etc. Where applicable, number of conductors
+    can be derived from the number of associated wire spacing instances.
+    """
+    pass

zepben/ewb/model/cim/iec61968/common/__init__.py

@@ -0,0 +1,4 @@
+#  Copyright 2024 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.

zepben/ewb/model/cim/iec61968/common/agreement.py

@@ -0,0 +1,16 @@
+#  Copyright 2025 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["Agreement"]
+
+from zepben.ewb.model.cim.iec61968.common.document import Document
+
+
+class Agreement(Document):
+    """
+    Formal agreement between two parties defining the terms and conditions for a set of services. The specifics of
+    the services are, in turn, defined via one or more service agreements.
+    """
+    pass

zepben/ewb/model/cim/iec61968/common/document.py

@@ -0,0 +1,36 @@
+#  Copyright 2024 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["Document"]
+
+from datetime import datetime
+from typing import Optional
+
+from zepben.ewb.model.cim.iec61970.base.core.identified_object import IdentifiedObject
+
+
+class Document(IdentifiedObject):
+    """
+    Parent class for different groupings of information collected and managed as a part of a business process.
+    It will frequently contain references to other objects, such as assets, people and power system resources.
+    """
+    title: str = ""
+    """Document title."""
+
+    created_date_time: Optional[datetime] = None
+    """Date and time that this document was created."""
+
+    author_name: str = ""
+    """Name of the author of this document."""
+
+    type: str = ""
+    """Utility-specific classification of this document, according to its corporate standards, practices, 
+    and existing IT systems (e.g., for management of assets, maintenance, work, outage, customers, etc.)."""
+
+    status: str = ""
+    """Status of subject matter (e.g., Agreement, Work) this document represents."""
+
+    comment: str = ""
+    """Free text comment"""

zepben/ewb/model/cim/iec61968/common/location.py

@@ -0,0 +1,129 @@
+#  Copyright 2024 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+from __future__ import annotations
+
+__all__ = ["Location"]
+
+from typing import List, Optional, Generator, Callable
+
+from zepben.ewb.model.cim.iec61968.common.position_point import PositionPoint
+from zepben.ewb.model.cim.iec61968.common.street_address import StreetAddress
+from zepben.ewb.model.cim.iec61970.base.core.identified_object import IdentifiedObject
+from zepben.ewb.util import require, nlen, ngen, safe_remove
+
+
+class Location(IdentifiedObject):
+    """
+    The place, scene, or point of something where someone or something has been, is, and/or will be at a given moment in time.
+    It can be defined with one or more `PositionPoint`'s.
+    """
+    main_address: Optional[StreetAddress] = None
+    """Main address of the location."""
+
+    _position_points: Optional[List[PositionPoint]] = None
+
+    def __init__(self, position_points: List[PositionPoint] = None, **kwargs):
+        """
+        `position_points` A list of `PositionPoint`s to associate with this `Location`.
+        """
+        super(Location, self).__init__(**kwargs)
+        if position_points:
+            for point in position_points:
+                self.add_point(point)
+
+    def num_points(self):
+        """
+        Returns The number of `PositionPoint`s in this `Location`
+        """
+        return nlen(self._position_points)
+
+    @property
+    def points(self) -> Generator[PositionPoint, None, None]:
+        """
+        Returns Generator over the `PositionPoint`s of this `Location`.
+        """
+        for point in ngen(self._position_points):
+            yield point
+
+    def get_point(self, sequence_number: int) -> PositionPoint:
+        """
+        Get the `sequence_number` `PositionPoint` for this `Location`.
+
+        `sequence_number` The sequence number of the `PositionPoint` to get.
+        Returns The `PositionPoint` identified by `sequence_number`
+        Raises IndexError if this `Location` didn't contain `sequence_number` points.
+        """
+        return self._position_points[sequence_number]
+
+    def __getitem__(self, item):
+        return self.get_point(item)
+
+    def for_each_point(self, action: Callable[[int, PositionPoint], None]):
+        """
+        Call the `action` on each :class:`PositionPoint` in the `points` collection
+
+        :param action: An action to apply to each :class:`PositionPoint` in the `points` collection, taking the index of the point, and the point itself.
+        """
+        for index, point in enumerate(self.points):
+            action(index, point)
+
+    def add_point(self, point: PositionPoint) -> Location:
+        """
+        Associate a `PositionPoint` with this `Location`, assigning it a sequence_number of `num_points`.
+        `point` The `PositionPoint` to associate with this `Location`.
+        Returns A reference to this `Location` to allow fluent use.
+        """
+        return self.insert_point(point)
+
+    def insert_point(self, point: PositionPoint, sequence_number: int = None) -> Location:
+        """
+        Associate a `PositionPoint` with this `Location`
+
+        `point` The `PositionPoint` to associate with this `Location`.
+        `sequence_number` The sequence number of the `PositionPoint`.
+        Returns A reference to this `Location` to allow fluent use.
+        Raises `ValueError` if `sequence_number` < 0 or > `num_points()`.
+        """
+        if sequence_number is None:
+            sequence_number = self.num_points()
+        require(0 <= sequence_number <= self.num_points(),
+                lambda: f"Unable to add PositionPoint to {str(self)}. Sequence number {sequence_number} "
+                        f"is invalid. Expected a value between 0 and {self.num_points()}. Make sure you are "
+                        f"adding the items in order and there are no gaps in the numbering.")
+        self._position_points = list() if self._position_points is None else self._position_points
+        self._position_points.insert(sequence_number, point)
+        return self
+
+    def __setitem__(self, key, value):
+        return self.insert_point(value, key)
+
+    def remove_point(self, point: PositionPoint) -> Location:
+        """
+        Remove a `PositionPoint` from this `Location`
+        `point` The `PositionPoint` to remove.
+        Raises `ValueError` if `point` was not part of this `Location`
+        Returns A reference to this `Location` to allow fluent use.
+        """
+        self._position_points = safe_remove(self._position_points, point)
+        return self
+
+    def remove_point_by_sequence_number(self, sequence_number: int) -> PositionPoint:
+        """
+        Remove a :class:`PositionPoint` from this :class:`Location` by its sequence number.
+
+        NOTE: This will update the sequence numbers of all items located after the removed sequence number.
+
+        :param sequence_number: The sequence number of the `PositionPoint` to remove.
+        :return: The :class:`PositionPoint` that was removed, or null if there was no :class:`PositionPoint` for the given `sequenceNumber`.
+        :raises IndexError: If no :class:`PositionPoint` with the specified `sequence_number` was not associated with this :class:`Location`.
+        """
+        point = self.get_point(sequence_number)
+        self._position_points = safe_remove(self._position_points, point)
+        return point
+
+    def clear_points(self) -> Location:
+        self._position_points = None
+        return self

zepben/ewb/model/cim/iec61968/common/organisation.py

@@ -0,0 +1,15 @@
+#  Copyright 2024 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["Organisation"]
+
+from zepben.ewb.model.cim.iec61970.base.core.identified_object import IdentifiedObject
+
+
+class Organisation(IdentifiedObject):
+    """
+    Organisation that might have roles as utility, contractor, supplier, manufacturer, customer, etc.
+    """
+    pass

zepben/ewb/model/cim/iec61968/common/organisation_role.py

@@ -0,0 +1,22 @@
+#  Copyright 2024 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["OrganisationRole"]
+
+from typing import Optional, TYPE_CHECKING
+
+from zepben.ewb.model.cim.iec61970.base.core.identified_object import IdentifiedObject
+
+if TYPE_CHECKING:
+    from zepben.ewb.model.cim.iec61968.common.organisation import Organisation
+
+
+class OrganisationRole(IdentifiedObject):
+    """
+    Identifies a way in which an organisation may participate in the utility enterprise (e.g., customer, manufacturer, etc).
+    """
+
+    organisation: Optional['Organisation'] = None
+    """The `zepben.ewb.model.cim.iec61968.common.organisation.Organisation` having this role."""

zepben/ewb/model/cim/iec61968/common/position_point.py

@@ -0,0 +1,44 @@
+#  Copyright 2025 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["PositionPoint"]
+
+from dataclasses import dataclass
+
+from zepben.ewb.util import require
+
+
+@dataclass(frozen=True)
+class PositionPoint(object):
+    """
+    Set of spatial coordinates that determine a point, defined in WGS84 (latitudes and longitudes).
+
+    Use a single position point instance to describe a point-oriented location.
+    Use a sequence of position points to describe a line-oriented object (physical location of non-point oriented
+    objects like cables or lines), or area of an object (like a substation or a geographical zone - in this case,
+    have first and last position point with the same values).
+    """
+
+    x_position: float
+    """X axis position - longitude"""
+    y_position: float
+    """Y axis position - latitude"""
+
+    def __post_init__(self):
+        require(-90.0 <= self.y_position <= 90.0,
+                lambda: f"Latitude is out of range. Expected -90 to 90, got {self.y_position}.")
+        require(-180.0 <= self.x_position <= 180.0,
+                lambda: f"Longitude is out of range. Expected -180 to 180, got {self.x_position}.")
+
+    def __str__(self):
+        return f"{self.x_position}:{self.y_position}"
+
+    @property
+    def longitude(self):
+        return self.x_position
+
+    @property
+    def latitude(self):
+        return self.y_position

zepben/ewb/model/cim/iec61968/common/street_address.py

@@ -0,0 +1,28 @@
+#  Copyright 2025 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["StreetAddress"]
+
+from dataclasses import dataclass
+from typing import Optional
+
+from zepben.ewb.model.cim.iec61968.common.street_detail import StreetDetail
+from zepben.ewb.model.cim.iec61968.common.town_detail import TownDetail
+
+
+@dataclass
+class StreetAddress(object):
+    """
+    General purpose street and postal address information.
+    """
+
+    postal_code: str = ""
+    """Postal code for the address."""
+    town_detail: Optional[TownDetail] = None
+    """Optional `TownDetail` for this address."""
+    po_box: str = ""
+    """Post office box for the address."""
+    street_detail: Optional[StreetDetail] = None
+    """Optional `StreetDetail` for this address."""

zepben/ewb/model/cim/iec61968/common/street_detail.py

@@ -0,0 +1,45 @@
+#  Copyright 2025 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["StreetDetail"]
+
+from dataclasses import dataclass
+
+
+@dataclass
+class StreetDetail(object):
+    """
+    Street details, in the context of address.
+    """
+
+    building_name: str = ""
+    """
+    (if applicable) In certain cases the physical location of the place of interest does not have a direct point of entry from the street, 
+    but may be located inside a larger structure such as a building, complex, office block, apartment, etc.
+    """
+    floor_identification: str = ""
+    """The identification by name or number, expressed as text, of the floor in the building as part of this address."""
+    name: str = ""
+    """Name of the street."""
+    number: str = ""
+    """Designator of the specific location on the street."""
+    suite_number: str = ""
+    """Number of the apartment or suite."""
+    type: str = ""
+    """Type of street. Examples include: street, circle, boulevard, avenue, road, drive, etc."""
+    display_address: str = ""
+    """The address as it should be displayed to a user."""
+
+    def all_fields_empty(self):
+        """Check to see if all fields of this `StreetDetail` are empty."""
+        return not (
+            self.building_name or
+            self.floor_identification or
+            self.name or
+            self.number or
+            self.suite_number or
+            self.type or
+            self.display_address
+        )

zepben/ewb/model/cim/iec61968/common/town_detail.py

@@ -0,0 +1,25 @@
+#  Copyright 2025 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+__all__ = ["TownDetail"]
+
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class TownDetail(object):
+    """
+    Town details, in the context of address.
+    """
+
+    name: Optional[str] = None
+    """Town name."""
+    state_or_province: Optional[str] = None
+    """Name of the state or province."""
+
+    def all_fields_null_or_empty(self):
+        """Check to see if all fields of this `TownDetail` are null or empty."""
+        return not (self.name or self.state_or_province)

zepben/ewb/model/cim/iec61968/customers/__init__.py

@@ -0,0 +1,4 @@
+#  Copyright 2024 Zeppelin Bend Pty Ltd
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.