TrafficFlowBase (API Reference)
Interface TrafficFlowBase
- All Known Implementing Classes:
TrafficFlow
This interface provides details about a traffic flow.
For additional information about fields, refer to Traffic API v7 API Reference: Traffic API v7.
Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
-
Method Summary
Modifier and TypeMethodDescriptiondoubleGets the reference speed in meters per second along the roadway when no traffic is present.doubleGets a value for the amount of traffic on the roadway.
-
Method Details
-
getFreeFlowSpeedInMetersPerSecond
double getFreeFlowSpeedInMetersPerSecond()Gets the reference speed in meters per second along the roadway when no traffic is present.
- Returns:
The reference speed in meters per second along the roadway when no traffic is present.
-
getJamFactor
double getJamFactor()Gets a value for the amount of traffic on the roadway.
The value, between 0.0 and 10.0, indicate the expected quality of travel. A value of 0.0 indicates that there is no congestion on the roadway. As the value approaches 10.0, it indicates increasing congestion. A value of 10.0 is reserved to represent a blocked roadway (closure).
- Returns:
A value for the amount of traffic on the roadway.
-