OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.SpeedZone
Implementsosid.OsidRule
Description

A SpeedZone represents a speed zone in a Map.

MethodgetPathId
Description

Gets the path Id of this speed zone.

Returnosid.id.Idthe Id of the path
CompliancemandatoryThis method must be implemented.
MethodgetPath
Description

Gets the path of this speed zone.

Returnosid.mapping.path.Paththe path
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetStartingCoordinate
Description

Gets the starting coordinate of the speed zone on the path.

Returnosid.mapping.Coordinatethe start of the zone
CompliancemandatoryThis method must be implemented.
MethodgetEndingCoordinate
Description

Gets the ending coordinate of the speed zone on the path.

Returnosid.mapping.Coordinatethe end of the zone
CompliancemandatoryThis method must be implemented.
MethodisImplicit
Description

Tests if this speed zone is implicit. An implicit speed zone is generated from other information such as an Obstacle.

Returnboolean true if this speed zone is implicit, false if explicitly managed
CompliancemandatoryThis method must be implemented.
MethodgetSpeedLimit
Description

Gets the speed limit in this zone.

Returnosid.mapping.Speedthe speed limit
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneRecord
Description

Gets the speed zone record corresponding to the given 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 .

Parametersosid.type.TypespeedZoneRecordTypethe type of speed zone record to retrieve
Returnosid.mapping.path.records.SpeedZoneRecordthe speed zone record
ErrorsNULL_ARGUMENT speedZoneRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(speedZoneRecordType) is false
CompliancemandatoryThis method must be implemented.