public class

DENMTerminate

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

Class Overview

Represents a DENM termination.

Summary

Public Constructors
DENMTerminate()
Creates a new instance.
Public Methods
void clearRepetitionDuration()
Clears the repetition duration value
void clearRepetitionInterval()
Clears the repetition interval value.
void clearTransmissionInterval()
Clears the transmission interval value
void clearValidityDuration()
Clears the validity duration value.
DENMActionID getActionID()
Returns the action id.
DestAreaCircle getDestinationAreaCircle()
Returns the currently set destination area circle.
DestAreaEllipse getDestinationAreaEllipse()
Returns the currently set destination area ellipse.
DestAreaRectangle getDestinationAreaRectangle()
Returns the currently set destination area rectangle.
Date getDetectionTime()
Returns the detection time.
ReferencePos getEventPosition()
Returns the event position.
GNTrafficClass getGnTrafficClass()
Returns the geo networking traffic class.
int getHopLimit()
Returns the hop limit.
Date getReferenceTime()
Returns the reference time.
RelevanceDistance getRelevanceDistance()
Returns the relevance distance.
RelevanceTrafficDirection getRelevanceTrafficDirection()
Returns the relevance traffic direction.
Long getRepetitionDuration(TimeUnit unit)
Sets the repetition duration.
Long getRepetitionInterval(TimeUnit unit)
Returns the repetition interval.
StationType getStationType()
Returns the station type.
Long getTransmissionInterval(TimeUnit unit)
Returns the tranmission interval.
boolean getUseCurrentLocation()
Sets whether the current location should be used.
boolean getUseCurrentTime()
Returns whether the use current time flag was set.
Long getValidityDuration(TimeUnit unit)
Gets the validity duration in the specified unit.
boolean hasRepetitionDuration()
Returns true if the repetition duration value is set, false otherwise
boolean hasRepetitionInterval()
Return true if the repetition interval 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.
boolean isNegation()
Returns the negation status.
void setActionID(long stationId, long sequenceNumber)
Sets the action ID.
void setActionID(DENMActionID actionID)
Sets the action ID.
void setCancellation(Boolean isCancellation)
Sets the cancellation status.
void setDestinationAreaCircle(DestAreaCircle destinationAreaCircle)
Sets the destination area circle for the DENM trigger.
void setDestinationAreaEllipse(DestAreaEllipse destinationAreaEllipse)
Sets the destination area ellipse for the DENM trigger.
void setDestinationAreaRectangle(DestAreaRectangle destinationAreaRectangle)
Sets the destination area rectangle for the DENM trigger.
void setDetectionTime(Date detectionTime)
Sets the detection time.
void setEventPosition(ReferencePos eventPosition)
Sets the event position.
void setGnTrafficClass(boolean scfEnabled, boolean chOffload, long tcId)
Sets the traffic class.
void setGnTrafficClass(GNTrafficClass gnTrafficClass)
Sets the traffic class.
void setHopLimit(int hopLimit)
Sets the hop limit.
void setNegation(Boolean isNegation)
Sets the negation status.
void setReferenceTime(Date referenceTime)
Sets the reference time.
void setRelevanceDistance(RelevanceDistance relevanceDistance)
Sets the relevance distance.
void setRelevanceTrafficDirection(RelevanceTrafficDirection relevanceTrafficDirection)
Sets the relevance traffic direction.
void setRepetitionDuration(long repetitionDuration, TimeUnit repetitionDurationUnit)
Sets the repetition duration.
void setRepetitionInterval(long repetitionInterval, TimeUnit repetitionIntervalUnit)
Sets the repetition interval.
void setStationType(StationType stationType)
Sets the station type
void setTransmissionInterval(long transmissionInterval, TimeUnit transmissionIntervalUnit)
Sets the transmission interval.
void setUseCurrentLocation(boolean useCurrentLocation)
Sets whether the current location should be used.
void setUseCurrentTime(boolean useCurrentTime)
Sets whether the current time should be used.
void setValidityDuration(long validityDuration, TimeUnit validityDurationUnit)
Sets the validity duration.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public DENMTerminate ()

Creates a new instance.

Public Methods

public void clearRepetitionDuration ()

Clears the repetition duration value

public void clearRepetitionInterval ()

Clears the repetition interval value.

public void clearTransmissionInterval ()

Clears the transmission interval value

public void clearValidityDuration ()

Clears the validity duration value.

public DENMActionID getActionID ()

Returns the action id.

Returns
  • action Id

public DestAreaCircle getDestinationAreaCircle ()

Returns the currently set destination area circle.

Returns
  • the destination area circle

public DestAreaEllipse getDestinationAreaEllipse ()

Returns the currently set destination area ellipse.

Returns
  • the destination area ellipse

public DestAreaRectangle getDestinationAreaRectangle ()

Returns the currently set destination area rectangle.

Returns
  • the destination area rectangle

public Date getDetectionTime ()

Returns the detection time. The detectionTime is a time at which the event is detected by the originator ITS-S.

Returns
  • detection time

public ReferencePos getEventPosition ()

Returns the event position.

Returns
  • event position

public GNTrafficClass getGnTrafficClass ()

Returns the geo networking traffic class.

Returns
  • geo networking traffic class

public int getHopLimit ()

Returns the hop limit.

Returns
  • hop limit

public Date getReferenceTime ()

Returns the reference time.

Returns
  • reference time value of the DENM

public RelevanceDistance getRelevanceDistance ()

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

Returns
  • relevance distance

public RelevanceTrafficDirection getRelevanceTrafficDirection ()

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

Returns
  • relevance traffic direction

public Long getRepetitionDuration (TimeUnit unit)

Sets the repetition duration.

Parameters
unit target unit
Returns
  • the repetition duration in the specified unit

public Long getRepetitionInterval (TimeUnit unit)

Returns the repetition interval.

Parameters
unit target unit
Returns
  • the repetition interval in the specified unit

public StationType getStationType ()

Returns the station type.

Returns
  • station type

public Long getTransmissionInterval (TimeUnit unit)

Returns the tranmission interval. This field holds the time interval value for DENM repetition.

Returns
  • transmission interval value of the DENM, null if not specified regardless of the unit

public boolean getUseCurrentLocation ()

Sets whether the current location should be used. When enabled, the event position will be the current position and path history will be included as a trace.

Returns
  • true if useCurrentLocation is set, false otherwise

public boolean getUseCurrentTime ()

Returns whether the use current time flag was set.

Returns
  • whether the use current time flag was set

public Long getValidityDuration (TimeUnit unit)

Gets the validity duration in the specified unit. At the end of this validityDuration the event is regarded as terminated.

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

public boolean hasRepetitionDuration ()

Returns true if the repetition duration value is set, false otherwise

Returns
  • true if the repetition duration value is set, false otherwise

public boolean hasRepetitionInterval ()

Return true if the repetition interval value is set, false otherwise.

Returns
  • true if the repetition interval value is 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. This field shall be set to true when an event termination has been detected by the originator ITS station.

Returns
  • cancellation status.

public boolean isNegation ()

Returns the negation status. This field needs to be set to true when an event described by a previously received DENM does not exist any more.

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

public void setActionID (long stationId, long sequenceNumber)

Sets the action ID.

Parameters
stationId station id
sequenceNumber sequence number

public void setActionID (DENMActionID actionID)

Sets the action ID.

Parameters
actionID action Id

public void setCancellation (Boolean isCancellation)

Sets the cancellation status. This field shall be set to true when an event termination has been detected by the originator ITS station.

Parameters
isCancellation cancellation status

public void setDestinationAreaCircle (DestAreaCircle destinationAreaCircle)

Sets the destination area circle for the DENM trigger.

Parameters
destinationAreaCircle destination area circle

public void setDestinationAreaEllipse (DestAreaEllipse destinationAreaEllipse)

Sets the destination area ellipse for the DENM trigger.

Parameters
destinationAreaEllipse destination area ellipse

public void setDestinationAreaRectangle (DestAreaRectangle destinationAreaRectangle)

Sets the destination area rectangle for the DENM trigger.

Parameters
destinationAreaRectangle destination area rectangle

public void setDetectionTime (Date detectionTime)

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

Parameters
detectionTime detection time

public void setEventPosition (ReferencePos eventPosition)

Sets the event position.

Parameters
eventPosition event position

public void setGnTrafficClass (boolean scfEnabled, boolean chOffload, long tcId)

Sets the traffic class.

Parameters
scfEnabled true if SCF is enabled, false otherwise
chOffload true if CH offload is enabled, false otherwise
tcId traffic class id

public void setGnTrafficClass (GNTrafficClass gnTrafficClass)

Sets the traffic class.

Parameters
gnTrafficClass geo networking traffic class

public void setHopLimit (int hopLimit)

Sets the hop limit.

Parameters
hopLimit hop limit

public void setNegation (Boolean isNegation)

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

Parameters
isNegation isNegation value of the DENM

public void setReferenceTime (Date referenceTime)

Sets the reference time. 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. This field holds the distance value within which the event is considered relevant to the receiver ITS station.

Parameters
relevanceDistance relevance distance value of the DENM

public void setRelevanceTrafficDirection (RelevanceTrafficDirection relevanceTrafficDirection)

Sets the relevance traffic direction. This field holds the direction value 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 setRepetitionDuration (long repetitionDuration, TimeUnit repetitionDurationUnit)

Sets the repetition duration.

Parameters
repetitionDuration repetition duration value
repetitionDurationUnit unit of the repetition duration value

public void setRepetitionInterval (long repetitionInterval, TimeUnit repetitionIntervalUnit)

Sets the repetition interval.

Parameters
repetitionInterval repetition interval value
repetitionIntervalUnit unit of the repetition interval value

public void setStationType (StationType stationType)

Sets the station type

Parameters
stationType station type

public void setTransmissionInterval (long transmissionInterval, TimeUnit transmissionIntervalUnit)

Sets the transmission interval. This field holds the time interval value for DENM repetition.

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

public void setUseCurrentLocation (boolean useCurrentLocation)

Sets whether the current location should be used. When enabled, the event position will be the current position and path history will be included as a trace.

Parameters
useCurrentLocation value of the useCurrentLocation flag

public void setUseCurrentTime (boolean useCurrentTime)

Sets whether the current time should be used.

Parameters
useCurrentTime true if current time should be used, false otherwise

public void setValidityDuration (long validityDuration, TimeUnit validityDurationUnit)

Sets the validity duration. At the end of this validityDuration the event is regarded as terminated.

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

public String toString ()