de.cesr.sesamgim.init.group
Interface GimGroupInitialiser<AgentType extends GimMilieuAgent<?>>

All Known Implementing Classes:

GGroupOrganiser

public interface GimGroupInitialiser<AgentType extends GimMilieuAgent<?>>

SesamGIM - Geographical Initialisation for Milieu Agents

Method Summary

GimGroupContext<AgentType>	getGroupContext(AgentType agent)
Collection<GimGroupContext<AgentType>>	getInitialisedGroupContexts() Returns the collection of initialised group contexts.
int	getNumberOfInitialisedGroupContext() Returns the number of group contexts that have been initialised at the call of GimGroupInitialiser#initGroupContexts(GimMarketCellContext).
Collection<GimGroupContext<AgentType>>	initGroupContexts(GimUpdatableContext<AgentType> mc) Inits group context for the given GimMarketCellContext.

Method Detail

initGroupContexts

Collection<GimGroupContext<AgentType>> initGroupContexts(GimUpdatableContext<AgentType> mc)

Inits group context for the given GimMarketCellContext. Should be able to deal with null as market cell context (i.e. if no market cell are used).

Parameters:

mc - market cell context

getGroupContext

GimGroupContext<AgentType> getGroupContext(AgentType agent)

Parameters:

agent -

Returns:

getNumberOfInitialisedGroupContext

int getNumberOfInitialisedGroupContext()

Returns the number of group contexts that have been initialised at the call of GimGroupInitialiser#initGroupContexts(GimMarketCellContext). Return 0 if groups contexts have not been initialised.

Returns:

getInitialisedGroupContexts

Collection<GimGroupContext<AgentType>> getInitialisedGroupContexts()

Returns the collection of initialised group contexts. Return null if group contexts have not been initialised.

Returns:

collection of group contexts.