Package org.planit.mode

Class ModeImpl

java.lang.Object

org.planit.mode.ModeImpl

All Implemented Interfaces:

Comparable<Idable>, ExternalIdable, Idable, Mode

Direct Known Subclasses:

PredefinedModeImpl

public class ModeImpl
extends Object
implements Mode

A Mode is a user class feature representing a single form of transport (car, truck etc.).

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static Long	DEFAULT_EXTERNAL_ID

Fields inherited from interface org.planit.utils.mode.Mode

DEFAULT_XML_ID, GLOBAL_DEFAULT_MAXIMUM_SPEED_KMH, GLOBAL_DEFAULT_PCU

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModeImpl(IdGroupingToken groupId, double maxSpeed, String name, double pcu)	Constructor, using all defaults for non-provided parameters
protected	ModeImpl(IdGroupingToken groupId, String name, double maxSpeed, double pcu, PhysicalModeFeatures physicalFeatures, UsabilityModeFeatures usabilityFeatures)	Constructor, using all defaults for non-provided parameters

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getExternalId()	get external id of the entity
long	getId()	collect id of the entity
double	getMaximumSpeedKmH()	maximum speed for this mode
String	getName()	Name of this mode
double	getPcu()	Passenger car unit conversion factor for this mode
PhysicalModeFeatures	getPhysicalFeatures()	collect the physical features of this mode
UsabilityModeFeatures	getUseFeatures()	collect the features of how this mode is used (public, private etc.)
String	getXmlId()	the id exposed to users as the "normal" id in the PLANit native xml format
boolean	hasExternalId()	check if external id is available or not
int	hashCode()
void	setExternalId(String externalId)	set the external id
void	setXmlId(String xmlId)	set the external id

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.planit.utils.id.ExternalIdable

hasXmlId

Methods inherited from interface org.planit.utils.id.Idable

compareTo, idEquals, idHashCode

Methods inherited from interface org.planit.utils.mode.Mode

getPredefinedModeType, hasName, hasPhysicalFeatures, hasUseFeatures, isPredefinedModeType

Field Detail

DEFAULT_EXTERNAL_ID

public static final Long DEFAULT_EXTERNAL_ID

Constructor Detail

ModeImpl

protected ModeImpl(IdGroupingToken groupId,
                   double maxSpeed,
                   String name,
                   double pcu)

Constructor, using all defaults for non-provided parameters

Parameters:

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

name - the name of this mode

maxSpeed - this mode takes on

pcu - the PCU value of this mode

ModeImpl

protected ModeImpl(IdGroupingToken groupId,
                   String name,
                   double maxSpeed,
                   double pcu,
                   PhysicalModeFeatures physicalFeatures,
                   UsabilityModeFeatures usabilityFeatures)

Constructor, using all defaults for non-provided parameters

Parameters:

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

name - the name of this mode

maxSpeed - this mode takes on

pcu - the PCU value of this mode

physicalFeatures - physical features of the mode

usabilityFeatures - usability features of the mode

Method Detail

getId

public long getId()

collect id of the entity

Specified by:

getId in interface Idable

Returns:

id

getExternalId

public String getExternalId()

get external id of the entity

Specified by:

getExternalId in interface ExternalIdable

Returns:

external id

setExternalId

public void setExternalId(String externalId)

set the external id

Specified by:

setExternalId in interface ExternalIdable

Parameters:

externalId - to set

getXmlId

public String getXmlId()

the id exposed to users as the "normal" id in the PLANit native xml format

Specified by:

getXmlId in interface ExternalIdable

Returns:

xmlId

setXmlId

public void setXmlId(String xmlId)

set the external id

Specified by:

setXmlId in interface ExternalIdable

Parameters:

xmlId - to set

hasExternalId

public boolean hasExternalId()

check if external id is available or not

Specified by:

hasExternalId in interface ExternalIdable

Returns:

true when nont null, false otherwise

getName

public String getName()

Name of this mode

Specified by:

getName in interface Mode

Returns:

the name

getMaximumSpeedKmH

public double getMaximumSpeedKmH()

maximum speed for this mode

Specified by:

getMaximumSpeedKmH in interface Mode

Returns:

maximum speed

getPcu

public double getPcu()

Passenger car unit conversion factor for this mode

Specified by:

getPcu in interface Mode

Returns:

pcu

getPhysicalFeatures

public final PhysicalModeFeatures getPhysicalFeatures()

collect the physical features of this mode

Specified by:

getPhysicalFeatures in interface Mode

Returns:

the physical mode features

getUseFeatures

public final UsabilityModeFeatures getUseFeatures()

collect the features of how this mode is used (public, private etc.)

Specified by:

getUseFeatures in interface Mode

Returns:

the use features of this mode

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object