public class

LdmFilter

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

Class Overview

Represents an LDM filter in a filter set.

Summary

Public Constructors
LdmFilter()
Create an empty LDM filter
Public Methods
LdmFilter clearObjectTypeFilter()
Clears the LDM object type filter values.
LdmFilter clearPositionAndDistanceFilters()
Clears the position and distance filters to none.
LdmFilter disableFullDetail()
Disable full detail on this filter.
LdmFilter disableHighFrequencyCAM()
Disable high frequency CAM reception.
LdmFilter enableFullDetail()
Enable full detail on this filter.
LdmFilter enableHighFrequencyCAM()
Enable high frequency CAM reception.
LdmFilter excludeLocalLDMs()
Exclude local LDMs when this filter is applied
PrimaryCause getCauseTypeFilter()
Returns the cause type used by this filter.
Double getDistanceFilter(LengthUnit unit)
Returns the distance filter value in meters.
LdmSubscriptionLocal getLocalSubscriptionFlag()
Returns the LDM subscription local flag.
Set<LdmObjectType> getObjectTypeFilter()
Returns the object type filter values.
PositionFilter getPositionFilter()
Get the current position filter.
StationType getStationTypeFilter()
Returns the station type filter value.
boolean hasDistanceFilter()
Returns true if the distance filter has been set, false otherwise
boolean hasPositionFilter()
Returns true if the position filter has been set
LdmFilter includeLocalLDMs()
Include local LDMs when this filter is applied
LdmFilter includeOnlyLocalLDMs()
Include local LDMs *ONLY* when this filter is applied
boolean isFullDetail()
Returns the value of the full detail filter criteria
boolean isHighFrequencyCAM()
Returns true if high frequency CAM reception is enabled.
LdmFilter setCauseTypeFilter(PrimaryCause cause)
Sets the cause type filter.
LdmFilter setDistanceFilter(double distanceFilter, LengthUnit distanceFilterUnit)
Set a filter for distance from the current location.
LdmFilter setObjectTypeFilter(LdmObjectType... ldmObjectFilters)
Specifies the LDM object types to filter for.
LdmFilter setPositionFilter(int latitude, int longitude, int semiAxisA, int semiAxisB, ShapeType shapeType)
Set the position filter.
LdmFilter setStationTypeFilter(StationType stationType)
Sets the station type filter.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public LdmFilter ()

Create an empty LDM filter

Public Methods

public LdmFilter clearObjectTypeFilter ()

Clears the LDM object type filter values.

Returns
  • the same LdmFilter object this method was invoked on

public LdmFilter clearPositionAndDistanceFilters ()

Clears the position and distance filters to none.

Returns
  • the same LdmFilter object this method was invoked on

public LdmFilter disableFullDetail ()

Disable full detail on this filter.

Returns
  • the same LdmFilter object this method was invoked on

public LdmFilter disableHighFrequencyCAM ()

Disable high frequency CAM reception.

Returns
  • the same LdmFilter object this method was invoked on

public LdmFilter enableFullDetail ()

Enable full detail on this filter.

Returns
  • the same LdmFilter object this method was invoked on

public LdmFilter enableHighFrequencyCAM ()

Enable high frequency CAM reception.

Returns
  • the same LdmFilter object this method was invoked on

public LdmFilter excludeLocalLDMs ()

Exclude local LDMs when this filter is applied

Returns
  • the same LdmFilter object this method was invoked on

public PrimaryCause getCauseTypeFilter ()

Returns the cause type used by this filter.

Returns
  • the cause type

public Double getDistanceFilter (LengthUnit unit)

Returns the distance filter value in meters.

Returns
  • the distance from the current location in meters

public LdmSubscriptionLocal getLocalSubscriptionFlag ()

Returns the LDM subscription local flag.

Returns
  • value of the local LDM subscription flag

public Set<LdmObjectType> getObjectTypeFilter ()

Returns the object type filter values.

Returns
  • object type filter values

public PositionFilter getPositionFilter ()

Get the current position filter.

Returns
  • PositionFilter instance

public StationType getStationTypeFilter ()

Returns the station type filter value.

Returns
  • the station type

public boolean hasDistanceFilter ()

Returns true if the distance filter has been set, false otherwise

Returns
  • true if the distance filter has been set, false otherwise

public boolean hasPositionFilter ()

Returns true if the position filter has been set

Returns
  • true if the position filter has been set

public LdmFilter includeLocalLDMs ()

Include local LDMs when this filter is applied

Returns
  • the same LdmFilter object this method was invoked on

public LdmFilter includeOnlyLocalLDMs ()

Include local LDMs *ONLY* when this filter is applied

Returns
  • the same LdmFilter object this method was invoked on

public boolean isFullDetail ()

Returns the value of the full detail filter criteria

Returns
  • true if full detail is enabled

public boolean isHighFrequencyCAM ()

Returns true if high frequency CAM reception is enabled.

Returns
  • true if enabled

public LdmFilter setCauseTypeFilter (PrimaryCause cause)

Sets the cause type filter.

Parameters
cause cause type
Returns
  • the same LdmFilter object this method was invoked on

public LdmFilter setDistanceFilter (double distanceFilter, LengthUnit distanceFilterUnit)

Set a filter for distance from the current location. Use distanceFilter OR positionFilter, NEVER use both of them.

Returns
  • the same LdmFilter object this method was invoked on
Throws
IllegalStateException if position filter option is enabled

public LdmFilter setObjectTypeFilter (LdmObjectType... ldmObjectFilters)

Specifies the LDM object types to filter for.

Parameters
ldmObjectFilters list of ldm object types
Returns
  • the same LdmFilter object this method was invoked on

public LdmFilter setPositionFilter (int latitude, int longitude, int semiAxisA, int semiAxisB, ShapeType shapeType)

Set the position filter. Use distanceFilter OR positionFilter, NEVER use both of them.

Parameters
latitude Latitude of center point of shape
longitude Longitude of center point of shape
semiAxisA semi axis A of shape
semiAxisB semi axis B of shape
shapeType Shape type
Returns
  • the same LdmFilter object this method was invoked on
Throws
IllegalStateException if distance filter option is enabled

public LdmFilter setStationTypeFilter (StationType stationType)

Sets the station type filter.

Parameters
stationType station type
Returns
  • the same LdmFilter object this method was invoked on