code/network-generator/network_generation/controller/network_generator.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 Module containing the Generator class.
  18 """
  19
  20 from network_generation.model.python.o_ran_network import ORanNetwork
  21
  22
  23 class NetworkGenerator:
  24     """
  25     Class containing all methods to generate a network.
  26     The generation process is influenced by a configuration in json format.
  27     """
  28
  29     __configuration: dict = {}
  30
  31     # constructor
  32     def __init__(self, configuration: dict):
  33         self.__configuration = configuration
  34
  35     # getters
  36     def configuration(self) -> dict:
  37         """
  38         Getter returning the object configuration
  39         :return A NetworkGenerator configuration
  40         """
  41         return self.__configuration
  42
  43     # returns a JSON serializable object
  44     def generate(self) -> ORanNetwork:
  45         """
  46         Method to start the generation process.
  47         :return The ORanNetwork object.
  48         """
  49         return ORanNetwork(self.configuration())