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

Standardise docstring summary line placement.

Browse Source
This commit is contained in:
Marek Wolan
2023-07-07 10:28:00 +01:00
parent 86725064ec
commit f4b98542b6
36 changed files with 350 additions and 175 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -29,7 +29,8 @@ class Link(object):
self.add_protocol(protocol_name)
def add_protocol(self, _protocol):
"""Adds a new protocol to the list of protocols on this link.
"""
Adds a new protocol to the list of protocols on this link.
Args:
_protocol: The protocol to be added (enum)
@@ -37,7 +38,8 @@ class Link(object):
self.protocol_list.append(Protocol(_protocol))
def get_id(self):
"""Gets link ID.
"""
Gets link ID.
Returns:
Link ID
@@ -45,7 +47,8 @@ class Link(object):
return self.id
def get_source_node_name(self):
"""Gets source node name.
"""
Gets source node name.
Returns:
Source node name
@@ -53,7 +56,8 @@ class Link(object):
return self.source_node_name
def get_dest_node_name(self):
"""Gets destination node name.
"""
Gets destination node name.
Returns:
Destination node name
@@ -61,7 +65,8 @@ class Link(object):
return self.dest_node_name
def get_bandwidth(self):
"""Gets bandwidth of link.
"""
Gets bandwidth of link.
Returns:
Link bandwidth (bps)
@@ -69,7 +74,8 @@ class Link(object):
return self.bandwidth
def get_protocol_list(self):
"""Gets list of protocols on this link.
"""
Gets list of protocols on this link.
Returns:
List of protocols on this link
@@ -77,7 +83,8 @@ class Link(object):
return self.protocol_list
def get_current_load(self):
"""Gets current total load on this link.
"""
Gets current total load on this link.
Returns:
Total load on this link (bps)
@@ -88,7 +95,8 @@ class Link(object):
return total_load
def add_protocol_load(self, _protocol, _load):
"""Adds a loading to a protocol on this link.
"""
Adds a loading to a protocol on this link.
Args:
_protocol: The protocol to load