pt.lsts.imc

Class DvlRejection

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.DvlRejection

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<IMCMessage>, IMessage

public class DvlRejection
extends IMCMessage

IMC Message DVL Rejection (358)
When the vehicle uses Doppler Velocity Log sensor, this message
notifies that a new measurement was locally rejected by the
navigation filter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DvlRejection.REASON

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_STATIC
static short	TYPE_GV
static short	TYPE_WV

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
DvlRejection()
DvlRejection(IMCDefinition defs)
DvlRejection(IMCMessage msg)
DvlRejection(short type, DvlRejection.REASON reason, float value, float timestep)

Method Summary

Modifier and Type	Method and Description
static DvlRejection	clone(IMCMessage msg)
static DvlRejection	create(java.lang.Object... values)
DvlRejection.REASON	getReason()
java.lang.String	getReasonStr()
short	getReasonVal()
double	getTimestep()
short	getType()
double	getValue()
DvlRejection	setReason(DvlRejection.REASON reason)
DvlRejection	setReasonStr(java.lang.String reason)
DvlRejection	setReasonVal(short reason)
DvlRejection	setTimestep(double timestep)
DvlRejection	setType(short type)
DvlRejection	setValue(double value)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asJSON, asMap, asXml, asXmlStripped, cloneMessage, cloneMessage, compareTo, copyFrom, copyToClipoard, decodeTupleList, dump, encodeTupleList, get, getAbbrev, getAgeInSeconds, getAsNumber, getAsString, getBitmask, getDate, getDouble, getDst, getDstEnt, getEntityName, getFieldNames, getFloat, getHeader, getHeaderValue, getInteger, getLong, getLongFieldName, getLongName, getMessage, getMessage, getMessageInfo, getMessageList, getMessageList, getMessageType, getMgid, getPayloadSize, getProtocolFactory, getRawData, getSize, getSourceName, getSrc, getSrcEnt, getString, getString, getTimestamp, getTimestampMillis, getTupleList, getTypeOf, getUnitsOf, getValue, getValues, hasFlag, hexdump, isNull, isPeriodic, makeImmutable, parseJson, parseXml, pasteFromClipoard, payloadMD5, serialize, serialize, serialize, serializePayload, setBitMask, setDst, setDstEnt, setHeader, setMessageInfo, setMessageList, setSrc, setSrcEnt, setTimestamp, setTimestampMillis, setType, setValue, setValues, toByteArray, toByteArray, toString, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_GV

public static final short TYPE_GV

See Also:

Constant Field Values

TYPE_WV

public static final short TYPE_WV

See Also:

Constant Field Values

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

DvlRejection

public DvlRejection()

DvlRejection

public DvlRejection(IMCMessage msg)

DvlRejection

public DvlRejection(IMCDefinition defs)

DvlRejection

public DvlRejection(short type,
                    DvlRejection.REASON reason,
                    float value,
                    float timestep)

Method Detail

create

public static DvlRejection create(java.lang.Object... values)

clone

public static DvlRejection clone(IMCMessage msg)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getType

public short getType()

Returns:

Type of velocity (bitfield) - uint8_t

setType

public DvlRejection setType(short type)

Parameters:

type - Type of velocity (bitfield)

getReason

public DvlRejection.REASON getReason()

Returns:

Reason (enumerated) - uint8_t

getReasonStr

public java.lang.String getReasonStr()

getReasonVal

public short getReasonVal()

setReason

public DvlRejection setReason(DvlRejection.REASON reason)

Parameters:

reason - Reason (enumerated)

setReasonStr

public DvlRejection setReasonStr(java.lang.String reason)

Parameters:

reason - Reason (as a String)

setReasonVal

public DvlRejection setReasonVal(short reason)

Parameters:

reason - Reason (integer value)

getValue

public double getValue()

Returns:

Value (m/s) - fp32_t

setValue

public DvlRejection setValue(double value)

Parameters:

value - Value (m/s)

getTimestep

public double getTimestep()

Returns:

Timestep (s) - fp32_t

setTimestep

public DvlRejection setTimestep(double timestep)

Parameters:

timestep - Timestep (s)