public class

DENMTrigger

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

Class Overview

Represents a DENM trigger.

Summary

Public Constructors
DENMTrigger()
Public Methods
void clearRepetitionDuration()
Clears the repetition duration value
void clearRepetitionInterval()
Clears the repetition interval value.
DENM getDENM()
Returns the DENM contained in this trigger.
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.
GNTrafficClass getGnTrafficClass()
Returns the geo networking traffic class.
int getHopLimit()
Returns the hop limit.
Long getRepetitionDuration(TimeUnit unit)
Sets the repetition duration.
Long getRepetitionInterval(TimeUnit unit)
Returns the repetition interval.
boolean getUseCurrentLocation()
Sets whether the current location should be used.
boolean getUseCurrentTime()
Returns whether the use current time flag was set.
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 isInfinite()
Determine whether this DENM is infinite with regards to its validity duration.
void setDENM(DENM denm)
Sets the DENM contained in this trigger.
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 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 setInfinite(boolean infinite)
Sets whether this DENM is infinite with regards to its validity duration.
void setRepetitionDuration(long repetitionDuration, TimeUnit repetitionDurationUnit)
Sets the repetition duration.
void setRepetitionInterval(long repetitionInterval, TimeUnit repetitionIntervalUnit)
Sets the repetition 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.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public DENMTrigger ()

Public Methods

public void clearRepetitionDuration ()

Clears the repetition duration value

public void clearRepetitionInterval ()

Clears the repetition interval value.

public DENM getDENM ()

Returns the DENM contained in this trigger.

Returns
  • denm message

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 GNTrafficClass getGnTrafficClass ()

Returns the geo networking traffic class.

Returns
  • geo networking traffic class

public int getHopLimit ()

Returns the hop limit.

Returns
  • hop limit

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 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 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 isInfinite ()

Determine whether this DENM is infinite with regards to its validity duration. "Infinite" DENMs never expire even when their validity duration has long elapsed.

Returns
  • whether this DENM is infinite

public void setDENM (DENM denm)

Sets the DENM contained in this trigger.

Parameters
denm denm message

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 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 setInfinite (boolean infinite)

Sets whether this DENM is infinite with regards to its validity duration. "Infinite" DENMs never expire even when their validity duration has long elapsed.

Parameters
infinite true if this DENM is infinite, false otherwise

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 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 String toString ()