Package org.goplanit.network.layer.macroscopic

Class AccessGroupPropertiesImpl

java.lang.Object

org.goplanit.network.layer.macroscopic.AccessGroupPropertiesImpl

All Implemented Interfaces:

AccessGroupProperties

public class AccessGroupPropertiesImpl
extends Object
implements AccessGroupProperties

Group of modes with specific properties for the macroscopic perspective on the supply side, i.e. on a link segment of a particular type. While the group specifies the allowed modes, it is not compulsory to define restricted maximum and or critical speeds. When absent context of the mode and links is to be used to determine the applied maximum speeds.

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
protected Double	criticalSpeedKmH	Maximum speed of mode (tied to a road segment type) in km/h
protected Double	maxSpeedKmH	Maximum speed of mode (tied to a road segment type) in km/h
protected Set<Mode>	supportedModes	modes supported by this access group

Fields inherited from interface org.goplanit.utils.network.layer.macroscopic.AccessGroupProperties

DEFAULT_SPEED_EPSILON

Constructor Summary

Constructors

Constructor	Description
AccessGroupPropertiesImpl(Collection<Mode> accessModes)	access properties with only defining allowed modes without setting any restrictive speeds compared to the physical speed on the links it is applied on
AccessGroupPropertiesImpl(AccessGroupPropertiesImpl other, boolean deepCopy)	Copy constructor

Method Summary

Modifier and Type	Method	Description
void	addAccessMode(Mode mode)	Add mode to access group.
AccessGroupProperties	deepClone()	Deep clone this instance
Set<Mode>	getAccessModes()	The access modes for this group
Double	getCriticalSpeedKmH()	Collect the critical speed in km/h
Double	getMaximumSpeedKmH()	Collect the maximum speed in km/h
boolean	isEqualExceptForModes(AccessGroupProperties accessProperties)	Verify if equal to given properties except for the allowed modes
boolean	removeAccessMode(Mode toBeRemovedMode)	Remove access mode
void	setCriticalSpeedKmH(Double criticalSpeed)	set the critical speed in km/h
void	setMaximumSpeedKmH(Double maxSpeedKmH)	set the maximum speed in km/h
AccessGroupProperties	shallowClone()	Shallow clone this instance
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.goplanit.utils.network.layer.macroscopic.AccessGroupProperties

getCriticalSpeedOrDefaultKmH, getMaximumSpeedOrDefaultKmH, hasAccessModes, isCriticalSpeedKmHSet, isMaximumSpeedKmHSet

Field Detail

maxSpeedKmH

protected Double maxSpeedKmH

Maximum speed of mode (tied to a road segment type) in km/h

criticalSpeedKmH

protected Double criticalSpeedKmH

Maximum speed of mode (tied to a road segment type) in km/h

supportedModes

protected final Set<Mode> supportedModes

modes supported by this access group

Constructor Detail

AccessGroupPropertiesImpl

public AccessGroupPropertiesImpl(Collection<Mode> accessModes)

access properties with only defining allowed modes without setting any restrictive speeds compared to the physical speed on the links it is applied on

Parameters:

accessModes - to allow

AccessGroupPropertiesImpl

public AccessGroupPropertiesImpl(AccessGroupPropertiesImpl other,
                                 boolean deepCopy)

Copy constructor

Parameters:

other - to copy

deepCopy - when true, create a deep copy, shallow copy otherwise

Method Detail

getMaximumSpeedKmH

public Double getMaximumSpeedKmH()

Collect the maximum speed in km/h

Specified by:

getMaximumSpeedKmH in interface AccessGroupProperties

Returns:

the maximum speed in km/h

getCriticalSpeedKmH

public Double getCriticalSpeedKmH()

Collect the critical speed in km/h

Specified by:

getCriticalSpeedKmH in interface AccessGroupProperties

Returns:

the critical speed in km/h

setMaximumSpeedKmH

public void setMaximumSpeedKmH(Double maxSpeedKmH)

set the maximum speed in km/h

Specified by:

setMaximumSpeedKmH in interface AccessGroupProperties

Parameters:

maxSpeedKmH - to set

setCriticalSpeedKmH

public void setCriticalSpeedKmH(Double criticalSpeed)

set the critical speed in km/h

Specified by:

setCriticalSpeedKmH in interface AccessGroupProperties

Parameters:

criticalSpeed - to set

shallowClone

public AccessGroupProperties shallowClone()

Shallow clone this instance

Specified by:

shallowClone in interface AccessGroupProperties

Returns:

shallow copy of this instance

deepClone

public AccessGroupProperties deepClone()

Deep clone this instance

Specified by:

deepClone in interface AccessGroupProperties

Returns:

deep copy of this instance

getAccessModes

public Set<Mode> getAccessModes()

The access modes for this group

Specified by:

getAccessModes in interface AccessGroupProperties

Returns:

access modes

removeAccessMode

public boolean removeAccessMode(Mode toBeRemovedMode)

Remove access mode

Specified by:

removeAccessMode in interface AccessGroupProperties

Parameters:

toBeRemovedMode - the to be removed mode

Returns:

true when success, false otherwise

isEqualExceptForModes

public boolean isEqualExceptForModes(AccessGroupProperties accessProperties)

Verify if equal to given properties except for the allowed modes

Specified by:

isEqualExceptForModes in interface AccessGroupProperties

Parameters:

accessProperties - to compare against

Returns:

true when deemed equal, false otherwise

addAccessMode

public void addAccessMode(Mode mode)

Add mode to access group. Use with caution if registered on a link segment type, in which case adding the mode here is not sufficient since it also requires mode based indexing on the type. Better to use the link segment type methods to properly update the group access instead

Specified by:

addAccessMode in interface AccessGroupProperties

Parameters:

mode - to add

toString

public String toString()

Overrides:

toString in class Object