uk.ac.newcastle.team22.usb.navigation

Class Edge

java.lang.Object

uk.ac.newcastle.team22.usb.navigation.Edge

public class Edge
extends java.lang.Object

A class that represents an edge between two Node in the Urban Sciences Building. See Node for more information on nodes.

Version:

1.0

Author:

Daniel Vincent

Field Summary

Fields

Modifier and Type	Field and Description
boolean	accessible Boolean value whether the edge is accessible.
boolean	cardLocked Boolean value whether the edge requires card authorization.
java.util.List<java.lang.Integer>	directions The directions from the edge.
java.util.List<java.lang.Double>	distances The distances from the edge.
double	weight The weight of the edge.

Constructor Summary

Constructors

Constructor and Description
Edge(Node origin, int destinationIdentifier, double weight, java.util.List<java.lang.Integer> directions, java.util.List<java.lang.Double> distances, boolean cardLocked, boolean accessible) Construct an edge between nodes.
Edge(Node origin, java.util.Map<java.lang.String,java.lang.Object> firestoreDictionary) Initialise an edge from Firebase.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Logical equality checking for edges, falls back to superclass for unknown object types.
Node	getDestination()
Node	getOrigin()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

weight

public final double weight

The weight of the edge.

directions

public final java.util.List<java.lang.Integer> directions

The directions from the edge.

distances

public final java.util.List<java.lang.Double> distances

The distances from the edge.

cardLocked

public final boolean cardLocked

Boolean value whether the edge requires card authorization.

accessible

public final boolean accessible

Boolean value whether the edge is accessible.

Constructor Detail

Edge

public Edge(Node origin,
            int destinationIdentifier,
            double weight,
            java.util.List<java.lang.Integer> directions,
            java.util.List<java.lang.Double> distances,
            boolean cardLocked,
            boolean accessible)

Construct an edge between nodes.

Parameters:

origin - Origin node of this edge.

destinationIdentifier - Identifier of destination node of this edge.

weight - Total weight of the path this edge represents.

directions - List of direction - Copy is made.

distances - List of distances for each direction - Copy is made.

cardLocked - boolean whether card access is required.

accessible - boolean whether this edge meets accessibility needs.

Edge

public Edge(Node origin,
            java.util.Map<java.lang.String,java.lang.Object> firestoreDictionary)
     throws FirestoreConstructable.InitialisationFailed

Initialise an edge from Firebase.

Parameters:

origin - Origin node of this edge.

firestoreDictionary - Map representation of this edge in Firebase.

Throws:

FirestoreConstructable.InitialisationFailed

Method Detail

getOrigin

public Node getOrigin()

Returns:

Origin node of this edge.

getDestination

public Node getDestination()

Returns:

Node with nodeIdentifier of this edge from USB.navigationNodes.

equals

public boolean equals(java.lang.Object obj)

Logical equality checking for edges, falls back to superclass for unknown object types.

Overrides:

equals in class java.lang.Object

Parameters:

obj - Object to compare to this.

Returns:

@{code true} if edges are logically equivalent, or objects have the same hash, otherwise false.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

String representation of an edge.