pt.lsts.imc

Class ControlLoops

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.ControlLoops

All Implemented Interfaces:

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

public class ControlLoops
extends IMCMessage

IMC Message Control Loops (507)
Enable or disable control loops.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControlLoops.ENABLE

Field Summary

Fields

Modifier and Type	Field and Description
static long	CL_ALL
static long	CL_ALTITUDE
static long	CL_DEPTH
static long	CL_EXTERNAL
static long	CL_NO_OVERRIDE
static long	CL_NONE
static long	CL_PATH
static long	CL_PITCH
static long	CL_ROLL
static long	CL_SPEED
static long	CL_TELEOPERATION
static long	CL_TORQUE
static long	CL_VERTICAL_RATE
static long	CL_YAW
static long	CL_YAW_RATE
static int	ID_STATIC

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
ControlLoops()
ControlLoops(ControlLoops.ENABLE enable, long mask, long scope_ref)
ControlLoops(IMCDefinition defs)
ControlLoops(IMCMessage msg)

Method Summary

Modifier and Type	Method and Description
static ControlLoops	clone(IMCMessage msg)
static ControlLoops	create(java.lang.Object... values)
ControlLoops.ENABLE	getEnable()
long	getMask() Control loop mask.
long	getScopeRef()
ControlLoops	setEnable(ControlLoops.ENABLE enable)
ControlLoops	setEnable(short enable)
ControlLoops	setEnable(java.lang.String enable)
ControlLoops	setMask(long mask)
ControlLoops	setScopeRef(long scope_ref)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asXml, cloneMessage, cloneMessage, compareTo, copyFrom, 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, getValues, hasFlag, hexdump, isNull, isPeriodic, main, makeImmutable, parseXml, payloadMD5, serialize, serialize, setBitMask, setDst, setDstEnt, setHeader, 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

CL_NONE

public static final long CL_NONE

See Also:

Constant Field Values

CL_PATH

public static final long CL_PATH

See Also:

Constant Field Values

CL_TELEOPERATION

public static final long CL_TELEOPERATION

See Also:

Constant Field Values

CL_ALTITUDE

public static final long CL_ALTITUDE

See Also:

Constant Field Values

CL_DEPTH

public static final long CL_DEPTH

See Also:

Constant Field Values

CL_ROLL

public static final long CL_ROLL

See Also:

Constant Field Values

CL_PITCH

public static final long CL_PITCH

See Also:

Constant Field Values

CL_YAW

public static final long CL_YAW

See Also:

Constant Field Values

CL_SPEED

public static final long CL_SPEED

See Also:

Constant Field Values

CL_YAW_RATE

public static final long CL_YAW_RATE

See Also:

Constant Field Values

CL_VERTICAL_RATE

public static final long CL_VERTICAL_RATE

See Also:

Constant Field Values

CL_TORQUE

public static final long CL_TORQUE

See Also:

Constant Field Values

CL_EXTERNAL

public static final long CL_EXTERNAL

See Also:

Constant Field Values

CL_NO_OVERRIDE

public static final long CL_NO_OVERRIDE

See Also:

Constant Field Values

CL_ALL

public static final long CL_ALL

See Also:

Constant Field Values

Constructor Detail

ControlLoops

public ControlLoops()

ControlLoops

public ControlLoops(IMCMessage msg)

ControlLoops

public ControlLoops(IMCDefinition defs)

ControlLoops

public ControlLoops(ControlLoops.ENABLE enable,
                    long mask,
                    long scope_ref)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getEnable

public ControlLoops.ENABLE getEnable()

Returns:

Enable (enumerated) - uint8_t

getMask

public long getMask()

Control loop mask.

Returns:

Control Loop Mask (bitfield) - uint32_t

getScopeRef

public long getScopeRef()

Returns:

Scope Time Reference - uint32_t

setEnable

public ControlLoops setEnable(ControlLoops.ENABLE enable)

Parameters:

enable - Enable (enumerated)

setEnable

public ControlLoops setEnable(java.lang.String enable)

Parameters:

enable - Enable (as a String)

setEnable

public ControlLoops setEnable(short enable)

Parameters:

enable - Enable (integer value)

setMask

public ControlLoops setMask(long mask)

Parameters:

mask - Control Loop Mask (bitfield)

setScopeRef

public ControlLoops setScopeRef(long scope_ref)

Parameters:

scope_ref - Scope Time Reference