pt.lsts.imc

Class MagneticField

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.MagneticField

All Implemented Interfaces:

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

public class MagneticField
extends IMCMessage

IMC Message Magnetic Field (258)
Vector quantifying the direction and magnitude of the measured
magnetic field that a device is exposed to.

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
MagneticField()
MagneticField(double time, double x, double y, double z)
MagneticField(IMCDefinition defs)
MagneticField(IMCMessage msg)

Method Summary

Modifier and Type	Method and Description
static MagneticField	clone(IMCMessage msg)
static MagneticField	create(java.lang.Object... values)
double	getTime()
double	getX()
double	getY()
double	getZ()
MagneticField	setTime(double time)
MagneticField	setX(double x)
MagneticField	setY(double y)
MagneticField	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

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

MagneticField

public MagneticField()

MagneticField

public MagneticField(IMCMessage msg)

MagneticField

public MagneticField(IMCDefinition defs)

MagneticField

public MagneticField(double time,
                     double x,
                     double y,
                     double z)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getTime

public double getTime()

Returns:

Device Time (s) - fp64_t

setTime

public MagneticField setTime(double time)

Parameters:

time - Device Time (s)

getX

public double getX()

Returns:

X (g) - fp64_t

setX

public MagneticField setX(double x)

Parameters:

x - X (g)

getY

public double getY()

Returns:

Y (g) - fp64_t

setY

public MagneticField setY(double y)

Parameters:

y - Y (g)

getZ

public double getZ()

Returns:

Z (g) - fp64_t

setZ

public MagneticField setZ(double z)

Parameters:

z - Z (g)