java.lang.Object | |
↳ | com.commsignia.v2x.client.model.DENM |
Represents a DENM message.
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Clears the external temperature value.
Clears the heading value
Clears the speed value
Clears the transmission interval value
Clears the validity duration value.
Returns the current action ID of the DENM message
Returns the detection time of the event that triggered the DENM message.
Returns the associated event history.
Returns the event position of this DENM.
Returns the external temperature of this DENM message. This field shall be set if adverse weather conditions exist at the event position.
unit | target temperature unit |
---|
Returns the heading confidence value of this DENM message in the specified unit.
Returns the heading of this DENM message in the specified unit. This field contains the heading direction of the event.
Returns the impact reduction values set on the this DENM message.
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 the lane number of this DENM message. The lane number is counted from the outside border of the road.
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 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 the reference time for this DENM message
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 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 the road type value of this DENM message. This field holds the road type information at the event position.
Returns the road works container of this DENM message
Returns the speed confidence value of the current DENM message in the specified unit.
confidenceUnit | target measurement 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 the station type of this DENM message.
Returns the stationary vehicle container of this DENM message
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 the transmission interval of this DENM message
Gets the validity duration in the specified unit
unit | target unit |
---|
Returns true if the external temperature is set, false otherwise.
Returns true if the heading confidence is set, false otherwise
Return true if the heading value is set, false otherwise
Returns true if speed confidence is set
Return true if the speed value is set, false otherwise
Returns true if the transmission interval value is present
Returns true if this DENM has a validity duration set
Returns the cancellation status of this DENM message.
Returns the negation status of this DENM message.
Sets the action ID for the DENM message. The action ID consists of a station ID and a sequence number.
stationId | station id |
---|---|
sequenceNumber | sequence number |
Sets the action ID for the DENM message. The actionID consists of a station ID and a sequence number.
actionID | action Id |
---|
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.
isCancellation | cancellation status of this DENM |
---|
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.
detectionTime | detection time of the event |
---|
Sets the associated event history.
eventHistory | list of event point events |
---|
Sets the event position parameters of a DENM message.
eventPosition | event position of the DENM |
---|
Sets the event type value of this DENM message.
eventType | event type value of the DENM |
---|
Sets the external temperature of this DENM message. This field shall be set if adverse weather conditions exist at the event position.
externalTemperature | external temperature value of the DENM |
---|---|
externalTemperatureUnit | external temperature unit |
Sets the heading value of this DENM message. This field contains the heading direction of the event.
headingValue | heading value of the DENM |
---|---|
headingValueUnit | unit of the heading value |
Sets the heading value of this DENM message. This field contains the heading direction of the event.
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 |
Sets the impact reduction values of this DENM message.
impactReduction | impact reduction values |
---|
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.
informationQuality | information quality value of the DENM |
---|
Sets the lane number of this DENM message. The lane number is counted from the outside border of the road.
laneNumber | lane number |
---|
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.
linkedCause | linked cause value of the DENM |
---|
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.
isNegation | negation status of this DENM |
---|
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.
positioningSolution | positioning solution value of the DENM |
---|
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.
referenceTime | reference time value of the DENM |
---|
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.
relevanceDistance | relevance distance of the DENM |
---|
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.
relevanceTrafficDirection | relevance traffic direction value of the DENM |
---|
Sets the road type value of a DENM message. This field holds the road type information at the event position.
roadType | road type |
---|
Sets the road works cpmtaomer of this DENM message.
roadWorks | road works container |
---|
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.
speedValue | speed value |
---|
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.
speedValue | speed value |
---|---|
speedUnit | speed unit |
confidenceWithin | speed confidence equal or within this value |
confidenceUnit | unit of speed confidence |
Sets the station type of this DENM message.
stationType | station type |
---|
Sets the stationary vehicle container of this DENM message.
stationaryVehicle | stationary vehicle container |
---|
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.
traces | list of traces of the DENM |
---|
Sets the transmissionInterval value of this DENM message.
transmissionInterval | transmission interval value of the DENM |
---|---|
transmissionIntervalUnit | unit of the transmission interval |
Sets the validity duration value for a DENM message. At the end of this validity duration the event is regarded as terminated.
validityDuration | validity duration value of the DENM |
---|---|
validityDurationUnit | unit of the validity duration |