oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move class docstrings out of init function.

Browse Source
This commit is contained in:
Marek Wolan
2023-07-05 10:14:16 +01:00
parent 24a4f96ed0
commit fa6dbd8338
12 changed files with 105 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/primaite/pol/ier.py
View File

@@ -6,7 +6,19 @@ Used to represent an information flow from source to destination.
class IER(object):
"""Information Exchange Requirement class."""
"""Information Exchange Requirement class.
:param _id: The IER id
:param _start_step: The step when this IER should start
:param _end_step: The step when this IER should end
:param _load: The load this IER should put on a link (bps)
:param _protocol: The protocol of this IER
:param _port: The port this IER runs on
:param _source_node_id: The source node ID
:param _dest_node_id: The destination node ID
:param _mission_criticality: Criticality of this IER to the mission (0 none, 5 mission critical)
:param _running: Indicates whether the IER is currently running
"""
def __init__(
self,
@@ -21,20 +33,6 @@ class IER(object):
_mission_criticality,
_running=False,
):
"""Init.
Args:
_id: The IER id
_start_step: The step when this IER should start
_end_step: The step when this IER should end
_load: The load this IER should put on a link (bps)
_protocol: The protocol of this IER
_port: The port this IER runs on
_source_node_id: The source node ID
_dest_node_id: The destination node ID
_mission_criticality: Criticality of this IER to the mission (0 none, 5 mission critical)
_running: Indicates whether the IER is currently running
"""
self.id = _id
self.start_step = _start_step
self.end_step = _end_step