org.volante.abm.institutions.recruit

Class SpatialProbabilityRandomRecruitment

java.lang.Object

org.volante.abm.institutions.recruit.SpatialProbabilityRandomRecruitment

All Implemented Interfaces:

InstitutionTargetRecruitment, Initialisable

public class SpatialProbabilityRandomRecruitment
extends Object
implements InstitutionTargetRecruitment

Recruits each agent from the passed set with probability given by probability if its home cell is within the given x and y coordinate range.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	probability Probability of an agent to become initially aware.
protected Region	region
protected RunInfo	rInfo
protected int	xMax
protected int	xMin
protected int	yMax
protected int	yMin

Constructor Summary

Constructors

Constructor and Description
SpatialProbabilityRandomRecruitment()

Method Summary

Modifier and Type	Method and Description
Collection<InnovationAgent>	getRecruitedAgents(Collection<? extends Agent> allAgents)
void	initialise(ModelData data, RunInfo info, Region extent)

Methods inherited from class java.lang.Object

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

Field Detail

probability

protected String probability

Probability of an agent to become initially aware.

xMax

protected int xMax

xMin

protected int xMin

yMax

protected int yMax

yMin

protected int yMin

region

protected Region region

rInfo

protected RunInfo rInfo

Constructor Detail

SpatialProbabilityRandomRecruitment

public SpatialProbabilityRandomRecruitment()

Method Detail

initialise

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

Specified by:

initialise in interface Initialisable

Parameters:

data - model data

info - run information

extent - region the initialisable object belongs to

Throws:

Exception

See Also:

Initialisable.initialise(org.volante.abm.data.ModelData, org.volante.abm.schedule.RunInfo, org.volante.abm.data.Region)

getRecruitedAgents

public Collection<InnovationAgent> getRecruitedAgents(Collection<? extends Agent> allAgents)

Specified by:

getRecruitedAgents in interface InstitutionTargetRecruitment

Returns:

recruited agents

See Also:

InstitutionTargetRecruitment.getRecruitedAgents(java.util.Collection)