RoboidControl/RoboidControl-python
RoboidControl/RoboidControl-python
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Releases Activity

Added participants documentation

Browse Source
This commit is contained in:
Pascal Serrarens 2025-05-01 14:39:13 +02:00
parent b0a6c1f528
commit 1dab3f4bc7
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
RoboidControl/Participant.py
View File

@ -69,6 +69,12 @@ class Participant:
@staticmethod @staticmethod
def GetParticipant(arg1: Union[str, int], port: Optional[int] = None) -> Optional['Participant']: def GetParticipant(arg1: Union[str, int], port: Optional[int] = None) -> Optional['Participant']:
"""! Retrieve a participant
@param arg1 Either:
- str: The IP address of the participant
- int: The network ID of the participant
@param port The port number of the participant
"""
if port is not None: if port is not None:
ip_address = str(arg1) ip_address = str(arg1)
for participant in Participant.participants: for participant in Participant.participants:
@ -83,6 +89,12 @@ class Participant:
return None return None
def AddParticipant(arg1: Union[str, 'Participant'], port: Optional[int] = None) -> 'Participant': def AddParticipant(arg1: Union[str, 'Participant'], port: Optional[int] = None) -> 'Participant':
"""! Add a participant
@param arg1 Either:
- str: The IP address of the participant
- Participant: The participant to add
@param port The port number of the participant
"""
if port is not None: if port is not None:
ip_address = str(arg1) ip_address = str(arg1)
participant = Participant(ip_address, port) participant = Participant(ip_address, port)