rescuecore2.standard.kernel.comms

Interface Channel

All Known Implementing Classes:

AbstractChannel, RadioChannel, VoiceChannel

public interface Channel

Interface for Channels used by the ChannelCommunicationModel.

Method Summary

Modifier and Type	Method and Description
void	addSubscriber(Entity e) Add a subscriber to this channel.
java.util.Collection<AKSpeak>	getMessagesForAgent(Entity agent) Get the messages that should be send to an agent.
java.util.Collection<Entity>	getSubscribers() Get all subscribers.
void	push(AKSpeak message) Push a message through this channel.
void	removeSubscriber(Entity e) Remove a subscriber from this channel.
void	setInputNoise(Noise noise) Set the input noise object for this channel.
void	setOutputNoise(Noise noise) Set the output noise object for this channel.
void	timestep() Notify the channel that a timestep has elapsed.

Method Detail

timestep

void timestep()

Notify the channel that a timestep has elapsed.

addSubscriber

void addSubscriber(Entity e)

Add a subscriber to this channel.

Parameters:

e - The subscriber.

removeSubscriber

void removeSubscriber(Entity e)

Remove a subscriber from this channel.

Parameters:

e - The subscriber.

getSubscribers

java.util.Collection<Entity> getSubscribers()

Get all subscribers.

Returns:

All subscribers.

push

void push(AKSpeak message)
   throws InvalidMessageException

Push a message through this channel.

Parameters:

message - The message to push.

Throws:

InvalidMessageException - If the message is invalid.

getMessagesForAgent

java.util.Collection<AKSpeak> getMessagesForAgent(Entity agent)

Get the messages that should be send to an agent.

Parameters:

agent - The agent to look up.

Returns:

All messages for that agent.

setInputNoise

void setInputNoise(Noise noise)

Set the input noise object for this channel. Input noise is applied to the message once on arrival.

Parameters:

noise - The input noise.

setOutputNoise

void setOutputNoise(Noise noise)

Set the output noise object for this channel. Output noise is applied to the message once for each listener as it is sent.

Parameters:

noise - The output noise.