org.volante.abm.example

Class SimplePotentialAgent

java.lang.Object

org.volante.abm.example.SimplePotentialAgent

All Implemented Interfaces:

PotentialAgent, Initialisable

Direct Known Subclasses:

IndividualProductionPotentialAgent, SocialSimplePotentialAgent, VariantPotentialAgent

public class SimplePotentialAgent
extends Object
implements PotentialAgent, Initialisable

Field Summary

Fields

Modifier and Type	Field and Description
protected ModelData	data
protected double	givingIn
protected double	givingUp
protected String	id
protected RunInfo	info
protected Logger	log
protected ProductionModel	production
protected Set<PotentialAgentProductionObserver>	productionObserver
protected int	serialID

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

NOT_MANAGED_TYPE, UNKNOWN_SERIAL

Constructor Summary

Constructors

Constructor and Description
SimplePotentialAgent()
SimplePotentialAgent(String id, ModelData data, ProductionModel production, double givingUp, double givingIn)

Method Summary

Modifier and Type	Method and Description
Agent	createAgent(Region region, Cell... cells) Create a new agent from this potential agent in the given region and assign it as owner of the given cells.
double	getGivingIn()
double	getGivingUp()
String	getID()
com.moseph.modelutils.fastdata.DoubleMap<Service>	getPotentialSupply(Cell cell)
ProductionModel	getProduction() In case the production model is changed, a call to productionModelChanged() is mandatory! TODO make ProductionModel immutable
int	getSerialID()
void	initialise(ModelData data, RunInfo info, Region r)
void	productionModelChanged()
void	registerPotentialAgentProductionObserver(PotentialAgentProductionObserver observer)
void	removePotentialAgentProductionObserver(PotentialAgentProductionObserver observer)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

production

protected ProductionModel production

givingUp

protected double givingUp

givingIn

protected double givingIn

id

protected String id

serialID

protected int serialID

data

protected ModelData data

info

protected RunInfo info

log

protected Logger log

productionObserver

protected Set<PotentialAgentProductionObserver> productionObserver

Constructor Detail

SimplePotentialAgent

public SimplePotentialAgent()

SimplePotentialAgent

public SimplePotentialAgent(String id,
                            ModelData data,
                            ProductionModel production,
                            double givingUp,
                            double givingIn)

Method Detail

getPotentialSupply

public com.moseph.modelutils.fastdata.DoubleMap<Service> getPotentialSupply(Cell cell)

Specified by:

getPotentialSupply in interface PotentialAgent

createAgent

public Agent createAgent(Region region,
                         Cell... cells)

Description copied from interface: PotentialAgent

Create a new agent from this potential agent in the given region and assign it as owner of the given cells.

Specified by:

createAgent in interface PotentialAgent

Returns:

agent

See Also:

PotentialAgent.createAgent(org.volante.abm.data.Region, org.volante.abm.data.Cell[])

getID

public String getID()

Specified by:

getID in interface PotentialAgent

getSerialID

public int getSerialID()

Specified by:

getSerialID in interface PotentialAgent

getGivingUp

public double getGivingUp()

Specified by:

getGivingUp in interface PotentialAgent

getGivingIn

public double getGivingIn()

Specified by:

getGivingIn in interface PotentialAgent

initialise

public void initialise(ModelData data,
                       RunInfo info,
                       Region r)
                throws Exception

Specified by:

initialise in interface Initialisable

Parameters:

data - model data

info - run information

r - region the initialisable object belongs to

Throws:

Exception

getProduction

public ProductionModel getProduction()

In case the production model is changed, a call to productionModelChanged() is mandatory! TODO make ProductionModel immutable

Specified by:

getProduction in interface PotentialAgent

See Also:

PotentialAgent.getProduction()

productionModelChanged

public void productionModelChanged()

toString

public String toString()

Overrides:

toString in class Object

registerPotentialAgentProductionObserver

public void registerPotentialAgentProductionObserver(PotentialAgentProductionObserver observer)

Specified by:

registerPotentialAgentProductionObserver in interface PotentialAgent

removePotentialAgentProductionObserver

public void removePotentialAgentProductionObserver(PotentialAgentProductionObserver observer)

Specified by:

removePotentialAgentProductionObserver in interface PotentialAgent