pt.lsts.imc

Class DesiredControl

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.DesiredControl

All Implemented Interfaces:

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

public class DesiredControl
extends IMCMessage

IMC Message Desired Control (407)
Set the desired virtual forces and torques to be applied to the
vehicle.

Field Summary

Fields

Modifier and Type	Field and Description
static short	FL_K
static short	FL_M
static short	FL_N
static short	FL_X
static short	FL_Y
static short	FL_Z
static int	ID_STATIC

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
DesiredControl()
DesiredControl(double x, double y, double z, double k, double m, double n, short flags)
DesiredControl(IMCDefinition defs)
DesiredControl(IMCMessage msg)

Method Summary

Modifier and Type	Method and Description
static DesiredControl	clone(IMCMessage msg)
static DesiredControl	create(java.lang.Object... values)
short	getFlags()
double	getK()
double	getM()
double	getN()
double	getX()
double	getY()
double	getZ()
DesiredControl	setFlags(short flags)
DesiredControl	setK(double k)
DesiredControl	setM(double m)
DesiredControl	setN(double n)
DesiredControl	setX(double x)
DesiredControl	setY(double y)
DesiredControl	setZ(double z)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asJSON, asMap, asXml, asXmlStripped, cloneMessage, cloneMessage, compareTo, copyFrom, 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, main, makeImmutable, parseJson, parseXml, payloadMD5, serialize, serialize, serialize, serializePayload, setBitMask, setDst, setDstEnt, setHeader, setMessageInfo, 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

FL_X

public static final short FL_X

See Also:

Constant Field Values

FL_Y

public static final short FL_Y

See Also:

Constant Field Values

FL_Z

public static final short FL_Z

See Also:

Constant Field Values

FL_K

public static final short FL_K

See Also:

Constant Field Values

FL_M

public static final short FL_M

See Also:

Constant Field Values

FL_N

public static final short FL_N

See Also:

Constant Field Values

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

DesiredControl

public DesiredControl()

DesiredControl

public DesiredControl(IMCMessage msg)

DesiredControl

public DesiredControl(IMCDefinition defs)

DesiredControl

public DesiredControl(double x,
                      double y,
                      double z,
                      double k,
                      double m,
                      double n,
                      short flags)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getX

public double getX()

Returns:

Force along the x axis (n) - fp64_t

setX

public DesiredControl setX(double x)

Parameters:

x - Force along the x axis (n)

getY

public double getY()

Returns:

Force along the y axis (n) - fp64_t

setY

public DesiredControl setY(double y)

Parameters:

y - Force along the y axis (n)

getZ

public double getZ()

Returns:

Force along the z axis (n) - fp64_t

setZ

public DesiredControl setZ(double z)

Parameters:

z - Force along the z axis (n)

getK

public double getK()

Returns:

Torque about the x axis (nm) - fp64_t

setK

public DesiredControl setK(double k)

Parameters:

k - Torque about the x axis (nm)

getM

public double getM()

Returns:

Torque about the y axis (nm) - fp64_t

setM

public DesiredControl setM(double m)

Parameters:

m - Torque about the y axis (nm)

getN

public double getN()

Returns:

Torque about the z axis (nm) - fp64_t

setN

public DesiredControl setN(double n)

Parameters:

n - Torque about the z axis (nm)

getFlags

public short getFlags()

Returns:

Flags (bitfield) - uint8_t

setFlags

public DesiredControl setFlags(short flags)

Parameters:

flags - Flags (bitfield)