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

Added docstrings to class intialisers

Browse Source
This commit is contained in:
Marek Wolan
2023-07-06 16:08:51 +01:00
parent 2a08d3a2a5
commit 86725064ec
23 changed files with 253 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/primaite/links/link.py
View File

@@ -6,16 +6,18 @@ from primaite.common.protocol import Protocol
class Link(object):
"""Link class.
:param _id: The IER id
:param _bandwidth: The bandwidth of the link (bps)
:param _source_node_name: The name of the source node
:param _dest_node_name: The name of the destination node
:param _protocols: The protocols to add to the link
"""
"""Link class."""
def __init__(self, _id, _bandwidth, _source_node_name, _dest_node_name, _services):
"""
Initialise a Link within the simulated network.
:param _id: The IER id
:param _bandwidth: The bandwidth of the link (bps)
:param _source_node_name: The name of the source node
:param _dest_node_name: The name of the destination node
:param _protocols: The protocols to add to the link
"""
self.id = _id
self.bandwidth = _bandwidth
self.source_node_name = _source_node_name