pl.edu.agh.age.compute.stream

Class Environment

java.lang.Object

pl.edu.agh.age.compute.stream.Environment

public final class Environment
extends java.lang.Object

Environment passed to the step function.

Field Summary

Fields

Modifier and Type	Field and Description
private long	id
private static org.slf4j.Logger	logger
private Manager	manager

Constructor Summary

Constructors

Constructor and Description
Environment(long id, Manager manager)

Method Summary

Modifier and Type	Method and Description
void	logPopulation(java.lang.String type, io.vavr.collection.List<? extends Agent> population) Logs provided population fragment.
void	migrate(Agent agent, long targetWorkplaceId) Migrates an agent to a workplace with the given id in neighbourhood.
void	migrate(Agent agent, java.lang.String targetWorkplaceAnnotation) Migrates an agent to a workplace with the given annotation in neighbourhood.
io.vavr.collection.Map<java.lang.Long,io.vavr.collection.Set<java.lang.String>>	neighbours() Returns workplaces in the neighbourhood.
io.vavr.collection.Map<java.lang.Long,io.vavr.collection.Map<java.lang.Object,java.lang.Object>>	neighboursStatistics() Returns a read-only view of statistics map generated by AfterStepAction only for neighbours.
long	workplaceId()
long	workplacesCount() Returns the count of all workplaces (global, distributed).
io.vavr.collection.Map<java.lang.Long,io.vavr.collection.Map<java.lang.Object,java.lang.Object>>	workplaceStatistics() Returns a read-only view of statistics map generated by AfterStepAction.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

id

private final long id

manager

private final Manager manager

Constructor Detail

Environment

Environment(long id,
            Manager manager)

Method Detail

workplaceId

public long workplaceId()

workplacesCount

public long workplacesCount()

Returns the count of all workplaces (global, distributed).

neighbours

public io.vavr.collection.Map<java.lang.Long,io.vavr.collection.Set<java.lang.String>> neighbours()

Returns workplaces in the neighbourhood.

Neighbourhood is defined by the configured topology.

Returns:

a map, where keys are ids of workplaces in the neighbourhood and values are their annotations generated by the topology

See Also:

Topology

workplaceStatistics

public io.vavr.collection.Map<java.lang.Long,io.vavr.collection.Map<java.lang.Object,java.lang.Object>> workplaceStatistics()

Returns a read-only view of statistics map generated by AfterStepAction.

neighboursStatistics

public io.vavr.collection.Map<java.lang.Long,io.vavr.collection.Map<java.lang.Object,java.lang.Object>> neighboursStatistics()

Returns a read-only view of statistics map generated by AfterStepAction only for neighbours.

migrate

public void migrate(Agent agent,
                    long targetWorkplaceId)

Migrates an agent to a workplace with the given id in neighbourhood.

migrate

public void migrate(Agent agent,
                    java.lang.String targetWorkplaceAnnotation)

Migrates an agent to a workplace with the given annotation in neighbourhood.

logPopulation

public void logPopulation(java.lang.String type,
                          io.vavr.collection.List<? extends Agent> population)

Logs provided population fragment.

Parameters:

type - name of the population fragment (e.g. “dead”)

population - population to log.