public interface SpeedZone extends OsidRule
A SpeedZone
represents a speed zone in a Map.
Modifier and Type | Method and Description |
---|---|
Coordinate |
getEndingCoordinate()
Gets the ending coordinate of the speed zone on the path.
|
Path |
getPath()
Gets the path of this speed zone.
|
Id |
getPathId()
Gets the path
Id of this speed zone. |
Speed |
getSpeedLimit()
Gets the speed limit in this zone.
|
SpeedZoneRecord |
getSpeedZoneRecord(Type speedZoneRecordType)
Gets the speed zone record corresponding to the given
SpeedZone
record Type. |
Coordinate |
getStartingCoordinate()
Gets the starting coordinate of the speed zone on the path.
|
boolean |
isImplicit()
Tests if this speed zone is implicit.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
Id getPathId()
Id
of this speed zone. Id
of the pathmandatory
- This method must be implemented. Path getPath() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Coordinate getStartingCoordinate()
mandatory
- This method must be implemented. Coordinate getEndingCoordinate()
mandatory
- This method must be implemented. boolean isImplicit()
Obstacle.
true
if this speed zone is implicit,
false
if explicitly managedmandatory
- This method must be implemented. Speed getSpeedLimit()
mandatory
- This method must be implemented. SpeedZoneRecord getSpeedZoneRecord(Type speedZoneRecordType) throws OperationFailedException
SpeedZone
record Type.
This method is used to retrieve an
object implementing the requested record. The
speedZoneRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(speedZoneRecordType)
is true
.speedZoneRecordType
- the type of speed zone record to retrieveNullArgumentException
- speedZoneRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(speedZoneRecordType)
is false
mandatory
- This method must be implemented.