code/network-generator/network_generation/base.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 # inspired by https://github.com/rochacbruno/python-project-template
  16
  17 """
  18 network_generation base module.
  19
  20 This is the principal module of the network_generation project.
  21 """
  22
  23 from network_generation.model.python.o_ran_network import ORanNetwork
  24
  25 # example constant variable
  26 NAME = "network_generation"
  27
  28 class NetworkGenerator:
  29     """
  30     Class containing all methods to generate a network.
  31     The generation process is influenced by a configuration in json format.
  32     """
  33
  34     __configuration: dict = {}
  35
  36     # constructor
  37     def __init__(self, configuration: dict):
  38         self.__configuration = configuration
  39
  40     # getters
  41     def configuration(self) -> dict:
  42         """
  43         Getter returning the object configuration
  44         :return A NetworkGenerator configuration
  45         """
  46         return self.__configuration
  47
  48     # returns a JSON serializable object
  49     def generate(self) -> ORanNetwork:
  50         """
  51         Method to start the generation process.
  52         :return The ORanNetwork object.
  53         """
  54         return ORanNetwork(self.configuration())