public class

StationSpecialInfo

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

Class Overview

Holds information about a special vehicle. Analogous to the special vehicle container of CAM event

Summary

Public Constructors
StationSpecialInfo()
Creates a new instance.
Public Methods
ClosedLanes getClosedLanes()
Returns the status of closed lanes
DangerousGoodsBasicCategory getDangerousGoods()
Returns the type of the dangerous good.
DangerousGoodsBasicCategory getDangerousGoodsBasic()
Returns the basic category of dangerous goods carried by the vehicle.
DrivingLaneStatus getDrivingLaneStatus()
Returns the driving lane status.
HardShoulderStatus getHardShoulderStatus()
Returns the hard shoulder status.
CauseCode getIndicationCauseCode()
Returns the indication cause code.
byte[] getPtActivationData()
Returns the pt activation data.
PtActivationType getPtActivationType()
Returns the encoding format of the PT activation data.
RoadworksSubCauseCode getRoadworksSubCauseCode()
Returns the road works sub cause code.
SpecialTransportType getSpecialTransportType()
Returns the special transport type.
Double getSpeedLimit(SpeedUnit unit)
Returns the speed limit in the specified unit.
TrafficRule getTrafficRule()
Returns the traffic rule.
boolean hasSpeedLimit()
Returns true if the speed limit value has been set.
Boolean isEmbarkationStatus()
Returns the embarkation status.
Boolean isEmbarkationStatusEnabled()
Returns the indication whether a vehicle (e.g.
Boolean isEmergencyPriorityRequestForFreeCrossingAtATrafficLight()
Returns whether emergency priority was requested for free crossing at a traffic light.
Boolean isEmergencyPriorityRequestForRightOfWay()
Returns whether emergency priority was requested for right of way.
Boolean isExcessHeight()
Returns whether the vehicle's height is way bigger than the average.
Boolean isExcessLength()
Returns the information whether the vehicle's length is way bigger than the average.
Boolean isExcessWidth()
Returns whether the vehicle's width is way bigger than the average.
Boolean isHeavyLoad()
Returns the information whether the vehicle carries a heavy load.
Boolean isLightBarActivated()
Returns the status of light bar.
Boolean isSirenActivated()
Returns the status of siren.
void setClosedLanes(ClosedLanes closedLanes)
Sets the status of closed lanes.
void setDangerousGoodsBasic(DangerousGoodsBasicCategory dangerousGoodsBasic)
Sets the basic category of dangerous goods carried by the vehicle.
void setEmbarkationStatus(Boolean embarkationStatus)
Sets the embarkation status.
void setEmergencyPriorityRequestForFreeCrossingAtATrafficLight(Boolean emergencyPriorityRequestForFreeCrossingAtATrafficLight)
Set the emergency priority request for free crossing at traffic light.
void setEmergencyPriorityRequestForRightOfWay(Boolean emergencyPriorityRequestForRightOfWay)
Sets the emergency priority for right of way flag.
void setIndicationCauseCode(CauseCode indicationCauseCode)
Set the indication cause code.
void setLightBarActivated(Boolean lightBarActivated)
Sets the activation status of the light bar.
void setPtActivationData(byte[] ptActivationData)
Sets the pt activation data.
void setPtActivationType(PtActivationType ptActivationType)
Sets the encoding format of the PT activation data
void setRoadworksSubCauseCode(RoadworksSubCauseCode roadworksSubCause)
Sets the road works sub cause code.
void setSirenActivated(Boolean sirenActivated)
Sets the activation status of the siren.
void setSpecialTransportType(SpecialTransportType specialTransportType)
Sets the special transport type.
void setSpeedLimit(double speedLimit, SpeedUnit speedLimitUnit)
Sets the speed limit.
void setTrafficRule(TrafficRule trafficRule)
Sets the traffic rule.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public StationSpecialInfo ()

Creates a new instance.

Public Methods

public ClosedLanes getClosedLanes ()

Returns the status of closed lanes

Returns
  • status of closed lanes

public DangerousGoodsBasicCategory getDangerousGoods ()

Returns the type of the dangerous good.

Returns
  • type of the dangerous good

public DangerousGoodsBasicCategory getDangerousGoodsBasic ()

Returns the basic category of dangerous goods carried by the vehicle.

Returns
  • basic category of dangerous goods carried by the vehicle

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 CauseCode getIndicationCauseCode ()

Returns the indication cause code.

Returns
  • indication cause code

public byte[] getPtActivationData ()

Returns the pt activation data.

Returns
  • the pt activation data

public PtActivationType getPtActivationType ()

Returns the encoding format of the PT activation data.

Returns
  • type of the PT activation data

public RoadworksSubCauseCode getRoadworksSubCauseCode ()

Returns the road works sub cause code.

Returns
  • road works sub cause code.

public SpecialTransportType getSpecialTransportType ()

Returns the special transport type.

Returns
  • special transport type

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 TrafficRule getTrafficRule ()

Returns the traffic rule.

Returns
  • traffic rule

public boolean hasSpeedLimit ()

Returns true if the speed limit value has been set.

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

public Boolean isEmbarkationStatus ()

Returns the embarkation status.

Returns
  • embarkation status

public Boolean isEmbarkationStatusEnabled ()

Returns the indication whether a vehicle (e.g. public transport vehicle, truck) is under the embarkation process.

Returns
  • whether a vehicle (e.g. public transport vehicle, truck) is under the embarkation process

public Boolean isEmergencyPriorityRequestForFreeCrossingAtATrafficLight ()

Returns whether emergency priority was requested for free crossing at a traffic light.

Returns
  • whether emergency priority was requested for free crossing at a traffic light.

public Boolean isEmergencyPriorityRequestForRightOfWay ()

Returns whether emergency priority was requested for right of way.

Returns
  • whether emergency priority was requested for right of way.

public Boolean isExcessHeight ()

Returns whether the vehicle's height is way bigger than the average.

Returns
  • whether the vehicle's height is way bigger than the average.

public Boolean isExcessLength ()

Returns the information whether the vehicle's length is way bigger than the average.

Returns
  • whether the vehicle's length is way bigger than the average.

public Boolean isExcessWidth ()

Returns whether the vehicle's width is way bigger than the average.

Returns
  • whether the vehicle's width is way bigger than the average.

public Boolean isHeavyLoad ()

Returns the information whether the vehicle carries a heavy load.

Returns
  • whether the vehicle carries a heavy load.

public Boolean isLightBarActivated ()

Returns the status of light bar.

Returns
  • status of light bar

public Boolean isSirenActivated ()

Returns the status of siren.

Returns
  • the status of siren

public void setClosedLanes (ClosedLanes closedLanes)

Sets the status of closed lanes.

Parameters
closedLanes status of closed lanes

public void setDangerousGoodsBasic (DangerousGoodsBasicCategory dangerousGoodsBasic)

Sets the basic category of dangerous goods carried by the vehicle.

Parameters
dangerousGoodsBasic basic category of dangerous goods carried by the vehicle.

public void setEmbarkationStatus (Boolean embarkationStatus)

Sets the embarkation status.

Parameters
embarkationStatus embarkation status

public void setEmergencyPriorityRequestForFreeCrossingAtATrafficLight (Boolean emergencyPriorityRequestForFreeCrossingAtATrafficLight)

Set the emergency priority request for free crossing at traffic light.

Parameters
emergencyPriorityRequestForFreeCrossingAtATrafficLight emergency priority request for free crossing at traffic light flag

public void setEmergencyPriorityRequestForRightOfWay (Boolean emergencyPriorityRequestForRightOfWay)

Sets the emergency priority for right of way flag.

Parameters
emergencyPriorityRequestForRightOfWay emergency priority for right of way flag.

public void setIndicationCauseCode (CauseCode indicationCauseCode)

Set the indication cause code.

Parameters
indicationCauseCode indication cause code

public void setLightBarActivated (Boolean lightBarActivated)

Sets the activation status of the light bar.

Parameters
lightBarActivated activation status of the light bar

public void setPtActivationData (byte[] ptActivationData)

Sets the pt activation data.

Parameters
ptActivationData pt activation data

public void setPtActivationType (PtActivationType ptActivationType)

Sets the encoding format of the PT activation data

Parameters
ptActivationType type of the PT activation data

public void setRoadworksSubCauseCode (RoadworksSubCauseCode roadworksSubCause)

Sets the road works sub cause code.

Parameters
roadworksSubCause road works sub cause code

public void setSirenActivated (Boolean sirenActivated)

Sets the activation status of the siren.

Parameters
sirenActivated activation status of the siren.

public void setSpecialTransportType (SpecialTransportType specialTransportType)

Sets the special transport type.

Parameters
specialTransportType special transport type

public void setSpeedLimit (double speedLimit, SpeedUnit speedLimitUnit)

Sets the speed limit.

Parameters
speedLimit speed limit value
speedLimitUnit speed limit unit

public void setTrafficRule (TrafficRule trafficRule)

Sets the traffic rule.

Parameters
trafficRule traffic rule

public String toString ()