edu.usc.ict.iago.utils

Class GeneralVH

java.lang.Object

edu.usc.ict.iago.utils.GeneralNegotiator

edu.usc.ict.iago.utils.GeneralVH

Direct Known Subclasses:

IAGOCoreVH

public abstract class GeneralVH
extends GeneralNegotiator

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	agentID
(package private) boolean	AgentVsAgent
protected boolean	safeForMultiAgent

Fields inherited from class edu.usc.ict.iago.utils.GeneralNegotiator

game

Constructor Summary

Constructors

Constructor and Description
GeneralVH(java.lang.String username, GameSpec game, javax.websocket.Session session) Creates a generic agent, which must pass through its username, associated game, and session.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	agentDescription() This is the HTML description of the agent, e.g.
boolean	getAgentVsAgent()
abstract java.lang.String	getArtName() Returns the name of the art that should be used for this character.
abstract java.util.LinkedList<Event>	getEventResponse(Event e) Returns a list of all Events that the VH decides to enact in response to the incoming Event.
int	getID() Returns ID of agent (0 for user agent, 1 for opponent)
boolean	safeForMultiAgent() indicates whether or not the agent can be used in a multi-agent game.
void	setAgentVsAgent(java.lang.String choice)

Methods inherited from class edu.usc.ict.iago.utils.GeneralNegotiator

getAdversary, getHistory, getName, getSession, pairWith, setAdversary, setGameSpec, setHistory

Methods inherited from class java.lang.Object

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

Field Detail

agentID

int agentID

safeForMultiAgent

protected boolean safeForMultiAgent

AgentVsAgent

boolean AgentVsAgent

Constructor Detail

GeneralVH

public GeneralVH(java.lang.String username,
                 GameSpec game,
                 javax.websocket.Session session)

Creates a generic agent, which must pass through its username, associated game, and session.

Parameters:

username - The username, which may be any short, descriptive value to use in logs.

game - The GameSpec, which is automatically provided based on the configuration file setting.

session - The HTTP session, which is automatically provided.

Method Detail

getEventResponse

public abstract java.util.LinkedList<Event> getEventResponse(Event e)

Returns a list of all Events that the VH decides to enact in response to the incoming Event.

Parameters:

e -

Returns:

Returns a list of all Events that the VH decides to enact in response to the incoming Event.

getArtName

public abstract java.lang.String getArtName()

Returns the name of the art that should be used for this character. IAGO currently supports "Brad" (a male) and "Ellie" (a female) that are rendered. It also supports "Rens" (a male) and "Laura" (a female) that are emotional database photo models.

Returns:

the name of the character art

agentDescription

public abstract java.lang.String agentDescription()

This is the HTML description of the agent, e.g. "

Brad -- He is looking forward to negotiating with you!

"

Returns:

HTML description of the agent, or nothing if null

getID

public int getID()

Returns ID of agent (0 for user agent, 1 for opponent)

Returns:

int

safeForMultiAgent

public boolean safeForMultiAgent()

indicates whether or not the agent can be used in a multi-agent game.

Returns:

true if the agent is usable in multi-agent. false if the agent cannot be in a multi-agent game.

setAgentVsAgent

public void setAgentVsAgent(java.lang.String choice)

Parameters:

choice -

getAgentVsAgent

public boolean getAgentVsAgent()