org.opentrafficsim.core.network

Class LinkType

java.lang.Object

org.opentrafficsim.base.Type<LinkType>

org.opentrafficsim.core.network.LinkType

All Implemented Interfaces:

Serializable

public class LinkType
extends org.opentrafficsim.base.Type<LinkType>
implements Serializable

Link type to indicate compatibility with GTU types. The id of a LinkType should be unique within a simulation. This is, however, not checked or enforced, as different simulations running in the same JVM can have different compatibilitySets for LinkTypes with the same id. Therefore, uniqueness is not enforced.

Copyright (c) 2013-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-08-30 00:16:51 +0200 (Sun, 30 Aug 2015) $, @version $Revision: 1329 $, by $Author: averbraeck $, initial version Aug 21, 2014

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static LinkType	ALL The link type that allows all vehicles.
static LinkType	NONE The link type that does not allow any vehicles.

Constructor Summary

Constructors

Constructor and Description
LinkType(String id, Collection<GTUType> compatibility) Create a new Link type with an immutable compatibility set.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getId()
int	hashCode()
boolean	isCompatible(GTUType gtuType)
String	toString()

Methods inherited from class org.opentrafficsim.base.Type

isType

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final LinkType NONE

The link type that does not allow any vehicles.

ALL

public static final LinkType ALL

The link type that allows all vehicles.

Constructor Detail

LinkType

public LinkType(String id,
                Collection<GTUType> compatibility)
         throws NullPointerException

Create a new Link type with an immutable compatibility set.

Parameters:

id - the id of the lane type.

compatibility - the collection of compatible GTUTypes for this LinkType

Throws:

NullPointerException - if either the id is null, or the compatibilitySet is null

Method Detail

isCompatible

public final boolean isCompatible(GTUType gtuType)

Parameters:

gtuType - GTU type to look for compatibility.

Returns:

whether the LaneType is compatible with the GTU type, or compatible with all GTU types.

getId

public final String getId()

Returns:

id.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object