public class

RoadWorks

extends Object
java.lang.Object
   ↳ com.commsignia.v2x.client.model.RoadWorks

Class Overview

Represents the information container included in the alacarte container for the road work use case. It includes information of the road work zone and specific access conditions.

Summary

Public Constructors
RoadWorks()
Create a new instance
Public Methods
CauseCode getCauseCode()
Returns the cause code
DrivingLaneStatus getDrivingLaneStatus()
Returns the driving lane status.
HardShoulderStatus getHardShoulderStatus()
Returns the hard shoulder status.
List<ReferencePos> getRecommendedPath()
Returns the list of points of the recommended path.
List<DENMActionID> getReferenceDENMs()
Returns a list of action IDs for the reference DENMs.
Set<StationType> getRestriction()
Returns the types of vehicles that are restricted to access the road work zone.
Double getSpeedLimit(SpeedUnit unit)
Returns the speed limit in the specified unit.
DeltaReferencePosition getStartingPointSpeedLimit()
Returns the speed limit starting point.
TrafficRule getTrafficFlowRule()
Returns the traffic flow rule.
boolean hasLightBarAndSirenStatus()
Returns true if the light bar or siren status was set.
boolean hasSpeedLimit()
Returns true if the speed limit value is set.
boolean isLightBarActivated()
Returns the activation status of the light bar.
boolean isSirenActivated()
Returns the activation status of the siren.
void setCauseCode(CauseCode causeCode)
Sets incident identification.
void setClosedLanes(DrivingLaneStatus drivingLaneStatus, HardShoulderStatus hardShoulderStatus)
Sets the data field that indicates the opening/closure status of a lane or a set of lanes.
void setLightBarActivated(Boolean lightBarActivated)
Sets the activation status of the light bar.
void setRecommendedPath(List<ReferencePos> recommendedPath)
Sets the list of points of the recommended path.
void setReferenceDENMs(List<DENMActionID> referenceDENMs)
Sets the list of action IDs for the reference DENMs.
void setRestriction(Set<StationType> restriction)
Sets the types of vehicles that are restricted to access the road work zone.
void setRestriction(StationType... restriction)
Sets the types of vehicles that are restricted to access the road work zone.
void setSirenActivated(Boolean sirenActivated)
Sets the activation status of the siren.
void setSpeedLimit(double speedLimit, SpeedUnit speedLimitUnit)
Set the speed limitation applied to a geographical position, a road section or a geographical region.
void setStartingPointSpeedLimit(DeltaReferencePosition startingPointSpeedLimit)
Sets the speed limit starting point.
void setTrafficFlowRule(TrafficRule trafficFlowRule)
Sets the traffic flow rule.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public RoadWorks ()

Create a new instance

Public Methods

public CauseCode getCauseCode ()

Returns the cause code

Returns
  • cause code

public DrivingLaneStatus getDrivingLaneStatus ()

Returns the driving lane status.

Returns
  • driving lane status

public HardShoulderStatus getHardShoulderStatus ()

Returns the hard shoulder status.

Returns
  • hard shoulder status

public List<ReferencePos> getRecommendedPath ()

Returns the list of points of the recommended path.

Returns
  • list of points of the recommended path

public List<DENMActionID> getReferenceDENMs ()

Returns a list of action IDs for the reference DENMs.

Returns
  • list of action IDs for the reference DENMs

public Set<StationType> getRestriction ()

Returns the types of vehicles that are restricted to access the road work zone.

Returns
  • Returns the list of restriction

public Double getSpeedLimit (SpeedUnit unit)

Returns the speed limit in the specified unit.

Parameters
unit target unit
Returns
  • speed limit in the specified unit

public DeltaReferencePosition getStartingPointSpeedLimit ()

Returns the speed limit starting point.

Returns
  • speed limit starting point

public TrafficRule getTrafficFlowRule ()

Returns the traffic flow rule.

Returns
  • traffic flow rule

public boolean hasLightBarAndSirenStatus ()

Returns true if the light bar or siren status was set.

Returns
  • true if the light bar or siren status was set, false otherwise

public boolean hasSpeedLimit ()

Returns true if the speed limit value is set.

Returns
  • true if the speed limit value is set, false otherwise

public boolean isLightBarActivated ()

Returns the activation status of the light bar.

Returns
  • lightBarActivated activation status of the light bar.

public boolean isSirenActivated ()

Returns the activation status of the siren.

Returns
  • sirenActivated activation status of the siren

public void setCauseCode (CauseCode causeCode)

Sets incident identification.

Parameters
causeCode cause code

public void setClosedLanes (DrivingLaneStatus drivingLaneStatus, HardShoulderStatus hardShoulderStatus)

Sets the data field that indicates the opening/closure status of a lane or a set of lanes.

Parameters
drivingLaneStatus driving lane status
hardShoulderStatus hard shoulder status

public void setLightBarActivated (Boolean lightBarActivated)

Sets the activation status of the light bar.

Parameters
lightBarActivated activation status of the light bar

public void setRecommendedPath (List<ReferencePos> recommendedPath)

Sets the list of points of the recommended path. Indicates the recommended itinerary in order to contour the roadworks zone.

A recommended path is presented with a list of path points in the order from the starting point closest to the roadworks zone to the end point of the recommended path.

Parameters
recommendedPath List of reference positions.

public void setReferenceDENMs (List<DENMActionID> referenceDENMs)

Sets the list of action IDs for the reference DENMs.

Parameters
referenceDENMs list of action IDs for the reference DENMs

public void setRestriction (Set<StationType> restriction)

Sets the types of vehicles that are restricted to access the road work zone.

Parameters
restriction list of restriction

public void setRestriction (StationType... restriction)

Sets the types of vehicles that are restricted to access the road work zone.

Parameters
restriction list of restriction

public void setSirenActivated (Boolean sirenActivated)

Sets the activation status of the siren.

Parameters
sirenActivated activation status of the siren

public void setSpeedLimit (double speedLimit, SpeedUnit speedLimitUnit)

Set the speed limitation applied to a geographical position, a road section or a geographical region.

Parameters
speedLimit speed limit
speedLimitUnit speed unit

public void setStartingPointSpeedLimit (DeltaReferencePosition startingPointSpeedLimit)

Sets the speed limit starting point.

Parameters
startingPointSpeedLimit speed limit starting point

public void setTrafficFlowRule (TrafficRule trafficFlowRule)

Sets the traffic flow rule.

Parameters
trafficFlowRule traffic flow rule