ou4

Class Environment

java.lang.Object

ou4.Environment

public class Environment
extends java.lang.Object

A matrix of nodes that make up a network. Contains coordinate information and keeps track of the rules governing the actions within (such as agents or queries).

Constructor Summary

Constructors

Constructor and Description
Environment(int height, int width, int agentMaxSteps, int queryMaxSteps, float agentChance, float eventChance, float queryChance, float nodeMaxDistance) Construct and initialize the coordinate matrix with its limitations.

Method Summary

Modifier and Type	Method and Description
int	eventHash(int timeStep, Node node) Creates hash-ID's for events.
float	getAgentChance() Gets the probability of an agent spawning.
int	getAgentMaxSteps() Gets how many steps an agent can take.
java.util.ArrayList<Node>	getNeighbouringNodes(Node centerNode, float maxDistance) Retunrs a list of nodes surrounding a centerNode.
int	getQueryMaxSteps() Gets how many steps a query can take.
int	getRunningSteps() Returns how many steps the simulation as been running
void	step() Runs one timestep and increments steps with 1.

Methods inherited from class java.lang.Object

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

Constructor Detail

Environment

public Environment(int height,
                   int width,
                   int agentMaxSteps,
                   int queryMaxSteps,
                   float agentChance,
                   float eventChance,
                   float queryChance,
                   float nodeMaxDistance)

Construct and initialize the coordinate matrix with its limitations.

Parameters:

height - the vertical size of the matrix

width - the horizontal size of the matrix

agentMaxSteps - the limit of steps possible by the agent

queryMaxSteps - the limit of steps possible by the query

agentChance - the probability of an agent spawning

eventChance - the probability of an event spawning

queryChance - the probability of a query spawning

nodeMaxDistance - the limit to the distance allowed between communicating nodes

Method Detail

step

public void step()

Runs one timestep and increments steps with 1.

eventHash

public int eventHash(int timeStep,
                     Node node)

Creates hash-ID's for events.

Returns:

eventID a hash-ID

getAgentChance

public float getAgentChance()

Gets the probability of an agent spawning.

Returns:

agentChance the chance of an agent spawning

getAgentMaxSteps

public int getAgentMaxSteps()

Gets how many steps an agent can take.

Returns:

agentMaxSteps the maximum amount of agent steps

getQueryMaxSteps

public int getQueryMaxSteps()

Gets how many steps a query can take.

Returns:

queryMaxSteps the maximum amount of query steps

getRunningSteps

public int getRunningSteps()

Returns how many steps the simulation as been running

Returns:

steps running

getNeighbouringNodes

public java.util.ArrayList<Node> getNeighbouringNodes(Node centerNode,
                                                      float maxDistance)

Retunrs a list of nodes surrounding a centerNode.

Parameters:

centerNode - node to be searched around.

maxDistance - max distance to be searched.

Returns:

Nodes within maxDistance of centerNode.