Package org.planit.userclass

Class UserClass

java.lang.Object

org.planit.userclass.UserClass

public class UserClass
extends Object

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 long	DEFAULT_EXTERNAL_ID	Default external id
static String	DEFAULT_NAME	default name

Constructor Summary

Constructors

Constructor	Description
UserClass(IdGroupingToken groupId, Object externalId, String name, Mode mode, TravelerType travelerType)	Constructor of user class

Method Summary

Modifier and Type	Method	Description
Object	getExternalId()	Get the external id of this user class
long	getId()	Get the id of this user class
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
boolean	hasExternalId()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NAME

public static final String DEFAULT_NAME

default name

See Also:

Constant Field Values

DEFAULT_EXTERNAL_ID

public static final long DEFAULT_EXTERNAL_ID

Default external id

See Also:

Constant Field Values

Constructor Detail

UserClass

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

Constructor of user class

Parameters:

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

externalId - id of this user class

name - name of this user class

mode - the mode of travel

travelerType - the travelerType

Method Detail

getTravelerType

public TravelerType getTravelerType()

Get the traveler type of this user class

Returns:

TravelerType of this user class

getId

public long getId()

Get the id of this user class

Returns:

id 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

getExternalId

public Object getExternalId()

Get the external id of this user class

Returns:

external id of this user class

hasExternalId

public boolean hasExternalId()