MacroscopicModeProperties (PLANitAllJava 0.2.0 API)

All Superinterfaces:

Cloneable

All Known Implementing Classes:

MacroscopicModePropertiesImpl
```
public interface MacroscopicModeProperties
extends Cloneable
```
Contains the properties of a mode specific to a link segment type

Author:

markr

Field Summary

Fields
Modifier and Type	Field	Description
`static double`	`DEFAULT_CRITICAL_SPEED_KMH`	Default critical speed, i.e.
`static double`	`DEFAULT_SPEED_EPSILON`	Epsilon margin when comparing speeds (km/h)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`MacroscopicModeProperties`	`clone()`	Clone this instance
`double`	`getCriticalSpeedKmH()`	Collect the critical speed in km/h
`double`	`getMaximumSpeedKmH()`	Collect the maximum speed in km/h
`void`	`setCriticalSpeedKmH(double criticalSpeedKmH)`	set the critical speed in km/h
`void`	`setMaximumSpeedKmH(double maxSpeedKmH)`	set the maximum speed in km/h

- Field Detail
  - DEFAULT_CRITICAL_SPEED_KMH
```
static final double DEFAULT_CRITICAL_SPEED_KMH
```
    Default critical speed, i.e. speed at capacity in km/h
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SPEED_EPSILON
```
static final double DEFAULT_SPEED_EPSILON
```
    Epsilon margin when comparing speeds (km/h)
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getMaximumSpeedKmH
```
double getMaximumSpeedKmH()
```
    Collect the maximum speed in km/h
    
    Returns:
    
    the maximum speed in km/h
  - setMaximumSpeedKmH
```
void setMaximumSpeedKmH(double maxSpeedKmH)
```
    set the maximum speed in km/h
    
    Parameters:
    
    maxSpeedKmH - to set
  - getCriticalSpeedKmH
```
double getCriticalSpeedKmH()
```
    Collect the critical speed in km/h
    
    Returns:
    
    the critical speed in km/h
  - setCriticalSpeedKmH
```
void setCriticalSpeedKmH(double criticalSpeedKmH)
```
    set the critical speed in km/h
    
    Parameters:
    
    criticalSpeedKmH - to set
  - clone
```
MacroscopicModeProperties clone()
```
    Clone this instance
    
    Returns:
    
    copy of this instance