rescuecore2.standard.kernel.comms

Class AbstractChannel

java.lang.Object

rescuecore2.standard.kernel.comms.AbstractChannel

All Implemented Interfaces:

Channel

Direct Known Subclasses:

RadioChannel, VoiceChannel

public abstract class AbstractChannel
extends java.lang.Object
implements Channel

Abstract base class for channels.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	channelID This channels's ID.
protected java.util.Collection<Entity>	subscribers The set of subscribers.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractChannel(int channelID) Construct an AbstractChannel.

Method Summary

Modifier and Type	Method and Description
protected void	addMessageForAgent(Entity a, AKSpeak msg) Register a message that should be send to an agent on the next call to @{link #getMessagesForAgent(AgentProxy)}.
protected void	addMessageForSubscribers(AKSpeak msg) Register a message that should be send to all subscribers.
void	addSubscriber(Entity a) 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.
protected boolean	isSubscribed(Entity e) Find out if an entity is subscribed to this channel.
void	push(AKSpeak speak) Push a message through this channel.
protected abstract void	pushImpl(AKSpeak msg, int originalSize) Push a message after input noise has been applied.
void	removeSubscriber(Entity a) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

subscribers

protected java.util.Collection<Entity> subscribers

The set of subscribers.

channelID

protected int channelID

This channels's ID.

Constructor Detail

AbstractChannel

protected AbstractChannel(int channelID)

Construct an AbstractChannel.

Parameters:

channelID - The ID of this channel.

Method Detail

setInputNoise

public void setInputNoise(Noise noise)

Description copied from interface: Channel

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

Specified by:

setInputNoise in interface Channel

Parameters:

noise - The input noise.

setOutputNoise

public void setOutputNoise(Noise noise)

Description copied from interface: Channel

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

Specified by:

setOutputNoise in interface Channel

Parameters:

noise - The output noise.

timestep

public void timestep()

Description copied from interface: Channel

Notify the channel that a timestep has elapsed.

Specified by:

timestep in interface Channel

addSubscriber

public void addSubscriber(Entity a)

Description copied from interface: Channel

Add a subscriber to this channel.

Specified by:

addSubscriber in interface Channel

Parameters:

a - The subscriber.

removeSubscriber

public void removeSubscriber(Entity a)

Description copied from interface: Channel

Remove a subscriber from this channel.

Specified by:

removeSubscriber in interface Channel

Parameters:

a - The subscriber.

getSubscribers

public java.util.Collection<Entity> getSubscribers()

Description copied from interface: Channel

Get all subscribers.

Specified by:

getSubscribers in interface Channel

Returns:

All subscribers.

getMessagesForAgent

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

Description copied from interface: Channel

Get the messages that should be send to an agent.

Specified by:

getMessagesForAgent in interface Channel

Parameters:

agent - The agent to look up.

Returns:

All messages for that agent.

push

public final void push(AKSpeak speak)
                throws InvalidMessageException

Description copied from interface: Channel

Push a message through this channel.

Specified by:

push in interface Channel

Parameters:

speak - The message to push.

Throws:

InvalidMessageException - If the message is invalid.

pushImpl

protected abstract void pushImpl(AKSpeak msg,
                                 int originalSize)
                          throws InvalidMessageException

Push a message after input noise has been applied.

Parameters:

msg - The message.

Throws:

InvalidMessageException - If the message is invalid.

addMessageForAgent

protected void addMessageForAgent(Entity a,
                                  AKSpeak msg)

Register a message that should be send to an agent on the next call to @{link #getMessagesForAgent(AgentProxy)}. This method will ignore the subscribers list so subclasses should use @{link #isSubscribed(Entity)} if they wish to restrict messages to subscribers only.

Parameters:

a - The agent.

msg - The message.

addMessageForSubscribers

protected void addMessageForSubscribers(AKSpeak msg)

Register a message that should be send to all subscribers.

Parameters:

msg - The message.

isSubscribed

protected boolean isSubscribed(Entity e)

Find out if an entity is subscribed to this channel.

Parameters:

e - The entity to check.

Returns:

True iff the entity is subscribed to this channel.