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.tower import Tower
  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, **kwargs):
  32         super().__init__(**kwargs)
  33
  34
  35 # Define an abstract O-RAN Node class
  36 class ORanDu(ORanNode, IORanDu):
  37     def __init__(self, o_ran_du_data: IORanDu = None, **kwargs):
  38         super().__init__(o_ran_du_data, **kwargs)
  39         self._towers: list[Tower] = self._calculate_towers()
  40
  41     def _calculate_towers(self) -> list[Tower]:
  42         hex_ring_radius: int = self.spiralRadiusProfile.oRanDuSpiralRadiusOfTowers
  43         hex_list: list[Hex] = Cube.spiral(self.position, hex_ring_radius)
  44         result: list[Tower] = []
  45         for index, hex in enumerate(hex_list):
  46             s: str = "00" + str(index)
  47             name: str = "-".join(
  48                 [self.name.replace("DU", "Tower"), s[len(s) - 2 : len(s)]]
  49             )
  50             network_center: dict = self.parent.parent.parent.parent.center
  51             newGeo = Hexagon.hex_to_geo_location(
  52                 self.layout, hex, network_center
  53             ).json()
  54             result.append(
  55                 Tower(
  56                     {
  57                         "name": name,
  58                         "geoLocation": newGeo,
  59                         "position": hex,
  60                         "layout": self.layout,
  61                         "spiralRadiusProfile": self.spiralRadiusProfile,
  62                         "parent": self,
  63                     }
  64                 )
  65             )
  66         return result
  67
  68     @property
  69     def towers(self) -> list[Tower]:
  70         return self._towers
  71
  72     def toKml(self) -> None:
  73         return None
  74
  75     def toSvg(self) -> None:
  76         return None