pt.up.fe.dceg.neptus.imc

Class WaterVelocity

java.lang.Object

pt.up.fe.dceg.neptus.imc.IMCMessage

pt.up.fe.dceg.neptus.imc.WaterVelocity

All Implemented Interfaces:

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

public class WaterVelocity
extends IMCMessage

IMC Message Water Velocity (260)
Vector quantifying the direction and magnitude of the measured
velocity relative to the water that a device is exposed to.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_STATIC
static short	VAL_VEL_X
static short	VAL_VEL_Y
static short	VAL_VEL_Z

Fields inherited from class pt.up.fe.dceg.neptus.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
WaterVelocity()
WaterVelocity(IMCDefinition defs)
WaterVelocity(short validity, double x, double y, double z)

Method Summary

Methods

Modifier and Type	Method and Description
static WaterVelocity	clone(IMCMessage msg)
static WaterVelocity	create(java.lang.Object... values)
short	getValidity() Each bit of this field represents if a given velocity component is valid.
double	getX()
double	getY()
double	getZ()
void	setValidity(short validity)
void	setX(double x)
void	setY(double y)
void	setZ(double z)

Methods inherited from class pt.up.fe.dceg.neptus.imc.IMCMessage

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

Methods inherited from class java.lang.Object

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

Field Detail

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

VAL_VEL_X

public static final short VAL_VEL_X

See Also:

Constant Field Values

VAL_VEL_Y

public static final short VAL_VEL_Y

See Also:

Constant Field Values

VAL_VEL_Z

public static final short VAL_VEL_Z

See Also:

Constant Field Values

Constructor Detail

WaterVelocity

public WaterVelocity()

WaterVelocity

public WaterVelocity(IMCDefinition defs)

WaterVelocity

public WaterVelocity(short validity,
             double x,
             double y,
             double z)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getValidity

public short getValidity()

Each bit of this field represents if a given velocity
component is valid.

Returns:

Validity (bitfield) - uint8_t

getX

public double getX()

Returns:

X (m/s) - fp64_t

getY

public double getY()

Returns:

Y (m/s) - fp64_t

getZ

public double getZ()

Returns:

Z (m/s) - fp64_t

setValidity

public void setValidity(short validity)

Parameters:

validity - Validity (bitfield)

setX

public void setX(double x)

Parameters:

x - X (m/s)

setY

public void setY(double y)

Parameters:

y - Y (m/s)

setZ

public void setZ(double z)

Parameters:

z - Z (m/s)