Agent

All Superinterfaces:

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

All Known Subinterfaces:

InnovationAgent, SocialAgent, SocialInnovationAgent

All Known Implementing Classes:

AbstractAgent, BoundedSocialInnovationAgent, DefaultAgent, DefaultSocialInnovationAgent
```
public interface Agent
extends de.cesr.more.basic.agent.MoreObservingNetworkAgent<Agent>
```
An interface detailing all the methods an Agent has to provide.

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
`static Agent`	`NOT_MANAGED` The NOT_MANAGED agent is used for all cells without a manager
`static double`	`NOT_MANAGED_COMPETITION`
`static String`	`NOT_MANAGED_ID`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCell(Cell c)` Adds the cell to the cells this agent manages.
`boolean`	`canTakeOver(Cell c, double competitiveness)` Return true if this agent is happy to cede to an agent with the given level of competitiveness
`void`	`considerGivingUp()` Asks this agent if it wants to give up
`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.
`double`	`getGivingIn()`
`double`	`getGivingUp()`
`Cell`	`getHomeCell()`
`String`	`getID()` Returns the agent's ID/type
`ProductionModel`	`getProductionModel()` Returns the production model of this agent.
`Region`	`getRegion()`
`PotentialAgent`	`getType()`
`String`	`infoString()` Returns useful descriptive information about this agent
`void`	`removeCell(Cell c)` Removes the cell from the set the agent manages
`void`	`setAge(int age)` Sets the agent's current age
`void`	`setGivingIn(double threshold)`
`void`	`setGivingUp(double threshold)`
`void`	`setRegion(Region r)`
`com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service>`	`supply(Cell c)` Returns what this agent could supply on the given cell
`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
`void`	`updateCompetitiveness()` Updates the agent's competitiveness, in response to demand changes etc.
`void`	`updateSupply()` Recalculates the services this agent can supply

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

- Field Detail
  - NOT_MANAGED
```
static final Agent NOT_MANAGED
```
    The NOT_MANAGED agent is used for all cells without a manager
  - NOT_MANAGED_ID
```
static final String NOT_MANAGED_ID
```
    See Also:
    
    Constant Field Values
  - NOT_MANAGED_COMPETITION
```
static final double NOT_MANAGED_COMPETITION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getCells
```
Set<Cell> getCells()
```
    Returns all the cells the agent manages
    
    Returns:
    
    cells the agent manages
  - getHomeCell
```
Cell getHomeCell()
```
    Returns:
    
    the cell that is considered as the agent's base cell
  - removeCell
```
void removeCell(Cell c)
```
    Removes the cell from the set the agent manages
    
    Parameters:
    
    c -
  - getCompetitiveness
```
double getCompetitiveness()
```
    Returns the agents current competitiveness. Should be free
    
    Returns:
    
    competitiveness
  - getProductionModel
```
ProductionModel getProductionModel()
```
    Returns the production model of this agent.
    
    Returns:
    
    production model
  - updateCompetitiveness
```
void updateCompetitiveness()
```
    Updates the agent's competitiveness, in response to demand changes etc.
  - updateSupply
```
void updateSupply()
```
    Recalculates the services this agent can supply
  - considerGivingUp
```
void considerGivingUp()
```
    Asks this agent if it wants to give up
  - supply
```
com.moseph.modelutils.fastdata.UnmodifiableNumberMap<Service> supply(Cell c)
```
    Returns what this agent could supply on the given cell
    
    Parameters:
    
    c -
    
    Returns:
    
    unmodifiable supply map
  - addCell
```
void addCell(Cell c)
```
    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...)!
    
    Parameters:
    
    c -
  - toRemove
```
boolean toRemove()
```
    Returns true if this agent has lost all its cells and should be removed
    
    Returns:
    
    true if this agent is to remove
  - die
```
void die()
```
    Called to remove the agent instance from the system.
  - getID
```
String getID()
```
    Returns the agent's ID/type
    
    Returns:
    
    ID
  - canTakeOver
```
boolean canTakeOver(Cell c,
                    double competitiveness)
```
    Return true if this agent is happy to cede to an agent with the given level of competitiveness
    
    Parameters:
    
    c -
    
    competitiveness -
    
    Returns:
    
    true if an agent with the given competitiveness can take over the given cell from this agents
  - infoString
```
String infoString()
```
    Returns useful descriptive information about this agent
    
    Returns:
    
    info
  - getAge
```
int getAge()
```
    Returns the agent's current age in years
    
    Returns:
    
    agent's age
  - setAge
```
void setAge(int age)
```
    Sets the agent's current age
    
    Parameters:
    
    age -
  - tickStartUpdate
```
void tickStartUpdate()
```
    Called at the beginning of each tick to allow the agent to do any internal housekeeping
  - tickEndUpdate
```
void tickEndUpdate()
```
    Called at the ending of each tick to allow the agent to do any internal housekeeping
  - getType
```
PotentialAgent getType()
```
  - setGivingUp
```
void setGivingUp(double threshold)
```
  - getGivingUp
```
double getGivingUp()
```
  - setGivingIn
```
void setGivingIn(double threshold)
```
  - getGivingIn
```
double getGivingIn()
```
  - setRegion
```
void setRegion(Region r)
```
  - getRegion
```
Region getRegion()
```

Interface Agent

Nested Class Summary

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

Field Summary

Method Summary

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

Field Detail

NOT_MANAGED

NOT_MANAGED_ID

NOT_MANAGED_COMPETITION

Method Detail

getCells

getHomeCell

removeCell

getCompetitiveness

getProductionModel

updateCompetitiveness

updateSupply

considerGivingUp

supply

addCell

toRemove

die

getID

canTakeOver

infoString

getAge

setAge

tickStartUpdate

tickEndUpdate

getType

setGivingUp

getGivingUp

setGivingIn

getGivingIn

setRegion

getRegion