com.azalient.api.b.parameters
Interface IIncident

All Superinterfaces:

IRecord, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface IIncident
extends StoreRecordRW

An incident can be used by a plugin to model teh effects of a road incident on traffic

Nested Class Summary

static class

IIncident.Cause An enumeration of causes for an incident

Field Summary

Fields inherited from interface com.azalient.api.a.tables.IRecord

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

IIncident.Cause	cause() Returns the cause of this incident
NamedColour	colour() A colour used to annotate the incident
double	distance() Returns the distance along this lane of the location of the incident
UTime	duration() Returns the duration of this incident
int	laneIndex() Returns the lane index of this incident
Speed	opposingSpeed() Returns the speed limit for vehicles passing the incident in the opposite direction.
Speed	passingSpeed() Returns the speed limit for vehicles passing the incident (going in the same direction).
UTime	when() Returns the time of occurrence of this incident

Methods inherited from interface com.azalient.api.file.StoreRecordRW

canRename, rename, store

Methods inherited from interface com.azalient.api.file.RecordR

extraSet, finished, isApplicable, isEditable, set

Methods inherited from interface com.azalient.api.a.tables.IRecord

name

Methods inherited from interface com.azalient.api.file.RecordW

extraCols, extraGet, extraGetB, extraGetD, extraGetI, extraGetS, extraGetT, get, isVolatile

Method Detail

cause

IIncident.Cause cause()

Returns the cause of this incident

laneIndex

int laneIndex()

Returns the lane index of this incident

distance

double distance()

Returns the distance along this lane of the location of the incident

when

UTime when()

Returns the time of occurrence of this incident

duration

UTime duration()

Returns the duration of this incident

passingSpeed

Speed passingSpeed()

Returns the speed limit for vehicles passing the incident (going in the same direction). If this is null, then vehicles will use the normal lane speed

opposingSpeed

Speed opposingSpeed()

Returns the speed limit for vehicles passing the incident in the opposite direction. If this is null, then vehicles will use the normal lane speed

colour

NamedColour colour()

A colour used to annotate the incident