public class

DENM

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

Class Overview

Represents a DENM message.

Summary

Public Constructors
DENM()
Public Methods
void clearExternalTemperature()
Clears the external temperature value.
void clearHeadingValue()
Clears the heading value
void clearSpeedValue()
Clears the speed value
void clearTransmissionInterval()
Clears the transmission interval value
void clearValidityDuration()
Clears the validity duration value.
DENMActionID getActionID()
Returns the current action ID of the DENM message
Date getDetectionTime()
Returns the detection time of the event that triggered the DENM message.
List<EventPoint> getEventHistory()
Returns the associated event history.
ReferencePos getEventPosition()
Returns the event position of this DENM.
CauseCode getEventType()
Returns the event type of this DENM message
Double getExternalTemperature(TemperatureUnit unit)
Returns the external temperature of this DENM message.
Double getHeadingConfidence(DegreeUnit confidenceUnit)
Returns the heading confidence value of this DENM message in the specified unit.
Double getHeadingValue(DegreeUnit unit)
Returns the heading of this DENM message in the specified unit.
ImpactReduction getImpactReduction()
Returns the impact reduction values set on the this DENM message.
Long getInformationQuality()
Returns the information quality of this DENM message This value shall be set by the originator ITS station with values from 0 to 7 in increasing order towards better quality where 0 is used for unavailable information.
Long getLaneNumber()
Returns the lane number of this DENM message.
CauseCode getLinkedCause()
Returns the linked cause of this DENM message If more than one event is detected by the originator ITS station, the linked cause field shall be set to indicate another event which may be linked to the primary event in the event type parameter.
PositioningSolutionType getPositioningSolution()
Returns the positioning solution of this DENM message This field indicates the type of the positioning solution being used for the resolution of the event position.
Date getReferenceTime()
Returns the reference time for this DENM message
RelevanceDistance getRelevanceDistance()
Returns the relevance distance of the this DENM message.
RelevanceTrafficDirection getRelevanceTrafficDirection()
Returns the relevance traffic direction of this DENM message.
RoadType getRoadType()
Returns the road type value of this DENM message.
RoadWorks getRoadWorks()
Returns the road works container of this DENM message
Double getSpeedConfidence(SpeedUnit confidenceUnit)
Returns the speed confidence value of the current DENM message in the specified unit.
Double getSpeedValue(SpeedUnit unit)
Returns the speed value of this DENM message in the specified unit.
StationType getStationType()
Returns the station type of this DENM message.
StationaryVehicle getStationaryVehicle()
Returns the stationary vehicle container of this DENM message
List<List<TracePathPoint>> getTraces()
Returns the list of traces of this DENM message.
Long getTransmissionInterval(TimeUnit unit)
Returns the transmission interval of this DENM message
Long getValidityDuration(TimeUnit unit)
Gets the validity duration in the specified unit
boolean hasExternalTemperature()
Returns true if the external temperature is set, false otherwise.
boolean hasHeadingConfidence()
Returns true if the heading confidence is set, false otherwise
boolean hasHeadingValue()
Return true if the heading value is set, false otherwise
boolean hasSpeedConfidence()
Returns true if speed confidence is set
boolean hasSpeedValue()
Return true if the speed value is set, false otherwise
boolean hasTransmissionInterval()
Returns true if the transmission interval value is present
boolean hasValidityDuration()
Returns true if this DENM has a validity duration set
boolean isCancellation()
Returns the cancellation status of this DENM message.
boolean isNegation()
Returns the negation status of this DENM message.
void setActionID(long stationId, long sequenceNumber)
Sets the action ID for the DENM message.
void setActionID(DENMActionID actionID)
Sets the action ID for the DENM message.
void setCancellation(Boolean isCancellation)
Sets the cancellation status of this DENM message.
void setDetectionTime(Date detectionTime)
Sets the detection time of this specific event.
void setEventHistory(List<EventPoint> eventHistory)
Sets the associated event history.
void setEventPosition(ReferencePos eventPosition)
Sets the event position parameters of a DENM message.
void setEventType(CauseCode eventType)
Sets the event type value of this DENM message.
void setExternalTemperature(double externalTemperature, TemperatureUnit externalTemperatureUnit)
Sets the external temperature of this DENM message.
void setHeadingValue(double headingValue, DegreeUnit headingValueUnit)
Sets the heading value of this DENM message.
void setHeadingValue(double headingValue, DegreeUnit headingValueUnit, double confidenceWithin, DegreeUnit confidenceUnit)
Sets the heading value of this DENM message.
void setImpactReduction(ImpactReduction impactReduction)
Sets the impact reduction values of this DENM message.
void setInformationQuality(Long informationQuality)
Sets the information quality value of a DENM message.
void setLaneNumber(Long laneNumber)
Sets the lane number of this DENM message.
void setLinkedCause(CauseCode linkedCause)
Set the linked cause of this DENM message.
void setNegation(Boolean isNegation)
Sets the negation status value of this DENM message.
void setPositioningSolution(PositioningSolutionType positioningSolution)
Sets the positioning solution of this DENM message.
void setReferenceTime(Date referenceTime)
Sets the reference time for this DENM message.
void setRelevanceDistance(RelevanceDistance relevanceDistance)
Sets the relevance distance of the event.
void setRelevanceTrafficDirection(RelevanceTrafficDirection relevanceTrafficDirection)
Sets the relevance traffic direction of this DENM message.
void setRoadType(RoadType roadType)
Sets the road type value of a DENM message.
void setRoadWorks(RoadWorks roadWorks)
Sets the road works cpmtaomer of this DENM message.
void setSpeedValue(double speedValue, SpeedUnit speedUnit)
Sets the speed value of this DENM message.
void setSpeedValue(double speedValue, SpeedUnit speedUnit, double confidenceWithin, SpeedUnit confidenceUnit)
Sets the speedValue of a DENM message.
void setStationType(StationType stationType)
Sets the station type of this DENM message.
void setStationaryVehicle(StationaryVehicle stationaryVehicle)
Sets the stationary vehicle container of this DENM message.
void setTraces(List<List<TracePathPoint>> traces)
Sets the list of traces of this DENM message.
void setTransmissionInterval(long transmissionInterval, TimeUnit transmissionIntervalUnit)
Sets the transmissionInterval value of this DENM message.
void setValidityDuration(long validityDuration, TimeUnit validityDurationUnit)
Sets the validity duration value for a DENM message.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public DENM ()

Public Methods

public void clearExternalTemperature ()

Clears the external temperature value.

public void clearHeadingValue ()

Clears the heading value

public void clearSpeedValue ()

Clears the speed value

public void clearTransmissionInterval ()

Clears the transmission interval value

public void clearValidityDuration ()

Clears the validity duration value.

public DENMActionID getActionID ()

Returns the current action ID of the DENM message

Returns
  • action Id

public Date getDetectionTime ()

Returns the detection time of the event that triggered the DENM message.

Returns
  • detection time of the event

public List<EventPoint> getEventHistory ()

Returns the associated event history.

Returns
  • list of event point events

public ReferencePos getEventPosition ()

Returns the event position of this DENM.

Returns
  • event position of the DENM

public CauseCode getEventType ()

Returns the event type of this DENM message

Returns
  • event type

public Double getExternalTemperature (TemperatureUnit unit)

Returns the external temperature of this DENM message. This field shall be set if adverse weather conditions exist at the event position.

Parameters
unit target temperature unit
Returns
  • external temperature in the specified unit

public Double getHeadingConfidence (DegreeUnit confidenceUnit)

Returns the heading confidence value of this DENM message in the specified unit.

Returns
  • heading confidence value of the DENM

public Double getHeadingValue (DegreeUnit unit)

Returns the heading of this DENM message in the specified unit. This field contains the heading direction of the event.

Returns
  • heading value of the DENM

public ImpactReduction getImpactReduction ()

Returns the impact reduction values set on the this DENM message.

Returns
  • impact reduction values

public Long getInformationQuality ()

Returns the information quality of this DENM message This value shall be set by the originator ITS station with values from 0 to 7 in increasing order towards better quality where 0 is used for unavailable information.

Returns
  • information quality of the DENM

public Long getLaneNumber ()

Returns the lane number of this DENM message. The lane number is counted from the outside border of the road.

Returns
  • lane number

public CauseCode getLinkedCause ()

Returns the linked cause of this DENM message If more than one event is detected by the originator ITS station, the linked cause field shall be set to indicate another event which may be linked to the primary event in the event type parameter.

Returns
  • linked cause

public PositioningSolutionType getPositioningSolution ()

Returns the positioning solution of this DENM message This field indicates the type of the positioning solution being used for the resolution of the event position.

Returns
  • positioning solution value of the DENM

public Date getReferenceTime ()

Returns the reference time for this DENM message

Returns
  • reference time value of the DENM

public RelevanceDistance getRelevanceDistance ()

Returns the relevance distance of the this DENM message. This field holds the distance value within which the event is considered relevant to the receiver ITS station.

Returns
  • relevance distance of this DENM

public RelevanceTrafficDirection getRelevanceTrafficDirection ()

Returns the relevance traffic direction of this DENM message. This field holds the direction along which the receiver ITS station may encounter the event described by the DENM message.

Returns
  • relevance traffic direction of this DENM

public RoadType getRoadType ()

Returns the road type value of this DENM message. This field holds the road type information at the event position.

Returns
  • road type

public RoadWorks getRoadWorks ()

Returns the road works container of this DENM message

Returns
  • road works container

public Double getSpeedConfidence (SpeedUnit confidenceUnit)

Returns the speed confidence value of the current DENM message in the specified unit.

Parameters
confidenceUnit target measurement unit
Returns
  • speed confidence value of the DENM within the specified units

public Double getSpeedValue (SpeedUnit unit)

Returns the speed value of this DENM message in the specified unit. This field holds the moving speed value of the detected event. It shall be given if the ITS station is the originator of the DENM message related to this event.

Returns
  • speed value

public StationType getStationType ()

Returns the station type of this DENM message.

Returns
  • station type

public StationaryVehicle getStationaryVehicle ()

Returns the stationary vehicle container of this DENM message

Returns
  • stationary vehicle value

public List<List<TracePathPoint>> getTraces ()

Returns the list of traces of this DENM message. Each trace stored in the list describes a set of consecutive positions leading to the event position.

Returns
  • list of traces of the DENM

public Long getTransmissionInterval (TimeUnit unit)

Returns the transmission interval of this DENM message

Returns
  • transmission interval value of the DENM

public Long getValidityDuration (TimeUnit unit)

Gets the validity duration in the specified unit

Parameters
unit target unit
Returns
  • validity duration in the specified unit, null if not specified regardless of the unit

public boolean hasExternalTemperature ()

Returns true if the external temperature is set, false otherwise.

Returns
  • true if the external temperature is set, false otherwise

public boolean hasHeadingConfidence ()

Returns true if the heading confidence is set, false otherwise

Returns
  • true if the heading confidence is set, false otherwise

public boolean hasHeadingValue ()

Return true if the heading value is set, false otherwise

Returns
  • true if the heading is set, false otherwise

public boolean hasSpeedConfidence ()

Returns true if speed confidence is set

Returns
  • true if speed confidence is set

public boolean hasSpeedValue ()

Return true if the speed value is set, false otherwise

Returns
  • true if set, false otherwise

public boolean hasTransmissionInterval ()

Returns true if the transmission interval value is present

Returns
  • true if present

public boolean hasValidityDuration ()

Returns true if this DENM has a validity duration set

Returns
  • true if validity duration is set

public boolean isCancellation ()

Returns the cancellation status of this DENM message.

Returns
  • cancellation status of this DENM, true if an event termination has been detected by the originator ITS station

public boolean isNegation ()

Returns the negation status of this DENM message.

Returns
  • negation value of the DENM, if true the previously described event no longer exists.

public void setActionID (long stationId, long sequenceNumber)

Sets the action ID for the DENM message. The action ID consists of a station ID and a sequence number.

Parameters
stationId station id
sequenceNumber sequence number

public void setActionID (DENMActionID actionID)

Sets the action ID for the DENM message. The actionID consists of a station ID and a sequence number.

Parameters
actionID action Id

public void setCancellation (Boolean isCancellation)

Sets the cancellation status of this DENM message. This value shall be set to true when an event termination has been detected by the originator ITS station.

Parameters
isCancellation cancellation status of this DENM

public void setDetectionTime (Date detectionTime)

Sets the detection time of this specific event. The detection time is a time at which the event is detected by the originator ITS-S.

Parameters
detectionTime detection time of the event

public void setEventHistory (List<EventPoint> eventHistory)

Sets the associated event history.

Parameters
eventHistory list of event point events

public void setEventPosition (ReferencePos eventPosition)

Sets the event position parameters of a DENM message.

Parameters
eventPosition event position of the DENM

public void setEventType (CauseCode eventType)

Sets the event type value of this DENM message.

Parameters
eventType event type value of the DENM

public void setExternalTemperature (double externalTemperature, TemperatureUnit externalTemperatureUnit)

Sets the external temperature of this DENM message. This field shall be set if adverse weather conditions exist at the event position.

Parameters
externalTemperature external temperature value of the DENM
externalTemperatureUnit external temperature unit

public void setHeadingValue (double headingValue, DegreeUnit headingValueUnit)

Sets the heading value of this DENM message. This field contains the heading direction of the event.

Parameters
headingValue heading value of the DENM
headingValueUnit unit of the heading value

public void setHeadingValue (double headingValue, DegreeUnit headingValueUnit, double confidenceWithin, DegreeUnit confidenceUnit)

Sets the heading value of this DENM message. This field contains the heading direction of the event.

Parameters
headingValue heading value of the DENM
headingValueUnit unit of the heading value
confidenceWithin heading confidence equal or within this value
confidenceUnit unit of the heading confidence

public void setImpactReduction (ImpactReduction impactReduction)

Sets the impact reduction values of this DENM message.

Parameters
impactReduction impact reduction values

public void setInformationQuality (Long informationQuality)

Sets the information quality value of a DENM message. This value shall be set by the originator ITS station with values from 0 to 7 in increasing order towards better quality where 0 is used for unavailable information.

Parameters
informationQuality information quality value of the DENM

public void setLaneNumber (Long laneNumber)

Sets the lane number of this DENM message. The lane number is counted from the outside border of the road.

Parameters
laneNumber lane number

public void setLinkedCause (CauseCode linkedCause)

Set the linked cause of this DENM message. If more than one event is detected by the originator ITS station, the linked cause field shall be set to indicate another event which may be linked to the primary event in the event type parameter.

Parameters
linkedCause linked cause value of the DENM

public void setNegation (Boolean isNegation)

Sets the negation status value of this DENM message. This value needs to be set when an event described by a previously received DENM does not exist any more.

Parameters
isNegation negation status of this DENM

public void setPositioningSolution (PositioningSolutionType positioningSolution)

Sets the positioning solution of this DENM message. This field indicates the type of the positioning solution being used for the resolution of the event position.

Parameters
positioningSolution positioning solution value of the DENM

public void setReferenceTime (Date referenceTime)

Sets the reference time for this DENM message. The reference time is the time when the DENM message is generated and it shall remain unchanged during DENM repetition.

Parameters
referenceTime reference time value of the DENM

public void setRelevanceDistance (RelevanceDistance relevanceDistance)

Sets the relevance distance of the event. This field holds the distance value within which the event is considered relevant to the receiver ITS station.

Parameters
relevanceDistance relevance distance of the DENM

public void setRelevanceTrafficDirection (RelevanceTrafficDirection relevanceTrafficDirection)

Sets the relevance traffic direction of this DENM message. This field holds the direction along which the receiver ITS station may encounter the event described by the DENM message.

Parameters
relevanceTrafficDirection relevance traffic direction value of the DENM

public void setRoadType (RoadType roadType)

Sets the road type value of a DENM message. This field holds the road type information at the event position.

Parameters
roadType road type

public void setRoadWorks (RoadWorks roadWorks)

Sets the road works cpmtaomer of this DENM message.

Parameters
roadWorks road works container

public void setSpeedValue (double speedValue, SpeedUnit speedUnit)

Sets the speed value of this DENM message. This field holds the moving speed value of the detected event. It shall be given if the ITS station is the originator of the DENM message related to this event.

Parameters
speedValue speed value

public void setSpeedValue (double speedValue, SpeedUnit speedUnit, double confidenceWithin, SpeedUnit confidenceUnit)

Sets the speedValue of a DENM message. This parameter holds the moving speed value of the detected event. It shall be given if the ITS station is the originator of the DENM message related to this event.

Parameters
speedValue speed value
speedUnit speed unit
confidenceWithin speed confidence equal or within this value
confidenceUnit unit of speed confidence

public void setStationType (StationType stationType)

Sets the station type of this DENM message.

Parameters
stationType station type

public void setStationaryVehicle (StationaryVehicle stationaryVehicle)

Sets the stationary vehicle container of this DENM message.

Parameters
stationaryVehicle stationary vehicle container

public void setTraces (List<List<TracePathPoint>> traces)

Sets the list of traces of this DENM message. Each trace stored in the list describes a set of consecutive positions leading to the event position.

Parameters
traces list of traces of the DENM

public void setTransmissionInterval (long transmissionInterval, TimeUnit transmissionIntervalUnit)

Sets the transmissionInterval value of this DENM message.

Parameters
transmissionInterval transmission interval value of the DENM
transmissionIntervalUnit unit of the transmission interval

public void setValidityDuration (long validityDuration, TimeUnit validityDurationUnit)

Sets the validity duration value for a DENM message. At the end of this validity duration the event is regarded as terminated.

Parameters
validityDuration validity duration value of the DENM
validityDurationUnit unit of the validity duration

public String toString ()