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.
18 An abstract Class for all classes
21 from abc import ABC, abstractmethod
22 from typing import Any
23 from model.python.type_definitions import (
32 from model.python.geo_location import GeoLocation
35 # Define the ITop interface
41 administrativeState: AdministrativeState = None,
42 operationalState: OperationalState = None,
43 lifeCycleState: LifeCycleState = None,
44 alarmState: AlarmState = None,
45 usageState: UsageState = None,
46 utilization: Utilization = None,
50 self.administrativeState = administrativeState
51 self.operationalState = operationalState
52 self.lifeCycleState = lifeCycleState
53 self.alarmState = alarmState
54 self.usageState = usageState
55 self.utilization = utilization
58 # Define the Top class
60 def __init__(self, data: [dict[str, Any] | None] = None):
61 self._id = data["id"] if data and "id" in data else str(uuid.uuid4())
64 if data and "name" in data
65 else " ".join(["Name", "of", self._id])
67 self._administrativeState = (
68 data["administrativeState"]
69 if data and "administrativeState" in data
70 else AdministrativeState.LOCKED
72 self._operationalState = (
73 data["operationalState"]
74 if data and "operationalState" in data
75 else OperationalState.DISABLED
77 self._lifeCycleState = (
78 data["lifeCycleState"]
79 if data and "lifeCycleState" in data
80 else LifeCycleState.PLANNED
82 self._alarmState = data["alarmState"] if data and "alarmState" in data else 0
84 data["usageState"] if data and "usageState" in data else UsageState.UNUSED
86 self._utilization = data["utilization"] if data and "utilization" in data else 0
93 def id(self, value: str):
97 def name(self) -> str:
101 def name(self, value: str):
105 def administrativeState(self) -> AdministrativeState:
106 return self._administrativeState
108 @administrativeState.setter
109 def administrativeState(self, value: AdministrativeState):
110 self._administrativeState = value
113 def operationalState(self) -> OperationalState:
114 return self._operationalState
116 @operationalState.setter
117 def operationalState(self, value: OperationalState):
118 self._operationalState = value
121 def lifeCycleState(self) -> LifeCycleState:
122 return self._lifeCycleState
124 @lifeCycleState.setter
125 def lifeCycleState(self, value: LifeCycleState):
126 self._lifeCycleState = value
129 def alarmState(self) -> AlarmState:
130 return self._alarmState
133 def alarmState(self, value: AlarmState):
134 self._alarmState = value
137 def usageState(self) -> UsageState:
138 return self._usageState
141 def usageState(self, value: UsageState):
142 self._usageState = value
145 def utilization(self) -> Utilization:
146 return self._utilization
149 def utilization(self, value: Utilization):
150 self._utilization = value
152 def json(self) -> dict[str, Any]:
156 "administrativeState": self.administrativeState.value,
157 "operationalState": self.operationalState.value,
158 "lifeCycleState": self.lifeCycleState.value,
159 "alarmState": self.alarmState,
160 "usageState": self.usageState.value,
161 "utilization": self.utilization,
164 def __str__(self) -> str:
165 return str(self.json())