Mode (PLANitAllJava 0.1.0 API)

All Superinterfaces:

Comparable<Mode>

All Known Implementing Classes:

ModeImpl
```
public interface Mode
extends Comparable<Mode>
```
Interface to represent a mode

Author:

markr

Field Summary

Fields
Modifier and Type Field Description

static long DEFAULT_EXTERNAL_ID
If no mode is defined the default mode is assumed to have an external idf of 1

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Object`	`getExternalId()`	Return the external id of this mode
`long`	`getId()`	Return id of this instance.
`String`	`getName()`	Name of this mode
`double`	`getPcu()`	Passenger car unit conversion factor for this mode
`boolean`	`hasExternalId()`	Returns whether this mode has an external Id set

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - DEFAULT_EXTERNAL_ID
```
static final long DEFAULT_EXTERNAL_ID
```
    If no mode is defined the default mode is assumed to have an external idf of 1
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getPcu
```
double getPcu()
```
    Passenger car unit conversion factor for this mode
    
    Returns:
    
    pcu
  - getName
```
String getName()
```
    Name of this mode
    
    Returns:
    
    the name
  - getId
```
long getId()
```
    Return id of this instance. This id is expected to be generated using the org.planit.utils.misc.IdGenerator
    
    Returns:
    
    unique id
  - getExternalId
```
Object getExternalId()
```
    Return the external id of this mode
    
    Returns:
    
    externalId of this mode
  - hasExternalId
```
boolean hasExternalId()
```
    Returns whether this mode has an external Id set
    
    Returns:
    
    true if external Id set, false otherwise