ParticipantUDP Class Reference

Detailed Description

A participant using UDP communication.

A local participant is the local device which can communicate with other participants It manages all local things and communcation with other participants. Each application has a local participant which is usually explicit in the code. An participant can be isolated. In that case it is standalong and does not communicate with other participants.

It is possible to work with an hidden participant by creating things without specifying a participant in the constructor. In that case an hidden isolated participant is created which can be obtained using RoboidControl::IsolatedParticipant::Isolated().

See also

RoboidControl::Thing::Thing()

Inheritance diagram for ParticipantUDP:

Public Member Functions
None	__init__ (self, int port=7681, Optional[str] ip_address=None, int local_port=7681)
	Create a participant.
	Update (self, Optional[int] currentTimeMs=None)
	Update all things for this participant.
	UpdateMyThings (self, int currentTimeMs)
	SendThingInfo (self, Participant owner, 'Thing' thing, bool recursively=False)
	PublishThingInfo (self, Thing thing)
	Send (self, Participant owner, IMessage msg)
	Publish (self, IMessage msg)
	Receiver (self)
	ReceiveData (self, bytes data, Participant sender)
	ProcessParticipantMsg (self, Participant sender, ParticipantMsg msg)
	ProcessSiteIdMsg (self, Participant sender, NetworkIdMsg msg)
	ProcessInvestigateMsg (self, Participant sender, InvestigateMsg msg)
	ProcessThingMsg (self, Participant sender, ThingMsg msg)
	ProcessNameMsg (self, Participant sender, NameMsg msg)
	ProcessModelUrlMsg (self, Participant sender, ModelUrlMsg msg)
	ProcessPoseMsg (self, Participant sender, PoseMsg msg)
	ProcessBinaryMsg (self, Participant sender, BinaryMsg msg)

Static Public Member Functions
'ParticipantUDP'	Isolated ()

Public Attributes
	publishInterval
	The interval in milliseconds for publishing (broadcasting) data on the local network.
	is_isolated
	remote_site
	udp_socket
	port
	thread
	nextPublishMe
	network_id

Static Public Attributes
str	name = "Participant"
	isolated_participant = None
int	nextPublishMe = 0

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		int	port = 7681,
		Optional[str]	ip_address = None,
		int	local_port = 7681
	)

Create a participant.

Parameters

ipAddress	The IP address of the site
port	The port used by the site
localPort	The port used by the local participant

Reimplemented from Participant.

Member Function Documentation

Update()

Update	(		self,
		Optional[int]	currentTimeMs = None
	)

Update all things for this participant.

Parameters

The	current time in milliseconds (optional)

Reimplemented from Participant.

---

The documentation for this class was generated from the following file:

• d:/Python/RoboidControl/RoboidControl/Participants/ParticipantUDP.py