code/network-generator/model/python/o_ran_du.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 distributed unit (ORanDu)
  19 """
  20 import model.python.hexagon as Hexagon
  21 from model.python.hexagon import Hex
  22 from model.python.cube import Cube
  23 from model.python.o_ran_ru import ORanRu
  24 from model.python.o_ran_object import IORanObject
  25 from model.python.o_ran_node import ORanNode
  26 import xml.etree.ElementTree as ET
  27
  28
  29 # Define the "IORanDu" interface
  30 class IORanDu(IORanObject):
  31     def __init__(self, o_ran_ru_count: int, **kwargs):
  32         super().__init__(**kwargs)
  33         self._o_ran_ru_count = o_ran_ru_count
  34
  35
  36 # Define an abstract O-RAN Node class
  37 class ORanDu(ORanNode, IORanDu):
  38     def __init__(self, o_ran_du_data: IORanDu = None, **kwargs):
  39         super().__init__(o_ran_du_data, **kwargs)
  40         self._o_ran_rus: list[ORanRu] = self._calculate_o_ran_rus()
  41
  42     def _calculate_o_ran_rus(self) -> list[ORanRu]:
  43         result: list[ORanRu] = []
  44         for index in range(self._o_ran_ru_count):
  45             s: str = "00" + str(index)
  46             name: str = "-".join(
  47                 [self.name.replace("DU", "RU"), s[len(s) - 2 : len(s)]]
  48             )
  49             network_center: dict = self.parent.parent.parent.parent.center
  50             newGeo = Hexagon.hex_to_geo_location(
  51                 self.layout, hex, network_center
  52             ).json()
  53             result.append(
  54                 ORanRu(
  55                     {
  56                         "name": name,
  57                         "geoLocation": newGeo,
  58                         "position": hex,
  59                         "layout": self.layout,
  60                         "spiralRadiusProfile": self.spiralRadiusProfile,
  61                         "parent": self,
  62                     }
  63                 )
  64             )
  65         return result
  66
  67     @property
  68     def o_ran_rus(self) -> list[ORanRu]:
  69         return self._o_ran_rus
  70
  71     def toKml(self) -> ET.Element:
  72         o_ran_du: ET.Element = ET.Element("Folder")
  73         open: ET.Element = ET.SubElement(o_ran_du, "open")
  74         open.text = "1"
  75         name: ET.Element = ET.SubElement(o_ran_du, "name")
  76         name.text = self.name
  77         for tower in self.towers:
  78             o_ran_du.append(tower.toKml())
  79         return o_ran_du
  80
  81     def toSvg(self) -> None:
  82         return None