AgentImplementation

java.lang.Object
- java.util.Observable
- - agent.AgentImplementation

All Implemented Interfaces:

Agent

Direct Known Subclasses:

Contestant, Mole
```
public abstract class AgentImplementation
extends java.util.Observable
implements Agent
```
This is a standard Agent Implementation. Should contain default functions for agent behavior. All agent implementations should subclass this class and override specific methods.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Agent`	`currentVote` The suspicion who has the highest suspicious weight in current round
`protected boolean`	`eliminated` This boolean flag indicates if the agent has been eliminated
`protected boolean`	`mole` This boolean flag indicates if the agent is the mole.
`protected java.lang.String`	`nameString` Contains a string representation of this agent's name.
`protected java.util.LinkedList<java.lang.String>`	`ponderings` Contains ponderings.
`protected java.util.HashMap<Agent,Agent>`	`secondOrderBelief` One order belief history.
`protected java.util.HashMap<Agent,java.lang.Double>`	`suspicions` The suspicious weight.
`protected java.lang.String`	`typeString` The type of the agent, the default type is "plain contestant".

Constructor Summary

Constructors
Constructor and Description
`AgentImplementation()` Create an AgentImplementation.
`AgentImplementation(java.lang.String agentName)` Creates an AgentImplementation with a specific name

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCompetitor(Agent competitor)` Adds an competing Agent to this Agent's list of competitors
`void`	`addCompetitors(java.util.Collection<Agent> others)` Adds competitors to the current Agent class
`protected double`	`avgSuspicion()` Calculate average suspicion over all competitors
`void`	`clearSecondOrderBelief()` Clears this AgentImplementations second order beliefs.
`protected void`	`decideVote()` Makes the agent decide its vote.
`void`	`eliminate()` EliminationEvent tells the agent she is eliminated.
`protected java.util.ArrayList<Agent>`	`getMaxSuspiciousAgents()` Get the maximum suspicious agents list
`java.lang.String`	`getName()` What is this agent's name?
`int`	`getNumberOfCompetitors()` Returns the number of competitors this AgentImplementation has currently
`java.util.LinkedList<java.lang.String>`	`getPonderings()` Gets the most recent deep thoughts from this Agent
`java.util.HashMap<Agent,java.lang.Double>`	`getSuspicions()` Returns the current suspicion map
`java.lang.String`	`getTypeString()` Should return some String describing what this agent's type or intentions are.
`boolean`	`isEliminated()` Am I eliminated?
`boolean`	`isMole()` Is this agent the mole?
`void`	`listenConversation(Agent speaker, Agent suspicion)` ConversationEvent tells Agent who is the mole.
`void`	`normalizeSuspicions()` Normalizes the suspicions so they sum up to one.
`protected void`	`ponder(java.lang.String p)` Causes this agent to ponder something.
`void`	`setName(java.lang.String name)`
`protected void`	`setTypeString(java.lang.String s)` Sets the typestring, displayed in the GUI, to a specific String
`protected double`	`summedSuspicion()` Calculates the sum of all suspicions of this Agent, used by AvgSuspicion and by normalizeSuspicion
`Agent`	`tellConversation()` This may do the same as vote
`java.lang.String`	`toString()` Returns the name of this agent
`void`	`updateSuspicion(Agent a, double factor)` Multiply this AgentImplementation's suspicion towards a specific Agent with some factor.
`protected void`	`updateView()` Update the view of agent.
`Agent`	`vote()` This is the voting method, used in the final stage of every game round.

Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface agent.Agent
doAssignment, informAssResult, informElimination, informGameEnd

- Field Detail
  - nameString
```
protected java.lang.String nameString
```
    Contains a string representation of this agent's name.
  - mole
```
protected boolean mole
```
    This boolean flag indicates if the agent is the mole.
  - eliminated
```
protected boolean eliminated
```
    This boolean flag indicates if the agent has been eliminated
  - suspicions
```
protected java.util.HashMap<Agent,java.lang.Double> suspicions
```
    The suspicious weight.
  - secondOrderBelief
```
protected java.util.HashMap<Agent,Agent> secondOrderBelief
```
    One order belief history. Only save the result of the last conversation
  - ponderings
```
protected java.util.LinkedList<java.lang.String> ponderings
```
    Contains ponderings.
  - currentVote
```
protected Agent currentVote
```
    The suspicion who has the highest suspicious weight in current round
  - typeString
```
protected java.lang.String typeString
```
    The type of the agent, the default type is "plain contestant".
- Constructor Detail
  - AgentImplementation
```
public AgentImplementation()
```
    Create an AgentImplementation.
  - AgentImplementation
```
public AgentImplementation(java.lang.String agentName)
```
    Creates an AgentImplementation with a specific name
    
    Parameters:
    agentName -
- Method Detail
  - getPonderings
```
public java.util.LinkedList<java.lang.String> getPonderings()
```
    Gets the most recent deep thoughts from this Agent
    
    Returns:
    a list containing deep thoughts in chronological order.
  - ponder
```
protected void ponder(java.lang.String p)
```
    Causes this agent to ponder something. This means adding the text to the ponderings
    
    Parameters:
    p - a String containing a deep thought.
  - tellConversation
```
public Agent tellConversation()
```
    Description copied from interface: Agent
    
    This may do the same as vote
    
    Specified by:
    
    tellConversation in interface Agent
    
    Returns:
    The currently suspected Agent object
    See Also:
    Agent.vote()
  - listenConversation
```
public void listenConversation(Agent speaker,
                      Agent suspicion)
```
    Description copied from interface: Agent
    
    ConversationEvent tells Agent who is the mole. This is only one order belief
    
    Specified by:
    
    listenConversation in interface Agent
    
    Parameters:
    speaker - the agent who gives the information
    suspicion - the suspicion which speaker tells listener
  - eliminate
```
public void eliminate()
```
    Description copied from interface: Agent
    
    EliminationEvent tells the agent she is eliminated.
    
    Specified by:
    
    eliminate in interface Agent
  - isEliminated
```
public boolean isEliminated()
```
    Description copied from interface: Agent
    
    Am I eliminated?
    
    Specified by:
    
    isEliminated in interface Agent
    
    Returns:
    true or false
  - updateSuspicion
```
public void updateSuspicion(Agent a,
                   double factor)
```
    Description copied from interface: Agent
    
    Multiply this AgentImplementation's suspicion towards a specific Agent with some factor.
    
    Specified by:
    
    updateSuspicion in interface Agent
    
    Parameters:
    a - the agent towards whom the suspicion should be changed
    factor - the factor by which the suspicion should be changed. If the factor is not positive it will be changed to 1, leaving the suspicion unchanged.
  - clearSecondOrderBelief
```
public void clearSecondOrderBelief()
```
    Clears this AgentImplementations second order beliefs.
  - vote
```
public Agent vote()
```
    Description copied from interface: Agent
    
    This is the voting method, used in the final stage of every game round.
    
    Specified by:
    
    vote in interface Agent
    
    Returns:
    an Agent object, corresponding to the most suspicious agent
  - decideVote
```
protected void decideVote()
```
    Makes the agent decide its vote. Called after each assignment. Makes sure conversations and votes are consistent.
  - getMaxSuspiciousAgents
```
protected final java.util.ArrayList<Agent> getMaxSuspiciousAgents()
```
    Get the maximum suspicious agents list
    
    Returns:
    the arraylist of the agent who has the highest suspicious weight
  - addCompetitor
```
public void addCompetitor(Agent competitor)
```
    Description copied from interface: Agent
    
    Adds an competing Agent to this Agent's list of competitors
    
    Specified by:
    
    addCompetitor in interface Agent
    
    Parameters:
    competitor - a new Agent to compete with
  - addCompetitors
```
public void addCompetitors(java.util.Collection<Agent> others)
```
    Description copied from interface: Agent
    
    Adds competitors to the current Agent class
    
    Specified by:
    
    addCompetitors in interface Agent
    
    Parameters:
    others - Collection with other Agents
  - isMole
```
public boolean isMole()
```
    Description copied from interface: Agent
    
    Is this agent the mole?
    
    Specified by:
    
    isMole in interface Agent
    
    Returns:
    true if this agent is the mole, false otherwise
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: Agent
    
    What is this agent's name?
    
    Specified by:
    
    getName in interface Agent
    
    Returns:
    a String containing the name of this Agent
  - setName
```
public void setName(java.lang.String name)
```
  - avgSuspicion
```
protected double avgSuspicion()
```
    Calculate average suspicion over all competitors
    
    Returns:
    the average suspicion, a number between 0 and 1
  - normalizeSuspicions
```
public void normalizeSuspicions()
```
    Description copied from interface: Agent
    
    Normalizes the suspicions so they sum up to one.
    
    Specified by:
    
    normalizeSuspicions in interface Agent
  - summedSuspicion
```
protected double summedSuspicion()
```
    Calculates the sum of all suspicions of this Agent, used by AvgSuspicion and by normalizeSuspicion
    
    Returns:
    The sum of all suspicion values of this Agent
  - updateView
```
protected void updateView()
```
    Update the view of agent.
  - toString
```
public java.lang.String toString()
```
    Returns the name of this agent
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    the name of this agent
  - getSuspicions
```
public java.util.HashMap<Agent,java.lang.Double> getSuspicions()
```
    Returns the current suspicion map
    
    Returns:
    the current suspicion map which indicates the suspicious weight of each agent
  - getTypeString
```
public java.lang.String getTypeString()
```
    Should return some String describing what this agent's type or intentions are. Is displayed in the GUI.
    
    Returns:
    some String describing what this agent's type or intentions are
  - setTypeString
```
protected void setTypeString(java.lang.String s)
```
    Sets the typestring, displayed in the GUI, to a specific String
    
    Parameters:
    s - the desired type describing string for this AgentImplementation
  - getNumberOfCompetitors
```
public int getNumberOfCompetitors()
```
    Returns the number of competitors this AgentImplementation has currently
    
    Returns:
    the number of competitors in

Class AgentImplementation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Methods inherited from interface agent.Agent

Field Detail

nameString

mole

eliminated

suspicions

secondOrderBelief

ponderings

currentVote

typeString

Constructor Detail

AgentImplementation

AgentImplementation

Method Detail

getPonderings

ponder

tellConversation

listenConversation

eliminate

isEliminated

updateSuspicion

clearSecondOrderBelief

vote

decideVote

getMaxSuspiciousAgents

addCompetitor

addCompetitors

isMole

getName

setName

avgSuspicion

normalizeSuspicions

summedSuspicion

updateView

toString

getSuspicions

getTypeString

setTypeString

getNumberOfCompetitors