pt.lsts.imc

Class Magnetometer

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.Maneuver

pt.lsts.imc.Magnetometer

All Implemented Interfaces:

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

public class Magnetometer
extends Maneuver

IMC Message Magnetometer Maneuver (499)
Magnetometer calibration maneuver (i.e: one square pattern
in one direction, a second square in the opposite direction)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Magnetometer.DIRECTION

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_STATIC

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
Magnetometer()
Magnetometer(IMCDefinition defs)
Magnetometer(IMCMessage msg)
Magnetometer(int timeout, double lat, double lon, float z, pt.lsts.imc.def.ZUnits z_units, float speed, pt.lsts.imc.def.SpeedUnits speed_units, double bearing, float width, Magnetometer.DIRECTION direction, java.lang.String custom)

Method Summary

Modifier and Type	Method and Description
static Magnetometer	clone(IMCMessage msg)
static Magnetometer	create(java.lang.Object... values)
double	getBearing()
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getCustom()
Magnetometer.DIRECTION	getDirection()
java.lang.String	getDirectionStr()
short	getDirectionVal()
double	getLat()
double	getLon()
double	getSpeed()
pt.lsts.imc.def.SpeedUnits	getSpeedUnits()
java.lang.String	getSpeedUnitsStr()
short	getSpeedUnitsVal()
int	getTimeout()
double	getWidth()
double	getZ()
pt.lsts.imc.def.ZUnits	getZUnits()
java.lang.String	getZUnitsStr()
short	getZUnitsVal()
Magnetometer	setBearing(double bearing)
Magnetometer	setCustom(java.util.LinkedHashMap<java.lang.String,?> custom)
Magnetometer	setCustom(java.lang.String custom)
Magnetometer	setDirection(Magnetometer.DIRECTION direction)
Magnetometer	setDirectionStr(java.lang.String direction)
Magnetometer	setDirectionVal(short direction)
Magnetometer	setLat(double lat)
Magnetometer	setLon(double lon)
Magnetometer	setSpeed(double speed)
Magnetometer	setSpeedUnits(pt.lsts.imc.def.SpeedUnits speed_units)
Magnetometer	setSpeedUnitsStr(java.lang.String speed_units)
Magnetometer	setSpeedUnitsVal(short speed_units)
Magnetometer	setTimeout(int timeout)
Magnetometer	setWidth(double width)
Magnetometer	setZ(double z)
Magnetometer	setZUnits(pt.lsts.imc.def.ZUnits z_units)
Magnetometer	setZUnitsStr(java.lang.String z_units)
Magnetometer	setZUnitsVal(short z_units)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asJSON, asMap, asXml, asXmlStripped, cloneMessage, cloneMessage, cloneMessageTyped, cloneMessageTyped, compareTo, copyFrom, copyToClipoard, decodeTupleList, dump, encodeTupleList, get, getAbbrev, getAgeInSeconds, getAsNumber, getAsString, getBitmask, getDate, getDouble, getDst, getDstEnt, getEntityName, getFieldNames, getFloat, getHeader, getHeaderValue, getIMCDefinition, 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

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

Magnetometer

public Magnetometer()

Magnetometer

public Magnetometer(IMCMessage msg)

Magnetometer

public Magnetometer(IMCDefinition defs)

Magnetometer

public Magnetometer(int timeout,
                    double lat,
                    double lon,
                    float z,
                    pt.lsts.imc.def.ZUnits z_units,
                    float speed,
                    pt.lsts.imc.def.SpeedUnits speed_units,
                    double bearing,
                    float width,
                    Magnetometer.DIRECTION direction,
                    java.lang.String custom)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getTimeout

public int getTimeout()

Returns:

Timeout (s) - uint16_t

setTimeout

public Magnetometer setTimeout(int timeout)

Parameters:

timeout - Timeout (s)

getLat

public double getLat()

Returns:

Latitude WGS-84 (rad) - fp64_t

setLat

public Magnetometer setLat(double lat)

Parameters:

lat - Latitude WGS-84 (rad)

getLon

public double getLon()

Returns:

Longitude WGS-84 (rad) - fp64_t

setLon

public Magnetometer setLon(double lon)

Parameters:

lon - Longitude WGS-84 (rad)

getZ

public double getZ()

Returns:

Z Reference (m) - fp32_t

setZ

public Magnetometer setZ(double z)

Parameters:

z - Z Reference (m)

getZUnits

public pt.lsts.imc.def.ZUnits getZUnits()

Returns:

Z Units (enumerated) - uint8_t

getZUnitsStr

public java.lang.String getZUnitsStr()

getZUnitsVal

public short getZUnitsVal()

setZUnits

public Magnetometer setZUnits(pt.lsts.imc.def.ZUnits z_units)

Parameters:

z_units - Z Units (enumerated)

setZUnitsStr

public Magnetometer setZUnitsStr(java.lang.String z_units)

Parameters:

z_units - Z Units (as a String)

setZUnitsVal

public Magnetometer setZUnitsVal(short z_units)

Parameters:

z_units - Z Units (integer value)

getSpeed

public double getSpeed()

Returns:

Speed - fp32_t

setSpeed

public Magnetometer setSpeed(double speed)

Parameters:

speed - Speed

getSpeedUnits

public pt.lsts.imc.def.SpeedUnits getSpeedUnits()

Returns:

Speed Units (enumerated) - uint8_t

getSpeedUnitsStr

public java.lang.String getSpeedUnitsStr()

getSpeedUnitsVal

public short getSpeedUnitsVal()

setSpeedUnits

public Magnetometer setSpeedUnits(pt.lsts.imc.def.SpeedUnits speed_units)

Parameters:

speed_units - Speed Units (enumerated)

setSpeedUnitsStr

public Magnetometer setSpeedUnitsStr(java.lang.String speed_units)

Parameters:

speed_units - Speed Units (as a String)

setSpeedUnitsVal

public Magnetometer setSpeedUnitsVal(short speed_units)

Parameters:

speed_units - Speed Units (integer value)

getBearing

public double getBearing()

Returns:

Bearing (rad) - fp64_t

setBearing

public Magnetometer setBearing(double bearing)

Parameters:

bearing - Bearing (rad)

getWidth

public double getWidth()

Returns:

Width (m) - fp32_t

setWidth

public Magnetometer setWidth(double width)

Parameters:

width - Width (m)

getDirection

public Magnetometer.DIRECTION getDirection()

Returns:

Direction (enumerated) - uint8_t

getDirectionStr

public java.lang.String getDirectionStr()

getDirectionVal

public short getDirectionVal()

setDirection

public Magnetometer setDirection(Magnetometer.DIRECTION direction)

Parameters:

direction - Direction (enumerated)

setDirectionStr

public Magnetometer setDirectionStr(java.lang.String direction)

Parameters:

direction - Direction (as a String)

setDirectionVal

public Magnetometer setDirectionVal(short direction)

Parameters:

direction - Direction (integer value)

getCustom

public java.util.LinkedHashMap<java.lang.String,java.lang.String> getCustom()

Returns:

Custom settings for maneuver (tuplelist) - plaintext

setCustom

public Magnetometer setCustom(java.util.LinkedHashMap<java.lang.String,?> custom)

Parameters:

custom - Custom settings for maneuver (tuplelist)

setCustom

public Magnetometer setCustom(java.lang.String custom)