org.volante.abm.agent

Class AbstractAgent

java.lang.Object

org.volante.abm.agent.AbstractAgent

All Implemented Interfaces:

de.cesr.more.basic.agent.MoreObservingNetworkAgent<Agent>, Agent

Direct Known Subclasses:

DefaultAgent

public abstract class AbstractAgent
extends Object
implements Agent

Contains useful functionality for building agents. Covers: * having an age and increasing it by 1 each year * having a Region and a set of Cells * knowing the current service provision level and competitiveness

Nested Class Summary

Nested classes/interfaces inherited from interface de.cesr.more.basic.agent.MoreObservingNetworkAgent

de.cesr.more.basic.agent.MoreObservingNetworkAgent.NetworkObservation, de.cesr.more.basic.agent.MoreObservingNetworkAgent.NetworkObservations

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<Cell>	cells
protected double	currentCompetitiveness
protected String	id
protected com.moseph.modelutils.fastdata.DoubleMap<Service>	productivity
protected Region	region

Fields inherited from interface org.volante.abm.agent.Agent

NOT_MANAGED, NOT_MANAGED_COMPETITION, NOT_MANAGED_ID

Constructor Summary

Constructors

Constructor and Description
AbstractAgent()

Method Summary

Modifier and Type	Method and Description
void	addCell(Cell c) Adds the cell to the cells this agent manages.
void	die() Called to remove the agent instance from the system.
int	getAge() Returns the agent's current age in years
Set<Cell>	getCells() Returns all the cells the agent manages
double	getCompetitiveness() Returns the agents current competitiveness.
Cell	getHomeCell() Return simply the first cell of an iterator of cells.
String	getID() Returns the agent's ID/type
Region	getRegion()
void	giveUp()
void	removeCell(Cell c) Removes the cell from the set the agent manages
void	setAge(int a) Sets the agent's current age
void	setId(String id)
void	setRegion(Region r)
void	tickEndUpdate() Called at the ending of each tick to allow the agent to do any internal housekeeping
void	tickStartUpdate() Called at the beginning of each tick to allow the agent to do any internal housekeeping
boolean	toRemove() Returns true if this agent has lost all its cells and should be removed
String	toString()
void	updateCompetitiveness() Uses the current level of production in each Cell to update competitiveness (hence independent of the Agent)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.volante.abm.agent.Agent

canTakeOver, considerGivingUp, getGivingIn, getGivingUp, getProductionModel, getType, infoString, setGivingIn, setGivingUp, supply, updateSupply

Methods inherited from interface de.cesr.more.basic.agent.MoreObservingNetworkAgent

receiveNotification

Field Detail

id

protected String id

region

protected Region region

cells

protected Set<Cell> cells

productivity

protected com.moseph.modelutils.fastdata.DoubleMap<Service> productivity

currentCompetitiveness

protected double currentCompetitiveness

Constructor Detail

AbstractAgent

public AbstractAgent()

Method Detail

addCell

public void addCell(Cell c)

Description copied from interface: Agent

Adds the cell to the cells this agent manages. Use Region.setOwnership(Agent, Cell...) to add cells since this method is called by Region.setOwnership(Agent, Cell...)!

Specified by:

addCell in interface Agent

removeCell

public void removeCell(Cell c)

Description copied from interface: Agent

Removes the cell from the set the agent manages

Specified by:

removeCell in interface Agent

getCompetitiveness

public double getCompetitiveness()

Description copied from interface: Agent

Returns the agents current competitiveness. Should be free

Specified by:

getCompetitiveness in interface Agent

Returns:

competitiveness

getCells

public Set<Cell> getCells()

Description copied from interface: Agent

Returns all the cells the agent manages

Specified by:

getCells in interface Agent

Returns:

cells the agent manages

getHomeCell

public Cell getHomeCell()

Return simply the first cell of an iterator of cells.

Specified by:

getHomeCell in interface Agent

Returns:

the cell that is considered as the agent's base cell

See Also:

Agent.getHomeCell()

toRemove

public boolean toRemove()

Description copied from interface: Agent

Returns true if this agent has lost all its cells and should be removed

Specified by:

toRemove in interface Agent

Returns:

true if this agent is to remove

getID

public String getID()

Description copied from interface: Agent

Returns the agent's ID/type

Specified by:

getID in interface Agent

Returns:

ID

toString

public String toString()

Overrides:

toString in class Object

setId

public void setId(String id)

tickStartUpdate

public void tickStartUpdate()

Description copied from interface: Agent

Called at the beginning of each tick to allow the agent to do any internal housekeeping

Specified by:

tickStartUpdate in interface Agent

tickEndUpdate

public void tickEndUpdate()

Description copied from interface: Agent

Called at the ending of each tick to allow the agent to do any internal housekeeping

Specified by:

tickEndUpdate in interface Agent

getAge

public int getAge()

Description copied from interface: Agent

Returns the agent's current age in years

Specified by:

getAge in interface Agent

Returns:

agent's age

setAge

public void setAge(int a)

Description copied from interface: Agent

Sets the agent's current age

Specified by:

setAge in interface Agent

setRegion

public void setRegion(Region r)

Specified by:

setRegion in interface Agent

getRegion

public Region getRegion()

Specified by:

getRegion in interface Agent

giveUp

public void giveUp()

die

public void die()

Description copied from interface: Agent

Called to remove the agent instance from the system.

Specified by:

die in interface Agent

See Also:

Agent.die()

updateCompetitiveness

public void updateCompetitiveness()

Uses the current level of production in each Cell to update competitiveness (hence independent of the Agent)

Specified by:

updateCompetitiveness in interface Agent