1 # Copyright 2023 highstreet technologies GmbH
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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.
15 # inspired by https://github.com/rochacbruno/python-project-template
18 network_generation base module.
20 This is the principal module of the network_generation project.
23 from network_generation.model.python.o_ran_network import ORanNetwork
25 # example constant variable
26 NAME = "network_generation"
29 class NetworkGenerator:
31 Class containing all methods to generate a network.
32 The generation process is influenced by a configuration in json format.
35 __configuration: dict = {}
38 def __init__(self, configuration: dict):
39 self.__configuration = configuration
42 def configuration(self) -> dict:
44 Getter returning the object configuration
45 :return A NetworkGenerator configuration
47 return self.__configuration
49 # returns a JSON serializable object
50 def generate(self) -> ORanNetwork:
52 Method to start the generation process.
53 :return The ORanNetwork object.
55 return ORanNetwork(self.configuration())