Package org.goplanit.userclass

Class UserClass

java.lang.Object

org.goplanit.utils.id.IdAbleImpl

org.goplanit.utils.id.ExternalIdAbleImpl

org.goplanit.userclass.UserClass

All Implemented Interfaces:

Cloneable, Comparable<IdAble>, ExternalIdAble, IdAble

public class UserClass
extends ExternalIdAbleImpl

A user class defines a combination of one or more characteristics of users in an aggregate representation of traffic which partially dictate how they behave in traffic assignment.

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_NAME	default name
static String	DEFAULT_XML_ID	Default XML id

Constructor Summary

Constructors

Constructor	Description
UserClass(UserClass other)	Copy constructor
UserClass(IdGroupingToken groupId, String name, Mode mode, TravelerType travelerType)	Constructor of user class

Method Summary

Modifier and Type	Method	Description
UserClass	clone()	Create a shallow copy of this entity
Mode	getMode()	Return the mode of travel of this user class
String	getName()	Get the name of this user class
TravelerType	getTravelerType()	Get the traveler type of this user class

Methods inherited from class org.goplanit.utils.id.ExternalIdAbleImpl

getExternalId, getXmlId, setExternalId, setXmlId

Methods inherited from class org.goplanit.utils.id.IdAbleImpl

equals, generateAndSetId, generateId, getId, hashCode, setId

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.goplanit.utils.id.ExternalIdAble

hasExternalId, hasXmlId

Methods inherited from interface org.goplanit.utils.id.IdAble

compareTo, getId, idEquals, idHashCode

Field Detail

DEFAULT_NAME

public static final String DEFAULT_NAME

default name

See Also:

Constant Field Values

DEFAULT_XML_ID

public static final String DEFAULT_XML_ID

Default XML id

See Also:

Constant Field Values

Constructor Detail

UserClass

public UserClass(IdGroupingToken groupId,
                 String name,
                 Mode mode,
                 TravelerType travelerType)

Constructor of user class

Parameters:

groupId - contiguous id generation within this group for instances of this class

name - name of this user class

mode - the mode of travel

travelerType - the travelerType

UserClass

public UserClass(UserClass other)

Copy constructor

Parameters:

other - to copy

Method Detail

getTravelerType

public TravelerType getTravelerType()

Get the traveler type of this user class

Returns:

TravelerType of this user class

getName

public String getName()

Get the name of this user class

Returns:

the name of this user class

getMode

public Mode getMode()

Return the mode of travel of this user class

Returns:

Mode of this user class

clone

public UserClass clone()

Create a shallow copy of this entity

Specified by:

clone in interface IdAble

Overrides:

clone in class ExternalIdAbleImpl

Returns:

shallow copy of entity