pt.lsts.imc

Class AcousticNoise

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.AcousticNoise

All Implemented Interfaces:

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

public class AcousticNoise
extends IMCMessage

IMC Message Acoustic Noise (208)
Report on the conditions of the underwater medium, for when
acoustic diagnostics are enabled.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AcousticNoise.SUMMARY

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
AcousticNoise()
AcousticNoise(AcousticNoise.SUMMARY summary, short level)
AcousticNoise(IMCDefinition defs)

Method Summary

Modifier and Type	Method and Description
static AcousticNoise	clone(IMCMessage msg)
static AcousticNoise	create(java.lang.Object... values)
short	getLevel()
AcousticNoise.SUMMARY	getSummary() Noise level characterization.
void	setLevel(short level)
void	setSummary(AcousticNoise.SUMMARY summary)
void	setSummary(short summary)
void	setSummary(java.lang.String summary)

Methods inherited from class pt.lsts.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, makeImmutable, 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

Constructor Detail

AcousticNoise

public AcousticNoise()

AcousticNoise

public AcousticNoise(IMCDefinition defs)

AcousticNoise

public AcousticNoise(AcousticNoise.SUMMARY summary,
                     short level)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getSummary

public AcousticNoise.SUMMARY getSummary()

Noise level characterization.

Returns:

Summary (enumerated) - uint8_t

getLevel

public short getLevel()

Returns:

Noise Level (db) - uint8_t

setSummary

public void setSummary(AcousticNoise.SUMMARY summary)

Parameters:

summary - Summary (enumerated)

setSummary

public void setSummary(java.lang.String summary)

Parameters:

summary - Summary (as a String)

setSummary

public void setSummary(short summary)

Parameters:

summary - Summary (integer value)

setLevel

public void setLevel(short level)

Parameters:

level - Noise Level (db)