Package org.opentrafficsim.road.od

Class Category

java.lang.Object

org.opentrafficsim.road.od.Category

All Implemented Interfaces:

Serializable

public class Category
extends Object
implements Serializable

A category is a set of objects who's class belongs to a certain categorization. One Category object can specify to which subset of traffic between on origin and destination certain demand data belongs.

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

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Category	UNCATEGORIZED	Empty category.

Constructor Summary

Constructors

Constructor	Description
Category(Categorization categorization, Object object1, Object... objects)

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object obj)
final Object	get(int i)	Returns the i'th object.
final <T> T	get(Class<T> clazz)	Returns the object of this category pertaining to the specified class from the category.
final Categorization	getCategorization()
final int	hashCode()
final String	toString()

Methods inherited from class java.lang.Object

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

Field Details

UNCATEGORIZED

public static final Category UNCATEGORIZED

Empty category.

Constructor Details

Category

public Category(Categorization categorization,
 Object object1,
 Object... objects)

Parameters:

categorization - Categorization; categorization

object1 - Object; 1st object

objects - Object...; other objects

Throws:

IllegalArgumentException - if the objects do not comply with the categorization

NullPointerException - if any input is null

Method Details

get

public final Object get(int i)

Returns the i'th object.

Parameters:

i - int; index of the object

Returns:

the i'th object

Throws:

IndexOutOfBoundsException - if index i is out of bounds

getCategorization

public final Categorization getCategorization()

Returns:

categorization.

get

public final <T> T get(Class<T> clazz)

Returns the object of this category pertaining to the specified class from the category.

Type Parameters:

T - type of the object

Parameters:

clazz - Class<T>; class from categorization to get the category object for

Returns:

Object; object of this category pertaining to the specified class from the category

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object