RoadElement (HERE Android Premium SDK)

java.lang.Object
- com.here.android.mpa.common.RoadElement

public final class RoadElement
extends java.lang.Object

Represents a single segment of a road.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RoadElement.Attribute` Defined values for different road attributes
`static class`	`RoadElement.FormOfWay` Form of Way Types
`static class`	`RoadElement.PluralType` Plural type identifies when a Junction is made up of multiple Road Elements.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object other)`
`java.util.EnumSet<RoadElement.Attribute>`	`getAttributes()` Gets the road attributes.
`float`	`getDefaultSpeed()` Gets the default speed of the road element.
`RoadElement.FormOfWay`	`getFormOfWay()` Gets the form of way.
`java.util.List<GeoCoordinate>`	`getGeometry()` Returns the geometry of the road element.
`double`	`getGeometryLength()` Returns the length of the polyline associated with this `RoadElement` in meters.
`Identifier`	`getIdentifier()` Get the Identifier for this particular RoadElement.
`int`	`getNumberOfLanes()` Gets number of lanes in this road element.
`long`	`getPermanentDirectedLinkId()` The Permanent Link ID (stable across different map versions) of the `RoadElement` with travel direction: positive sign (+) means driving in the 'canonical' direction of the road and negative sign (-) means driving against the 'canonical' direction of the road.
`long`	`getPermanentLinkId()` Returns the Permanent Link ID (stable across different map versions) of the `RoadElement`.
`RoadElement.PluralType`	`getPluralType()` Gets the plural type of the road element.
`static RoadElement`	`getRoadElement(GeoCoordinate coordinate, java.lang.String marcCode)` Get the `RoadElement` of the current `GeoCoordinate`.
`static java.util.List<RoadElement>`	`getRoadElements(GeoBoundingBox boundingBox, java.lang.String marcCode)` Get the list of `RoadElement` of the current `GeoBoundingBox`.
`java.lang.String`	`getRoadName()` Gets the name of the road that contains this current road element, such as "Still Creek Drive".
`java.lang.String`	`getRouteName()` Gets the route name of the road element.
`float`	`getSpeedLimit()` Gets the speed limit.
`java.util.Date`	`getStartTime()` Gets the (estimated) time at which this road element starts.
`float`	`getStaticSpeed()` Gets the static speed of the road element using only free-flow speeds.
`java.util.List<TrafficSign>`	`getTrafficSigns()` Returns list of the `TrafficSign` for this road element.
`int`	`hashCode()`
`boolean`	`isPedestrian()` Checks, if the road is allowed only for pedestrians.
`boolean`	`isPlural()` Tests if the road element is plural.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getRoadElement
```
public static RoadElement getRoadElement(GeoCoordinate coordinate,
                                         java.lang.String marcCode)
```
    Get the RoadElement of the current GeoCoordinate. This method returns null if the GeoCoordinate is invalid or there is no RoadElement close enough to the GeoCoordinate.
    
    Parameters:
    
    coordinate - The GeoCoordinate that defines the coordinate to retrieve RoadElement
    
    marcCode - The text for RoadElement corresponds to the language MARC code.
    
    Returns:
    
    The RoadElement of the current GeoCoordinate.
    
    Throws:
    
    java.lang.IllegalArgumentException - If marcCode is an empty string.
    
    java.lang.NullPointerException - If coordinate is null or marcCode is null.
  - getRoadElements
```
public static java.util.List<RoadElement> getRoadElements(GeoBoundingBox boundingBox,
                                                          java.lang.String marcCode)
```
    Get the list of RoadElement of the current GeoBoundingBox.
    
    Parameters:
    
    boundingBox - The GeoBoundingBox that defines the area to retrieve RoadElement
    
    marcCode - The text for RoadElement corresponds to the language MARC code.
    
    Returns:
    
    The list of RoadElement of the current GeoBoundingBox.
  - getAttributes
```
public java.util.EnumSet<RoadElement.Attribute> getAttributes()
```
    Gets the road attributes.
    
    Returns:
    
    Set of RoadElement.Attribute
  - getFormOfWay
```
public RoadElement.FormOfWay getFormOfWay()
```
    Gets the form of way.
    
    Returns:
    
    The form of way of the road.
  - isPlural
```
public boolean isPlural()
```
    Tests if the road element is plural.
    
    Returns:
    
    True if the road element is plural.
  - getPluralType
```
public RoadElement.PluralType getPluralType()
```
    Gets the plural type of the road element.
    
    Returns:
    
    The plural type of the road element.
  - getRoadName
```
public java.lang.String getRoadName()
```
    Gets the name of the road that contains this current road element, such as "Still Creek Drive".
    
    Returns:
    
    The name of the road. Returns null or an empty string if the name is unknown, such as when the road element is on an unnamed service alley.
  - getRouteName
```
public java.lang.String getRouteName()
```
    Gets the route name of the road element. The route name is a short label for the road, for example I5 for the Interstate 5 in the US. The method returns a null string if the route name is unknown.
    
    Returns:
    
    The route name of the road element.
  - getSpeedLimit
```
public float getSpeedLimit()
```
    Gets the speed limit.
    
    Returns:
    
    The speed limit in m/s or 0 if the information is not available.
  - getDefaultSpeed
```
public float getDefaultSpeed()
```
    Gets the default speed of the road element. It uses the same speeds used during routing, includes dynamic events, for example, if traffic is enabled.
    
    Returns:
    
    The default speed in m/s or 0.0 if the information is not available.
  - getStaticSpeed
```
public float getStaticSpeed()
```
    Gets the static speed of the road element using only free-flow speeds. It does not include dynamic events, for example, excludes traffic even if enabled.
    
    Returns:
    
    The static speed in m/s or 0.0 if the information is not available.
  - getNumberOfLanes
```
public int getNumberOfLanes()
```
    Gets number of lanes in this road element.
    
    Returns:
    
    The number of lanes in this road element.
  - isPedestrian
```
public boolean isPedestrian()
```
    Checks, if the road is allowed only for pedestrians.
    
    Returns:
    
    True, if road is allowed only for pedestrians, otherwise false.
  - getStartTime
```
public java.util.Date getStartTime()
```
    Gets the (estimated) time at which this road element starts. If no departure time was set for the RouteOptions associated with this road element, than the time is relative to the system time when the route calculation took place. Otherwise, the times are relative to the specified departure time.
    
    Returns:
    
    The start time, or null if not available
    
    See Also:
    
    RouteOptions.setTime(Date, RouteOptions.TimeType)
  - getGeometryLength
```
public double getGeometryLength()
```
    Returns the length of the polyline associated with this RoadElement in meters.
    
    Returns:
    
    length of polyline for this RoadElement in meters.
  - getGeometry
```
public final java.util.List<GeoCoordinate> getGeometry()
```
    Returns the geometry of the road element. The geometry is a returned as a list of GeoCoordinate that can be used to create a polyline.
    
    Returns:
    
    a list of GeoCoordinate
  - getIdentifier
```
public Identifier getIdentifier()
```
    Get the Identifier for this particular RoadElement.
    
    Returns:
    
    Identifier
  - getPermanentLinkId
```
public long getPermanentLinkId()
```
    Returns the Permanent Link ID (stable across different map versions) of the RoadElement. This property is unavailable when the public transport mode RouteOptions.TransportMode.PUBLIC_TRANSPORT is used. For all the other transport modes, it is available only in routes calculated with the online connectivity mode.
    
    Returns:
    
    Permanent Link ID of this element or 0 if not available.
    
    See Also:
    
    RoadElement.getPermanentDirectedLinkId()
  - getPermanentDirectedLinkId
```
public long getPermanentDirectedLinkId()
```
    The Permanent Link ID (stable across different map versions) of the RoadElement with travel direction: positive sign (+) means driving in the 'canonical' direction of the road and negative sign (-) means driving against the 'canonical' direction of the road. Every road element has two endpoints. Starting from which end point the link is being traversed? Each link has a geometry associated with it. The geometry gives the link a 'canonical' direction: if you traverse the link in the direction the geometry is stored, you are traveling in the positive direction. Otherwise, you are traveling in the negative direction. The assigned 'canonical' direction is completely arbitrary and no assumption should be made about it. This property is unavailable when the public transport mode RouteOptions.TransportMode.PUBLIC_TRANSPORT is used. For all the other transport modes, it is available only in routes calculated with the online connectivity mode.
    
    Returns:
    
    Permanent Link ID with direction of this element or 0 if not available.
    
    See Also:
    
    RoadElement.getPermanentLinkId()
  - getTrafficSigns
```
public java.util.List<TrafficSign> getTrafficSigns()
                                            throws DataNotReadyException
```
    Returns list of the TrafficSign for this road element.
    
    Returns:
    
    The list of TrafficSign. The empty list is returned if no traffic sign exists at this RoadElement.
    
    Throws:
    
    DataNotReadyException - The map data for traffic signs is not loaded yet.
    
    java.lang.RuntimeException - Unexpected error.
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
    
    Override:
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
    
    Override:

Class RoadElement

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getRoadElement

getRoadElements

getAttributes

getFormOfWay

isPlural

getPluralType

getRoadName

getRouteName

getSpeedLimit

getDefaultSpeed

getStaticSpeed

getNumberOfLanes

isPedestrian

getStartTime

getGeometryLength

getGeometry

getIdentifier

getPermanentLinkId

getPermanentDirectedLinkId

getTrafficSigns

equals

hashCode