ou4

Class Node

java.lang.Object

ou4.Node

public class Node
extends java.lang.Object

A sensor node in the coordinate space which can detect events. The node keeps a list of events that it has detected and events that it have received information about from agents. The node keeps track of shortest pathway for events in other nodes. The node can send out agents to spread information abouts events and queries to locate events.

Constructor Summary

Constructors

Constructor and Description
Node(Position position) Construct and initialize a sensor node

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	checkBusy() Check if node is busy
void	detectEvent(Event event) Makes the node detect an event
boolean	equals(java.lang.Object o)
Event	getEventFromId(int id) Get Event data
java.util.HashMap<java.lang.Integer,Event>	getEvents() Gets the hashmap of events
java.util.HashMap<java.lang.Integer,Route>	getKnownRoutes() Gets the hashmap of knownRoutes
java.util.List<Node>	getNeighbours() Returns a list of neighbours
Position	getPosition() Get node position.
Route	getRouteFromId(int id) Get route from routing list
void	insertNeighbour(Node neighbour) Insert a neighbor that messages can be sent to
boolean	receiveMessage(Message message) Takes a message into the nodes job queue
void	setNotBusy()
void	setNotBusyIfEmpty() Sets not busy if the node has no messages
void	setSyncedRoutes(java.util.HashMap<java.lang.Integer,Route> syncedRoutes) Set a HashMap of syncedRoutes
void	spawnAgent(int maxsteps) Create an agent to spread the list of events
void	spawnQuery(int queryId, int maxsteps) Create a querie to find an event
void	update() Updates the node one timestep

Methods inherited from class java.lang.Object

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

Constructor Detail

Node

public Node(Position position)
     throws java.lang.IllegalArgumentException

Construct and initialize a sensor node

Parameters:

position - The nodes position

Throws:

java.lang.IllegalArgumentException

Method Detail

detectEvent

public void detectEvent(Event event)
                 throws java.lang.IllegalArgumentException

Makes the node detect an event

Parameters:

event - Event to detect.

Throws:

java.lang.IllegalArgumentException

spawnAgent

public void spawnAgent(int maxsteps)
                throws java.lang.IllegalArgumentException

Create an agent to spread the list of events

Throws:

java.lang.IllegalArgumentException

spawnQuery

public void spawnQuery(int queryId,
                       int maxsteps)
                throws java.lang.IllegalArgumentException

Create a querie to find an event

Parameters:

queryId - The id for the event to find

maxsteps - max timesteps query is allowed to live

Throws:

java.lang.IllegalArgumentException

update

public void update()

Updates the node one timestep

insertNeighbour

public void insertNeighbour(Node neighbour)
                     throws java.lang.IllegalArgumentException

Insert a neighbor that messages can be sent to

Parameters:

neighbour - the neighbor to be inserted

Throws:

java.lang.IllegalArgumentException

getEventFromId

public Event getEventFromId(int id)
                     throws java.lang.IllegalArgumentException

Get Event data

Parameters:

id - the event id

Returns:

the Event

Throws:

java.lang.IllegalArgumentException

getRouteFromId

public Route getRouteFromId(int id)
                     throws java.lang.IllegalArgumentException

Get route from routing list

Parameters:

id - id of route

Returns:

Route with id

Throws:

java.lang.IllegalArgumentException

getPosition

public Position getPosition()

Get node position.

Returns:

position of node.

receiveMessage

public boolean receiveMessage(Message message)
                       throws java.lang.IllegalArgumentException

Takes a message into the nodes job queue

Parameters:

message - the message to be receive

Throws:

java.lang.IllegalArgumentException

setNotBusyIfEmpty

public void setNotBusyIfEmpty()

Sets not busy if the node has no messages

setNotBusy

public void setNotBusy()

checkBusy

public java.lang.Boolean checkBusy()

Check if node is busy

getEvents

public java.util.HashMap<java.lang.Integer,Event> getEvents()

Gets the hashmap of events

Returns:

events

getKnownRoutes

public java.util.HashMap<java.lang.Integer,Route> getKnownRoutes()

Gets the hashmap of knownRoutes

Returns:

knownRoutes

setSyncedRoutes

public void setSyncedRoutes(java.util.HashMap<java.lang.Integer,Route> syncedRoutes)
                     throws java.lang.IllegalArgumentException

Set a HashMap of syncedRoutes

Parameters:

syncedRoutes - the synced route

Throws:

java.lang.IllegalArgumentException

getNeighbours

public java.util.List<Node> getNeighbours()

Returns a list of neighbours

Returns:

nodes list of neighbours

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object