public static class

GeonetSendData.Builder

extends Object
java.lang.Object
   ↳ com.commsignia.v2x.client.model.GeonetSendData.Builder

Class Overview

Utility class for building GeonetSendData instances.

Summary

Public Constructors
GeonetSendData.Builder()
Create a new builder instance.
Public Methods
GeonetSendData.Builder asBTPA()
Send the packet as BTP type A.
GeonetSendData.Builder asBTPB()
Send the packet as BTP type B.
GeonetSendData.Builder asBTPNone()
Send the packet as BTP type None.
GeonetSendData.Builder asBeacon()
Send the packet as a beacon.
GeonetSendData.Builder asGAC()
Send the packet as geoanycast.
GeonetSendData.Builder asGBC()
Send the packet as geobroadcast.
GeonetSendData.Builder asGUC()
Send the packet as geounicast.
GeonetSendData.Builder asSHB()
Send the packet as Single Hop Broadcast.
GeonetSendData.Builder asTSB()
Send the packet as Topologically Scoped Broadcast.
GeonetSendData build()
Construct a valid GeonetSendData object.
GeonetSendData.Builder withData(byte[] data)
Sets the payload data.
GeonetSendData.Builder withDatarateKbps(long datarateKbps)
Send the packet with the specified data rate in Kbps.
GeonetSendData.Builder withDestinationAddress(String destinationAddress)
Send the packet to the specified destination address.
GeonetSendData.Builder withDestinationAreaCircle(DestAreaCircle circle)
Send the packet with the specified destination area circle.
GeonetSendData.Builder withDestinationAreaCircle(long latitude, long longitude, double radius, LengthUnit radiusUnit)
Send the packet with the specified destination area circle.
GeonetSendData.Builder withDestinationAreaEllipse(long latitude, long longitude, double semiAxisA, LengthUnit semiAxisAUnit, double semiAxisB, LengthUnit semiAxisBUnit, double angle, DegreeUnit angleUnit)
Send the packet with the specified destination area ellipse.
GeonetSendData.Builder withDestinationAreaEllipse(DestAreaEllipse ellipse)
Send the packet with the specified destination area ellipse.
GeonetSendData.Builder withDestinationAreaRectangle(DestAreaRectangle rectangle)
Send the packet with the specified destination area rectangle.
GeonetSendData.Builder withDestinationAreaRectangle(long latitude, long longitude, double semiAxisA, LengthUnit semiAxisAUnit, double semiAxisB, LengthUnit semiAxisBUnit, double angle, DegreeUnit angleUnit)
Send the packet with the specified destination area rectangle.
GeonetSendData.Builder withDestinationPort(long destinationPort)
Send the packet with the specified destination port.
GeonetSendData.Builder withInterfaceID(long interfaceID)
Send the packet using the specified interface ID.
GeonetSendData.Builder withMaxHops(long maxHops)
Send the packet with the specified number of maximum hops.
GeonetSendData.Builder withPacketLifetimeMsec(long packetLifetimeMsec)
Send the packet with the specified packet lifetime.
GeonetSendData.Builder withSecurityInfo(GeonetSecurityInfo securityInfo)
Send the packet with the specified securty info structure.
GeonetSendData.Builder withSecurityProfile(long securityProfile)
Send the packet with the specified security profile
GeonetSendData.Builder withSourcePortOrDestinationInfo(long sourcePortOrDestinationInfo)
Send the packet with the specified source port when using BTP-A or destination info when using BTP-B.
GeonetSendData.Builder withTrafficClass(boolean scfEnabled, boolean chOffload, long tcId)
Send the packet with the specified traffic class parameters.
GeonetSendData.Builder withTxPowerDbm(long txPowerDbm)
Send the packet with the specified TX power value in dBm.
GeonetSendData.Builder withUserPriority(long userPriority)
Send the packet with the specified user priority.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public GeonetSendData.Builder ()

Create a new builder instance.

Public Methods

public GeonetSendData.Builder asBTPA ()

Send the packet as BTP type A.

Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder asBTPB ()

Send the packet as BTP type B.

Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder asBTPNone ()

Send the packet as BTP type None.

Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder asBeacon ()

Send the packet as a beacon.

Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder asGAC ()

Send the packet as geoanycast.

Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder asGBC ()

Send the packet as geobroadcast.

Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder asGUC ()

Send the packet as geounicast.

Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder asSHB ()

Send the packet as Single Hop Broadcast.

Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder asTSB ()

Send the packet as Topologically Scoped Broadcast.

Returns
  • the same builder instance this method was invoked on

public GeonetSendData build ()

Construct a valid GeonetSendData object.

Returns
  • valid GeonetSendData object
Throws
IllegalStateException when the specified parameters are incorrect

public GeonetSendData.Builder withData (byte[] data)

Sets the payload data.

Parameters
data payload data
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withDatarateKbps (long datarateKbps)

Send the packet with the specified data rate in Kbps.

Parameters
datarateKbps data rate in Kbps
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withDestinationAddress (String destinationAddress)

Send the packet to the specified destination address.

Parameters
destinationAddress destination address
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withDestinationAreaCircle (DestAreaCircle circle)

Send the packet with the specified destination area circle.

Parameters
circle destination area circle
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withDestinationAreaCircle (long latitude, long longitude, double radius, LengthUnit radiusUnit)

Send the packet with the specified destination area circle.

Parameters
latitude latitude in 0.1 microdegrees
longitude longitude in 0.1 microdegrees
radius radius in decimeters
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withDestinationAreaEllipse (long latitude, long longitude, double semiAxisA, LengthUnit semiAxisAUnit, double semiAxisB, LengthUnit semiAxisBUnit, double angle, DegreeUnit angleUnit)

Send the packet with the specified destination area ellipse.

Parameters
latitude latitude in 0.1 microdegrees
longitude longitude in 0.1 microdegrees
semiAxisA semi axis A value
semiAxisAUnit semi axis A unit
semiAxisB semi axis B value
semiAxisBUnit semi axis B unit
angle angle value
angleUnit angle unit
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withDestinationAreaEllipse (DestAreaEllipse ellipse)

Send the packet with the specified destination area ellipse.

Parameters
ellipse destination area ellipse
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withDestinationAreaRectangle (DestAreaRectangle rectangle)

Send the packet with the specified destination area rectangle.

Parameters
rectangle destination area rectangle
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withDestinationAreaRectangle (long latitude, long longitude, double semiAxisA, LengthUnit semiAxisAUnit, double semiAxisB, LengthUnit semiAxisBUnit, double angle, DegreeUnit angleUnit)

Send the packet with the specified destination area rectangle.

Parameters
latitude latitude in 0.1 microdegrees
longitude longitude in 0.1 microdegrees
semiAxisA semi axis A value
semiAxisAUnit semi axis A unit
semiAxisB semi axis B value
semiAxisBUnit semi axis B unit
angle angle value
angleUnit angle unit
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withDestinationPort (long destinationPort)

Send the packet with the specified destination port.

Parameters
destinationPort destination port
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withInterfaceID (long interfaceID)

Send the packet using the specified interface ID.

Parameters
interfaceID interface ID
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withMaxHops (long maxHops)

Send the packet with the specified number of maximum hops.

Parameters
maxHops maximum hops
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withPacketLifetimeMsec (long packetLifetimeMsec)

Send the packet with the specified packet lifetime.

Parameters
packetLifetimeMsec packet lifetime in milisecs
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withSecurityInfo (GeonetSecurityInfo securityInfo)

Send the packet with the specified securty info structure.

Parameters
securityInfo security info structure
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withSecurityProfile (long securityProfile)

Send the packet with the specified security profile

Parameters
securityProfile security profile
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withSourcePortOrDestinationInfo (long sourcePortOrDestinationInfo)

Send the packet with the specified source port when using BTP-A or destination info when using BTP-B.

Parameters
sourcePortOrDestinationInfo source port or destination info
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withTrafficClass (boolean scfEnabled, boolean chOffload, long tcId)

Send the packet with the specified traffic class parameters.

Parameters
scfEnabled whether scf is enabled
chOffload whether ch offload is enabled
tcId traffic class id
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withTxPowerDbm (long txPowerDbm)

Send the packet with the specified TX power value in dBm.

Parameters
txPowerDbm TX power value in dBm
Returns
  • the same builder instance this method was invoked on

public GeonetSendData.Builder withUserPriority (long userPriority)

Send the packet with the specified user priority.

Parameters
userPriority user priority
Returns
  • the same builder instance this method was invoked on