public class

BasicSafetyMessage

extends Object
java.lang.Object
   ↳ com.commsignia.v2x.client.model.bsm.BasicSafetyMessage

Class Overview

Represents a basic safety message.

Summary

Public Constructors
BasicSafetyMessage()
Creates a new instance.
Public Methods
boolean equals(Object o)
AntiLockBrakeState getAbsStatus()
Returns the ABS status.
AuxiliaryBrakeState getAuxBrakeStatus()
Returns the auxiliary brake status.
BrakeBoostState getBrakeBoostStatus()
Returns the brake boost status.
Double getElevation(LengthUnit unit)
Returns the elevation in the sepecified unit or null if not specified.
BSMSafetyEventFlags getEvents()
Returns the event flags if available.
FullPositionVector getFullPositionVector()
Returns the full position vector if available.
double getHeading(DegreeUnit unit)
Returns the heading.
long getId()
Returns the id.
Double getLateralAcceleration(AccelerationUnit unit)
Returns the lateral acceleration.
long getLatitude()
Returns the latitude.
LightbarInUse getLightBarInUse()
Returns light bar status.
long getLongitude()
Returns the longitude.
Double getLongitudinalAcceleration(AccelerationUnit unit)
Returns the longitudinal acceleration.
int getMsgCount()
Returns the message count.
long getSecMark(TimeUnit unit)
Returns the second mark.
Double getSemiMajorAccuracy(LengthUnit unit)
Returns the semi major accuracy in the specified unit.
Double getSemiMajorOrientation(DegreeUnit unit)
Returns the semi major orientation in the specified unit.
Double getSemiMinorAccuracy(LengthUnit unit)
Returns the semi minor accuracy in the specified unit.
Double getSpeed(SpeedUnit unit)
Returns the speed.
StabilityControlState getStabilityControlStatus()
Returns the stability control status.
Double getSteeringWheelAngle(DegreeUnit unit)
Returns the steering wheel angle.
Double getThrottlePosition()
Returns the throttle position.
TractionControlState getTractionControlStatus()
Returns the traction control status.
TransmissionState getTransmissionState()
Returns the transmission state.
double getVehicheWidth(LengthUnit unit)
Returns the vehicle width in the specified unit.
double getVehicleLength(LengthUnit unit)
Returns the vehicle length in the specified unit
VehicleType getVehicleType()
Returns the vehicle type.
BrakeAppliedState getWheelBrakeStatus()
Returns the wheel brake status.
double getYawRate(DegreeUnit unit)
Returns the yaw rate.
boolean hasElevation()
Retruns true if elevation has been set.
boolean hasEvents()
Returns whether event flags are available.
boolean hasFullPositionVector()
Returns whether the full position vector is available.
boolean hasSemiMajorAccuracy()
Returns true if the semi major accuracy has been set.
boolean hasSemiMajorOrientation()
Returns true if the semi major orientation has been set.
boolean hasSemiMinorAccuracy()
Returns true if the semi minor accuracy has been set.
boolean hasSteeringWheelAngle()
Returns true if the steering wheel angle has been set.
int hashCode()
void setAbsStatus(AntiLockBrakeState absStatus)
Sets the ABS status.
void setAuxBrakeStatus(AuxiliaryBrakeState auxBrakeStatus)
Sets the auxiliary brake status.
void setBrakeBoostStatus(BrakeBoostState brakeBoostStatus)
Sets the brake boost status.
void setElevation(double elevation, LengthUnit elevationUnit)
Sets the elevation in the specified unit.
void setEvents(BSMSafetyEventFlags events)
Sets the event flags.
void setFullPositionVector(FullPositionVector fullPositionVector)
Sets the full position vector.
void setHeading(double heading, DegreeUnit headingUnit)
Sets the heading.
void setId(long id)
Sets the id.
void setLateralAcceleration(double lateralAcceleration, AccelerationUnit lateralAccelerationUnit)
Sets the lateral acceleration.
void setLatitude(long latitude)
Sets the latitude.
void setLightBarInUse(LightbarInUse lightBarInUse)
Sets state of the light bar.
void setLongitude(long longitude)
Sets the longitude.
void setLongitudinalAcceleration(double longitudinalAcceleration, AccelerationUnit longitudinalAccelerationUnit)
Sets the longitudinal acceleration.
void setMsgCount(int msgCount)
Sets the message count.
void setSecMark(long secMark, TimeUnit secMarkUnit)
Sets the seconds mark.
void setSemiMajorAccuracy(double semiMajorAccuracy, LengthUnit semiMajorAccuracyUnit)
Sets the semi major accuracy.
void setSemiMajorOrientation(double semiMajorOrientation, DegreeUnit semiMajorOrientationUnit)
Sets the semi major orientation.
void setSemiMinorAccuracy(double semiMinorAccuracy, LengthUnit semiMinorAccuracyUnit)
Sets the semi minor accuracy.
void setSpeed(double speed, SpeedUnit speedUnit)
Sets the speed.
void setStabilityControlStatus(StabilityControlState stabilityControlStatus)
Sets the stability control status
void setSteeringWheelAngle(double steeringWheelAngle, DegreeUnit steeringWheelAngleUnit)
Sets the steering wheel angle.
void setThrottlePosition(Double throttlePosition)
Sets the throttle position.
void setTractionControlStatus(TractionControlState tractionControlStatus)
Sets the traction control status.
void setTransmissionState(TransmissionState transmissionState)
Sets the transmission state.
void setVehicleLength(double vehicleLength, LengthUnit vehicleLengthUnit)
Sets the vehicle length.
void setVehicleType(VehicleType vehicleType)
Sets the vehicle type
void setVehicleWidth(double vehicheWidth, LengthUnit vehicleWidthUnit)
Sets the vehichle width.
void setWheelBrakeStatus(BrakeAppliedState wheelBrakeStatus)
Sets the wheel brake status.
void setYawRate(double yawRate, DegreeUnit yawRateUnit)
Sets the yaw rate.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public BasicSafetyMessage ()

Creates a new instance.

Public Methods

public boolean equals (Object o)

public AntiLockBrakeState getAbsStatus ()

Returns the ABS status.

Returns
  • ABS status

public AuxiliaryBrakeState getAuxBrakeStatus ()

Returns the auxiliary brake status.

Returns
  • auxiliary brake status

public BrakeBoostState getBrakeBoostStatus ()

Returns the brake boost status.

Returns
  • brake boost status

public Double getElevation (LengthUnit unit)

Returns the elevation in the sepecified unit or null if not specified.

Parameters
unit target unit
Returns
  • elevation in the specified unit or null if not specified

public BSMSafetyEventFlags getEvents ()

Returns the event flags if available.

Returns
  • event flags or null

public FullPositionVector getFullPositionVector ()

Returns the full position vector if available.

Returns
  • full position vector or null

public double getHeading (DegreeUnit unit)

Returns the heading.

Parameters
unit target unit
Returns
  • heading in the specified unit

public long getId ()

Returns the id.

Returns
  • id

public Double getLateralAcceleration (AccelerationUnit unit)

Returns the lateral acceleration.

Parameters
unit target unit
Returns
  • lateral acceleration in the specified unit

public long getLatitude ()

Returns the latitude.

Returns
  • latitude in 0.1 microdegrees

public LightbarInUse getLightBarInUse ()

Returns light bar status.

Returns
  • light bar status

public long getLongitude ()

Returns the longitude.

Returns
  • longitude in 0.1 microdegrees

public Double getLongitudinalAcceleration (AccelerationUnit unit)

Returns the longitudinal acceleration.

Parameters
unit target unit
Returns
  • longitudinal acceleration in the target unit or null if not specified

public int getMsgCount ()

Returns the message count.

Returns
  • message count

public long getSecMark (TimeUnit unit)

Returns the second mark.

Parameters
unit target unit
Returns
  • seconds mark in the specified unit

public Double getSemiMajorAccuracy (LengthUnit unit)

Returns the semi major accuracy in the specified unit.

Parameters
unit target unit
Returns
  • semi major accuracy in the specified unit or null if not specified

public Double getSemiMajorOrientation (DegreeUnit unit)

Returns the semi major orientation in the specified unit.

Parameters
unit target unit
Returns
  • semi major orientation in the specified unit or null if not specified.

public Double getSemiMinorAccuracy (LengthUnit unit)

Returns the semi minor accuracy in the specified unit.

Parameters
unit target unit
Returns
  • semi minor accuracy in the specified unit or null if not specified

public Double getSpeed (SpeedUnit unit)

Returns the speed.

Parameters
unit target unit
Returns
  • speed in the specified unit or null if not defined

public StabilityControlState getStabilityControlStatus ()

Returns the stability control status.

Returns
  • stability control status

public Double getSteeringWheelAngle (DegreeUnit unit)

Returns the steering wheel angle.

Parameters
unit target unit
Returns
  • steering wheel angle or null if not set

public Double getThrottlePosition ()

Returns the throttle position.

Returns
  • throttle position in percent

public TractionControlState getTractionControlStatus ()

Returns the traction control status.

Returns
  • traction control status

public TransmissionState getTransmissionState ()

Returns the transmission state.

Returns
  • transmission state

public double getVehicheWidth (LengthUnit unit)

Returns the vehicle width in the specified unit.

Parameters
unit target unit
Returns
  • vehicle width in the specified unit

public double getVehicleLength (LengthUnit unit)

Returns the vehicle length in the specified unit

Parameters
unit target unit
Returns
  • vehicle length in the specified unit

public VehicleType getVehicleType ()

Returns the vehicle type.

Returns
  • vehicle type

public BrakeAppliedState getWheelBrakeStatus ()

Returns the wheel brake status.

Returns
  • wheel brake status

public double getYawRate (DegreeUnit unit)

Returns the yaw rate.

Parameters
unit target unit
Returns
  • yaw rate in the target unit

public boolean hasElevation ()

Retruns true if elevation has been set.

Returns
  • true if elevation has been set.

public boolean hasEvents ()

Returns whether event flags are available.

Returns
  • true if event flags are available, false otherwise.

public boolean hasFullPositionVector ()

Returns whether the full position vector is available.

Returns
  • true if available, false if not

public boolean hasSemiMajorAccuracy ()

Returns true if the semi major accuracy has been set.

Returns
  • true if the semi major accuracy has been set.

public boolean hasSemiMajorOrientation ()

Returns true if the semi major orientation has been set.

Returns
  • true if the semi major orientation has been set

public boolean hasSemiMinorAccuracy ()

Returns true if the semi minor accuracy has been set.

Returns
  • true if the semi minor accuracy has been set

public boolean hasSteeringWheelAngle ()

Returns true if the steering wheel angle has been set.

Returns
  • true if the steering wheel angle has been set.

public int hashCode ()

public void setAbsStatus (AntiLockBrakeState absStatus)

Sets the ABS status.

Parameters
absStatus ABS status

public void setAuxBrakeStatus (AuxiliaryBrakeState auxBrakeStatus)

Sets the auxiliary brake status.

Parameters
auxBrakeStatus auxiliary brake status

public void setBrakeBoostStatus (BrakeBoostState brakeBoostStatus)

Sets the brake boost status.

Parameters
brakeBoostStatus brake boost status

public void setElevation (double elevation, LengthUnit elevationUnit)

Sets the elevation in the specified unit.

Parameters
elevation elevation value
elevationUnit elevation unit

public void setEvents (BSMSafetyEventFlags events)

Sets the event flags.

Parameters
events event flags

public void setFullPositionVector (FullPositionVector fullPositionVector)

Sets the full position vector.

Parameters
fullPositionVector full position vector

public void setHeading (double heading, DegreeUnit headingUnit)

Sets the heading.

Parameters
heading heading value
headingUnit heading unit

public void setId (long id)

Sets the id.

Parameters
id id

public void setLateralAcceleration (double lateralAcceleration, AccelerationUnit lateralAccelerationUnit)

Sets the lateral acceleration.

Parameters
lateralAcceleration lateral acceleration value
lateralAccelerationUnit lateral acceleration unit

public void setLatitude (long latitude)

Sets the latitude.

Parameters
latitude latitude in 0.1 microdegrees

public void setLightBarInUse (LightbarInUse lightBarInUse)

Sets state of the light bar.

Parameters
lightBarInUse light bar state

public void setLongitude (long longitude)

Sets the longitude.

Parameters
longitude longitude in 0.1 microdegrees

public void setLongitudinalAcceleration (double longitudinalAcceleration, AccelerationUnit longitudinalAccelerationUnit)

Sets the longitudinal acceleration.

Parameters
longitudinalAcceleration longitudinal acceleration value
longitudinalAccelerationUnit longitudinal acceleration unit

public void setMsgCount (int msgCount)

Sets the message count.

Parameters
msgCount message count

public void setSecMark (long secMark, TimeUnit secMarkUnit)

Sets the seconds mark.

Parameters
secMark seconds mark value
secMarkUnit seconds mark unit

public void setSemiMajorAccuracy (double semiMajorAccuracy, LengthUnit semiMajorAccuracyUnit)

Sets the semi major accuracy.

Parameters
semiMajorAccuracy semi major accuracy value
semiMajorAccuracyUnit semi major accuracy unit

public void setSemiMajorOrientation (double semiMajorOrientation, DegreeUnit semiMajorOrientationUnit)

Sets the semi major orientation.

Parameters
semiMajorOrientation semi major orientation value
semiMajorOrientationUnit semi major orientation unit

public void setSemiMinorAccuracy (double semiMinorAccuracy, LengthUnit semiMinorAccuracyUnit)

Sets the semi minor accuracy.

Parameters
semiMinorAccuracy semi minor accuracy value
semiMinorAccuracyUnit semi minor accuracy unit

public void setSpeed (double speed, SpeedUnit speedUnit)

Sets the speed.

Parameters
speed speed value
speedUnit speed unit

public void setStabilityControlStatus (StabilityControlState stabilityControlStatus)

Sets the stability control status

Parameters
stabilityControlStatus stability control status

public void setSteeringWheelAngle (double steeringWheelAngle, DegreeUnit steeringWheelAngleUnit)

Sets the steering wheel angle.

Parameters
steeringWheelAngle steering wheel angle
steeringWheelAngleUnit steering wheel unit

public void setThrottlePosition (Double throttlePosition)

Sets the throttle position.

Parameters
throttlePosition throttle position in percent

public void setTractionControlStatus (TractionControlState tractionControlStatus)

Sets the traction control status.

Parameters
tractionControlStatus traction control status

public void setTransmissionState (TransmissionState transmissionState)

Sets the transmission state.

Parameters
transmissionState transmission state

public void setVehicleLength (double vehicleLength, LengthUnit vehicleLengthUnit)

Sets the vehicle length.

Parameters
vehicleLength vehicle length value
vehicleLengthUnit vehicle length unit

public void setVehicleType (VehicleType vehicleType)

Sets the vehicle type

Parameters
vehicleType vehicle type

public void setVehicleWidth (double vehicheWidth, LengthUnit vehicleWidthUnit)

Sets the vehichle width.

Parameters
vehicheWidth vehicle width value
vehicleWidthUnit vehicle width unit

public void setWheelBrakeStatus (BrakeAppliedState wheelBrakeStatus)

Sets the wheel brake status.

Parameters
wheelBrakeStatus wheel brake status

public void setYawRate (double yawRate, DegreeUnit yawRateUnit)

Sets the yaw rate.

Parameters
yawRate yaw rate value
yawRateUnit yaw rate unit

public String toString ()