Interface SpeedZone

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidObject, OsidRule
public interface SpeedZone extends OsidRule

A SpeedZone represents a speed zone in a Map.

  • Method Details

    • getPathId

      Id getPathId()
      Gets the path Id of this speed zone.
      Returns:
      the Id of the path
      Compliance:
      mandatory - This method must be implemented.

    • getPath

      Path getPath() throws OperationFailedException
      Gets the path of this speed zone.
      Returns:
      the path
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getStartingCoordinate

      Coordinate getStartingCoordinate()
      Gets the starting coordinate of the speed zone on the path.
      Returns:
      the start of the zone
      Compliance:
      mandatory - This method must be implemented.

    • getEndingCoordinate

      Coordinate getEndingCoordinate()
      Gets the ending coordinate of the speed zone on the path.
      Returns:
      the end of the zone
      Compliance:
      mandatory - This method must be implemented.

    • isImplicit

      boolean isImplicit()
      Tests if this speed zone is implicit. An implicit speed zone is generated from other information such as an Obstacle.
      Returns:
      true if this speed zone is implicit, false if explicitly managed
      Compliance:
      mandatory - This method must be implemented.

    • getSpeedLimit

      Speed getSpeedLimit()
      Gets the speed limit in this zone.
      Returns:
      the speed limit
      Compliance:
      mandatory - This method must be implemented.

    • getSpeedZoneRecord

      SpeedZoneRecord getSpeedZoneRecord(Type speedZoneRecordType) throws OperationFailedException
      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.
      Parameters:
      speedZoneRecordType - the type of speed zone record to retrieve
      Returns:
      the speed zone record
      Throws:
      NullArgumentException - speedZoneRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(speedZoneRecordType) is false
      Compliance:
      mandatory - This method must be implemented.