java.lang.Object | |
↳ | com.commsignia.v2x.client.model.DENMTerminate |
Represents a DENM termination.
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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Creates a new instance.
Clears the repetition duration value
Clears the repetition interval value.
Clears the transmission interval value
Clears the validity duration value.
Returns the currently set destination area circle.
Returns the currently set destination area ellipse.
Returns the currently set destination area rectangle.
Returns the detection time. The detectionTime is a time at which the event is detected by the originator ITS-S.
Returns the geo networking traffic class.
Returns the hop limit.
Returns the reference time.
Returns the relevance distance. This field holds the distance value within which the event is considered relevant to the receiver ITS station.
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.
Sets the repetition duration.
unit | target unit |
---|
Returns the repetition interval.
unit | target unit |
---|
Returns the tranmission interval. This field holds the time interval value for DENM repetition.
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 whether the use current time flag was set.
Gets the validity duration in the specified unit. At the end of this validityDuration the event is regarded as terminated.
unit | target unit |
---|
Returns true if the repetition duration value is set, false otherwise
Return true if the repetition interval 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. This field shall be set to true when an event termination has been detected by the originator ITS station.
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.
Sets the action ID.
stationId | station id |
---|---|
sequenceNumber | sequence number |
Sets the cancellation status. This field shall be set to true when an event termination has been detected by the originator ITS station.
isCancellation | cancellation status |
---|
Sets the destination area circle for the DENM trigger.
destinationAreaCircle | destination area circle |
---|
Sets the destination area ellipse for the DENM trigger.
destinationAreaEllipse | destination area ellipse |
---|
Sets the destination area rectangle for the DENM trigger.
destinationAreaRectangle | destination area rectangle |
---|
Sets the detection time. The detectionTime is a time at which the event is detected by the originator ITS-S.
detectionTime | detection time |
---|
Sets the event position.
eventPosition | event position |
---|
Sets the traffic class.
scfEnabled | true if SCF is enabled, false otherwise |
---|---|
chOffload | true if CH offload is enabled, false otherwise |
tcId | traffic class id |
Sets the traffic class.
gnTrafficClass | geo networking traffic class |
---|
Sets the hop limit.
hopLimit | hop limit |
---|
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.
isNegation | isNegation value of the DENM |
---|
Sets the reference time. 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. This field holds the distance value within which the event is considered relevant to the receiver ITS station.
relevanceDistance | relevance distance value of the DENM |
---|
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.
relevanceTrafficDirection | relevance traffic direction value of the DENM |
---|
Sets the repetition duration.
repetitionDuration | repetition duration value |
---|---|
repetitionDurationUnit | unit of the repetition duration value |
Sets the repetition interval.
repetitionInterval | repetition interval value |
---|---|
repetitionIntervalUnit | unit of the repetition interval value |
Sets the station type
stationType | station type |
---|
Sets the transmission interval. This field holds the time interval value for DENM repetition.
transmissionInterval | transmission interval value of the DENM |
---|---|
transmissionIntervalUnit | unit of the transmission interval |
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.
useCurrentLocation | value of the useCurrentLocation flag |
---|
Sets whether the current time should be used.
useCurrentTime | true if current time should be used, false otherwise |
---|
Sets the validity duration. At the end of this validityDuration the event is regarded as terminated.
validityDuration | validity duration value of the DENM |
---|---|
validityDurationUnit | unit of the validity duration |