code/network-generator/network_generation/model/python/o_ran_near_rt_ric.py

   1 # Copyright 2023 highstreet technologies GmbH
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 #!/usr/bin/python
  16
  17 """
  18 A Class representing an O-RAN Near real-time intelligent controller (ORanNearRtRic)
  19 """
  20 import xml.etree.ElementTree as ET
  21 from typing import overload
  22
  23 import network_generation.model.python.hexagon as Hexagon
  24 from network_generation.model.python.hexagon import Hex
  25 from network_generation.model.python.o_ran_cu import ORanCu
  26 from network_generation.model.python.o_ran_node import ORanNode
  27 from network_generation.model.python.o_ran_object import IORanObject
  28 from network_generation.model.python.o_ran_termination_point import (
  29     ORanTerminationPoint,
  30 )
  31 from network_generation.model.python.tower import Tower
  32
  33
  34 # Define the "IORanNearRtRic" interface
  35 class IORanNearRtRic(IORanObject):
  36     def __init__(self, **kwargs):
  37         super().__init__(**kwargs)
  38
  39
  40 # Define an abstract O-RAN Node class
  41 class ORanNearRtRic(ORanNode, IORanNearRtRic):
  42     def __init__(
  43         self, o_ran_near_rt_ric_data: IORanNearRtRic = None, **kwargs
  44     ):
  45         super().__init__(o_ran_near_rt_ric_data, **kwargs)
  46         self._o_ran_cus: list[ORanCu] = self._calculate_o_ran_cus()
  47
  48     def _calculate_o_ran_cus(self) -> list[ORanCu]:
  49         hex_ring_radius: int = (
  50             self.spiralRadiusProfile.oRanNearRtRicSpiralRadiusOfOCus
  51         )
  52         hex_list: list[Hex] = self.spiralRadiusProfile.oRanCuSpiral(
  53             self.position, hex_ring_radius
  54         )
  55         result: list[ORanCu] = []
  56         for index, hex in enumerate(hex_list):
  57             s: str = "00" + str(index)
  58             name: str = "-".join(
  59                 [self.name.replace("NearRtRic", "CU"), s[len(s) - 2 : len(s)]]
  60             )
  61             network_center: dict = self.parent.parent.center
  62             newGeo = Hexagon.hex_to_geo_location(
  63                 self.layout, hex, network_center
  64             ).json()
  65             result.append(
  66                 ORanCu(
  67                     {
  68                         "name": name,
  69                         "geoLocation": newGeo,
  70                         "position": hex,
  71                         "layout": self.layout,
  72                         "spiralRadiusProfile": self.spiralRadiusProfile,
  73                         "parent": self,
  74                     }
  75                 )
  76             )
  77         return result
  78
  79     @property
  80     def o_ran_cus(self) -> list[ORanCu]:
  81         return self._o_ran_cus
  82
  83     @property
  84     def towers(self) -> list[Tower]:
  85         result: list[Tower] = []
  86         for cu in self.o_ran_cus:
  87             for tower in cu.towers:
  88                 result.append(tower)
  89         return result
  90
  91     @property
  92     def termination_points(self) -> list[ORanTerminationPoint]:
  93         result: list[ORanTerminationPoint] = super().termination_points
  94         phy_tp: str = "-".join([self.name, "phy".upper()])
  95         result.append({"tp-id": phy_tp, "name": phy_tp})
  96         for interface in ["a1", "o1", "o2", "e2"]:
  97             id: str = "-".join([self.name, interface.upper()])
  98             result.append(
  99                 ORanTerminationPoint(
 100                     {"id": id, "name": id, "supporter": phy_tp, "parent": self}
 101                 )
 102             )
 103         return result
 104
 105     def to_topology_nodes(self) -> list[dict[str, dict]]:
 106         result: list[dict[str, dict]] = super().to_topology_nodes()
 107         for o_ran_cu in self.o_ran_cus:
 108             result.extend(o_ran_cu.to_topology_nodes())
 109         return result
 110
 111     def to_topology_links(self) -> list[dict[str, dict]]:
 112         result: list[dict[str, dict]] = super().to_topology_links()
 113         for o_ran_cu in self.o_ran_cus:
 114             result.extend(o_ran_cu.to_topology_links())
 115         return result
 116
 117     def toKml(self) -> ET.Element:
 118         ric: ET.Element = ET.Element("Folder")
 119         open: ET.Element = ET.SubElement(ric, "open")
 120         open.text = "1"
 121         name: ET.Element = ET.SubElement(ric, "name")
 122         name.text = self.name
 123         for o_ran_cu in self.o_ran_cus:
 124             ric.append(o_ran_cu.toKml())
 125         return ric
 126
 127     def toSvg(self) -> None:
 128         return None