agentgui.core.environment

Class EnvironmentType

java.lang.Object

agentgui.core.environment.EnvironmentType

public class EnvironmentType
extends java.lang.Object

This class has to be used in order to hand over a predefined environment model with its visual representation and tools to Agent.Workbench.
In order to add such constructions to Agent.GUI use the methods in the class GlobalInfo (accessible at runtime by using Application.RunInfo)

See Also:

Application.getGlobalInfo(), GlobalInfo.addEnvironmentType(EnvironmentType), GlobalInfo.removeEnvironmentType(EnvironmentType), GlobalInfo.removeEnvironmentType(String)

Constructor Summary

Constructors

Constructor and Description
EnvironmentType(java.lang.String key, java.lang.String displayName, java.lang.String displayNameLanguage, java.lang.Class<? extends EnvironmentController> controller, java.lang.Class<? extends jade.core.Agent> agentClass) Constructor for this class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object)
java.lang.Class<? extends jade.core.Agent>	getDisplayAgentClass()
java.lang.String	getDisplayName()
java.lang.Class<? extends EnvironmentController>	getEnvironmentControllerClass()
java.lang.String	getInternalKey()
void	setDisplayAgentClass(java.lang.Class<? extends jade.core.Agent> displayAgentClass)
void	setDisplayName(java.lang.String displayName)
void	setEnvironmentControllerClass(java.lang.Class<? extends EnvironmentController> controllerClass) Sets the environment controller class.
void	setInternalKey(java.lang.String internalKey)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentType

public EnvironmentType(java.lang.String key,
                       java.lang.String displayName,
                       java.lang.String displayNameLanguage,
                       java.lang.Class<? extends EnvironmentController> controller,
                       java.lang.Class<? extends jade.core.Agent> agentClass)

Constructor for this class.

Parameters:

key - A unique identifier for the environment model type

displayName - A name that will be displayed later on

displayNameLanguage - the display name language

controller - the controller class of the environment

agentClass - the agent class for displaying the environment during runtime

Method Detail

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the displayName as representation for this EnvironmentType

getInternalKey

public java.lang.String getInternalKey()

Returns:

the internalKey

setInternalKey

public void setInternalKey(java.lang.String internalKey)

Parameters:

internalKey - the internalKey to set

getDisplayName

public java.lang.String getDisplayName()

Returns:

the displayName

setDisplayName

public void setDisplayName(java.lang.String displayName)

Parameters:

displayName - the displayName to set

getEnvironmentControllerClass

public java.lang.Class<? extends EnvironmentController> getEnvironmentControllerClass()

Returns:

the displayPanelClass

setEnvironmentControllerClass

public void setEnvironmentControllerClass(java.lang.Class<? extends EnvironmentController> controllerClass)

Sets the environment controller class.

Parameters:

controllerClass - the new environment controller class

setDisplayAgentClass

public void setDisplayAgentClass(java.lang.Class<? extends jade.core.Agent> displayAgentClass)

Parameters:

displayAgentClass - the displayAgent to set

getDisplayAgentClass

public java.lang.Class<? extends jade.core.Agent> getDisplayAgentClass()

Returns:

the displayAgent