RoboidControl::ParticipantRegistry Class Reference

Detailed Description

class which manages all known participants

#include <Participant.h>

Public Member Functions
Participant *	Get (const char *ipAddress, unsigned int port)
	Retrieve a participant by its address.
Participant *	Get (unsigned char networkID)
	Retrieve a participant by its network ID.
Participant *	Add (const char *ipAddress, unsigned int port)
	Add a participant with the given details.
void	Add (Participant *participant)
	Add a participant.
void	Remove (Participant *participant)
	Remove a participant.
const std::list< Participant * > &	GetAll () const
	Get all participants.

Member Function Documentation

Get() [1/2]

Participant * RoboidControl::ParticipantRegistry::Get	(	const char *	ipAddress,
		unsigned int	port
	)

Retrieve a participant by its address.

Parameters

ipAddress	The IP address of the participant
port	The port number of the participant

Returns

The participant or a nullptr when it could not be found

Get() [2/2]

Participant * RoboidControl::ParticipantRegistry::Get

(

unsigned char

networkID

)

Retrieve a participant by its network ID.

Parameters

networkID

The network ID of the participant

Returns

The participant or a nullptr when it could not be found

Add() [1/2]

Participant * RoboidControl::ParticipantRegistry::Add	(	const char *	ipAddress,
		unsigned int	port
	)

Add a participant with the given details.

Parameters

ipAddress	The IP address of the participant
port	The port number of the participant

Returns

The added participant

Add() [2/2]

void RoboidControl::ParticipantRegistry::Add

(

Participant *

participant

)

Add a participant.

Parameters

participant

The participant to add

Remove()

void RoboidControl::ParticipantRegistry::Remove

(

Participant *

participant

)

Remove a participant.

Parameters

participant

The participant to remove

GetAll()

const std::list< Participant * > & RoboidControl::ParticipantRegistry::GetAll

(

)

const

Get all participants.

Returns

All participants