ensemble.world

Class World

java.lang.Object

ensemble.world.World

All Implemented Interfaces:

LifeCycle, RouterClient

Direct Known Subclasses:

LM_World

public class World
extends java.lang.Object
implements LifeCycle, RouterClient

Represents the actual state of the world, with all its entities.

Field Summary

Fields

Modifier and Type	Field and Description
int	calls The calls.
protected VirtualClockHelper	clock The clock.
int	dimensions The dimensions.
protected java.util.HashMap<java.lang.String,EntityState>	entities The entities.
protected EnvironmentAgent	envAgent The env agent.
boolean	form_loop The form_loop.
double	form_size The form_size.
double	form_size_half The form_size_half.
java.lang.String	form_type The form_type.
protected WorldGUI	gui The gui.
private java.util.HashMap<java.lang.String,Law>	laws The laws.
protected java.util.concurrent.locks.Lock	lock The lock.
(package private) Parameters	parameters The parameters.
java.lang.String	structure The structure.
long	time_1 The time_1.
long	time_2 The time_2.

Constructor Summary

Constructors

Constructor and Description
World()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addEntity(java.lang.String entityName, Parameters parameters) Add an entity to the virtual World (agent, obstacle etc.)
void	addEntityStateAttribute(java.lang.String entityName, java.lang.String attribute, java.lang.Object value) Adds the entity state attribute.
void	addLaw(java.lang.String className, Parameters parameters) Adds the law.
boolean	configure() User-implemented method that configures the component, setting up user parameters and essential properties.
protected void	entityAdded(java.lang.String entityName) Called when an entity is added from the World.
protected void	entityRemoved(java.lang.String entityName) Called when an entity is removed from the World.
boolean	finit() User-implemented finalization method, called by stop().
java.lang.String	getAddress() Returns this component framework address.
java.util.Set<java.lang.String>	getEntityList() Gets the entity list.
java.lang.Object	getEntityStateAttribute(java.lang.String entityName, java.lang.String attribute) Retorna o estado atual de uma entidade.
Law	getLaw(java.lang.String type) Changes a state based in a law.
Parameters	getParameters() Returns all configured parameters.
WorldGUI	getWorldGUI() Gets the world gui.
boolean	init() User-implemented initialization method, called by start().
boolean	parameterUpdate(java.lang.String name, java.lang.String newValue) User-implement method called when a parameter has been updated.
void	processCommand(Command cmd) An user-implemented method to process a received command.
void	receiveCommand(Command cmd) A framework-implemented method that receives a command sent by the RouterAgent and calls processCommand.
void	removeEntity(java.lang.String entityName) Remove an entity from the Virtual World.
java.lang.Object	removeEntityStateAttribute(java.lang.String entityName, java.lang.String attribute) Removes the entity state attribute.
void	removeLaw(java.lang.String type) Removes the law.
void	sendCommand(Command cmd) A framework-implemented method that sends a command to its destination, via RouterAgent if the recipient is another agent.
void	setEnvAgent(EnvironmentAgent envAgent) Sets the env agent.
void	setParameters(Parameters parameters) Framework-implemented method that sets system and user parameters.
void	setWorldGUI(WorldGUI gui) Sets the world gui.
boolean	start() Framework-implemented initialization method.
boolean	stop() Framework-implemented finalization method.

Methods inherited from class java.lang.Object

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

Field Detail

lock

protected java.util.concurrent.locks.Lock lock

The lock.

parameters

Parameters parameters

The parameters.

envAgent

protected EnvironmentAgent envAgent

The env agent.

dimensions

public int dimensions

The dimensions.

structure

public java.lang.String structure

The structure.

form_type

public java.lang.String form_type

The form_type.

form_size

public double form_size

The form_size.

form_size_half

public double form_size_half

The form_size_half.

form_loop

public boolean form_loop

The form_loop.

laws

private java.util.HashMap<java.lang.String,Law> laws

The laws.

entities

protected java.util.HashMap<java.lang.String,EntityState> entities

The entities.

gui

protected WorldGUI gui

The gui.

clock

protected VirtualClockHelper clock

The clock.

calls

public int calls

The calls.

time_1

public long time_1

The time_1.

time_2

public long time_2

The time_2.

Constructor Detail

World

public World()

Method Detail

setParameters

public final void setParameters(Parameters parameters)

Description copied from interface: LifeCycle

Framework-implemented method that sets system and user parameters.

Specified by:

setParameters in interface LifeCycle

Parameters:

parameters - a Parameters object with all user and system Parameters for this object

getParameters

public final Parameters getParameters()

Description copied from interface: LifeCycle

Returns all configured parameters.

Specified by:

getParameters in interface LifeCycle

Returns:

a Parameters object with system and user parameters

setEnvAgent

public final void setEnvAgent(EnvironmentAgent envAgent)

Sets the env agent.

Parameters:

envAgent - the new env agent

start

public final boolean start()

Description copied from interface: LifeCycle

Framework-implemented initialization method.

Specified by:

start in interface LifeCycle

Returns:

true, if successful

stop

public final boolean stop()

Description copied from interface: LifeCycle

Framework-implemented finalization method.

Specified by:

stop in interface LifeCycle

Returns:

true, if successful

addEntity

public final boolean addEntity(java.lang.String entityName,
                Parameters parameters)

Add an entity to the virtual World (agent, obstacle etc.)

Parameters:

entityName - the entity name

parameters - the parameters

Returns:

true, if successful

removeEntity

public final void removeEntity(java.lang.String entityName)

Remove an entity from the Virtual World.

Parameters:

entityName - the entity name

getEntityList

public final java.util.Set<java.lang.String> getEntityList()

Gets the entity list.

Returns:

the entity list

addLaw

public final void addLaw(java.lang.String className,
          Parameters parameters)

Adds the law.

Parameters:

className - the class name

parameters - the parameters

removeLaw

public final void removeLaw(java.lang.String type)

Removes the law.

Parameters:

type - the type

getLaw

public final Law getLaw(java.lang.String type)

Changes a state based in a law.

Parameters:

type - the type

Returns:

the law

getWorldGUI

public final WorldGUI getWorldGUI()

Gets the world gui.

Returns:

the world gui

setWorldGUI

public final void setWorldGUI(WorldGUI gui)

Sets the world gui.

Parameters:

gui - the new world gui

getEntityStateAttribute

public final java.lang.Object getEntityStateAttribute(java.lang.String entityName,
                                       java.lang.String attribute)

Retorna o estado atual de uma entidade.

Parameters:

entityName - the entity name

attribute - the attribute

Returns:

variável do estado de uma entidade

addEntityStateAttribute

public final void addEntityStateAttribute(java.lang.String entityName,
                           java.lang.String attribute,
                           java.lang.Object value)

Adds the entity state attribute.

Parameters:

entityName - the entity name

attribute - the attribute

value - the value

removeEntityStateAttribute

public final java.lang.Object removeEntityStateAttribute(java.lang.String entityName,
                                          java.lang.String attribute)

Removes the entity state attribute.

Parameters:

entityName - the entity name

attribute - the attribute

Returns:

the object

getAddress

public final java.lang.String getAddress()

Description copied from interface: RouterClient

Returns this component framework address.

Specified by:

getAddress in interface RouterClient

Returns:

the component address

receiveCommand

public final void receiveCommand(Command cmd)

Description copied from interface: RouterClient

A framework-implemented method that receives a command sent by the RouterAgent and calls processCommand.

Specified by:

receiveCommand in interface RouterClient

Parameters:

cmd - the cmd

sendCommand

public final void sendCommand(Command cmd)

Description copied from interface: RouterClient

A framework-implemented method that sends a command to its destination, via RouterAgent if the recipient is another agent.

Specified by:

sendCommand in interface RouterClient

Parameters:

cmd - the cmd

configure

public boolean configure()

Description copied from interface: LifeCycle

User-implemented method that configures the component, setting up user parameters and essential properties.

Specified by:

configure in interface LifeCycle

Returns:

true, if successful

init

public boolean init()

Description copied from interface: LifeCycle

User-implemented initialization method, called by start().

Specified by:

init in interface LifeCycle

Returns:

true, if successful

parameterUpdate

public boolean parameterUpdate(java.lang.String name,
                      java.lang.String newValue)

Description copied from interface: LifeCycle

User-implement method called when a parameter has been updated.

Specified by:

parameterUpdate in interface LifeCycle

Parameters:

name - the name

newValue - the new value

Returns:

true, if successful

finit

public boolean finit()

Description copied from interface: LifeCycle

User-implemented finalization method, called by stop().

Specified by:

finit in interface LifeCycle

Returns:

true, if successful

entityAdded

protected void entityAdded(java.lang.String entityName)

Called when an entity is added from the World. Must be overrided by the user.

Parameters:

entityName - the entity name

entityRemoved

protected void entityRemoved(java.lang.String entityName)

Called when an entity is removed from the World. Must be overrided by the user.

Parameters:

entityName - the entity name

processCommand

public void processCommand(Command cmd)

Description copied from interface: RouterClient

An user-implemented method to process a received command.

Specified by:

processCommand in interface RouterClient

Parameters:

cmd - the cmd