agentgui.simulationService.transaction

Class EnvironmentNotification

java.lang.Object

agentgui.simulationService.transaction.EnvironmentNotification

All Implemented Interfaces:

java.io.Serializable

public class EnvironmentNotification
extends java.lang.Object
implements java.io.Serializable

This class is used as generalized notification to agents, that are using the SimulationService.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EnvironmentNotification.ProcessingInstruction The Class ProcessingInstruction can be used in order to set the further handling with the EnvironmentNotification.

Constructor Summary

Constructors

Constructor and Description
EnvironmentNotification(jade.core.AID senderAID, boolean comingFromManager, java.lang.Object notification) Instantiates a new environment notification.

Method Summary

Modifier and Type	Method and Description
void	block(long period) Sets the notification to be blocked for a time period in milliseconds.
void	delete() Sets the notification to be delete after proceeding.
java.lang.Object	getNotification() Gets the notification.
EnvironmentNotification.ProcessingInstruction	getProcessingInstruction() Returns the processing instruction for the further handling of the notification.
jade.core.AID	getSender() Gets the sender.
boolean	isComingFromManager() Checks if the notification is coming from the manager.
void	moveLastOrBlock(long period) Sets the notification to be moved to the last position of the notification queue.
void	resetProcessingInstruction() Resets the processing instruction.
void	setComingFromManager(boolean comingFromManager) Sets that the notification is the coming from the manager.
void	setNotification(java.lang.Object notification) Sets the notification.
void	setSender(jade.core.AID sender) Sets the sender.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentNotification

public EnvironmentNotification(jade.core.AID senderAID,
                               boolean comingFromManager,
                               java.lang.Object notification)

Instantiates a new environment notification.

Parameters:

senderAID - the senders AID

comingFromManager - true, if this message comes from the manager of a simulation

notification - the generalized notification

Method Detail

setSender

public void setSender(jade.core.AID sender)

Sets the sender.

Parameters:

sender - the sender to set

getSender

public jade.core.AID getSender()

Gets the sender.

Returns:

the sender

setComingFromManager

public void setComingFromManager(boolean comingFromManager)

Sets that the notification is the coming from the manager.

Parameters:

comingFromManager - the commingFromManager to set

isComingFromManager

public boolean isComingFromManager()

Checks if the notification is coming from the manager.

Returns:

the commingFromManager

setNotification

public void setNotification(java.lang.Object notification)

Sets the notification.

Parameters:

notification - the notification to set

getNotification

public java.lang.Object getNotification()

Gets the notification.

Returns:

the notification

getProcessingInstruction

public EnvironmentNotification.ProcessingInstruction getProcessingInstruction()

Returns the processing instruction for the further handling of the notification.

Returns:

the processing instruction

resetProcessingInstruction

public void resetProcessingInstruction()

Resets the processing instruction.

delete

public void delete()

Sets the notification to be delete after proceeding.

block

public void block(long period)

Sets the notification to be blocked for a time period in milliseconds.

Parameters:

period - the period

moveLastOrBlock

public void moveLastOrBlock(long period)

Sets the notification to be moved to the last position of the notification queue. In case that this is already the last notification, the notification will be block for a certain amount of time in milliseconds.