pt.lsts.imc

Class SonarData

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.SonarData

All Implemented Interfaces:

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

public class SonarData
extends IMCMessage

IMC Message Sonar Data (276)
This message contains the data acquired by a single sonar
measurement.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SonarData.TYPE

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
SonarData()
SonarData(IMCDefinition defs)
SonarData(IMCMessage msg)
SonarData(SonarData.TYPE type, long frequency, int min_range, int max_range, short bits_per_point, float scale_factor, java.util.Collection<BeamConfig> beam_config, byte[] data)

Method Summary

Modifier and Type	Method and Description
static SonarData	clone(IMCMessage msg)
static SonarData	create(java.lang.Object... values)
java.util.Vector<BeamConfig>	getBeamConfig()
short	getBitsPerPoint()
byte[]	getData()
long	getFrequency()
int	getMaxRange()
int	getMinRange()
double	getScaleFactor()
SonarData.TYPE	getType()
java.lang.String	getTypeStr()
short	getTypeVal()
SonarData	setBeamConfig(java.util.Collection<BeamConfig> beam_config)
SonarData	setBitsPerPoint(short bits_per_point)
SonarData	setData(byte[] data)
SonarData	setFrequency(long frequency)
SonarData	setMaxRange(int max_range)
SonarData	setMinRange(int min_range)
SonarData	setScaleFactor(double scale_factor)
SonarData	setType(SonarData.TYPE type)
SonarData	setTypeStr(java.lang.String type)
SonarData	setTypeVal(short type)

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

SonarData

public SonarData()

SonarData

public SonarData(IMCMessage msg)

SonarData

public SonarData(IMCDefinition defs)

SonarData

public SonarData(SonarData.TYPE type,
                 long frequency,
                 int min_range,
                 int max_range,
                 short bits_per_point,
                 float scale_factor,
                 java.util.Collection<BeamConfig> beam_config,
                 byte[] data)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getType

public SonarData.TYPE getType()

Returns:

Type (enumerated) - uint8_t

getTypeStr

public java.lang.String getTypeStr()

getTypeVal

public short getTypeVal()

setType

public SonarData setType(SonarData.TYPE type)

Parameters:

type - Type (enumerated)

setTypeStr

public SonarData setTypeStr(java.lang.String type)

Parameters:

type - Type (as a String)

setTypeVal

public SonarData setTypeVal(short type)

Parameters:

type - Type (integer value)

getFrequency

public long getFrequency()

Returns:

Frequency (hz) - uint32_t

setFrequency

public SonarData setFrequency(long frequency)

Parameters:

frequency - Frequency (hz)

getMinRange

public int getMinRange()

Returns:

Minimum Range (m) - uint16_t

setMinRange

public SonarData setMinRange(int min_range)

Parameters:

min_range - Minimum Range (m)

getMaxRange

public int getMaxRange()

Returns:

Maximum Range (m) - uint16_t

setMaxRange

public SonarData setMaxRange(int max_range)

Parameters:

max_range - Maximum Range (m)

getBitsPerPoint

public short getBitsPerPoint()

Returns:

Bits Per Data Point (bit) - uint8_t

setBitsPerPoint

public SonarData setBitsPerPoint(short bits_per_point)

Parameters:

bits_per_point - Bits Per Data Point (bit)

getScaleFactor

public double getScaleFactor()

Returns:

Scaling Factor - fp32_t

setScaleFactor

public SonarData setScaleFactor(double scale_factor)

Parameters:

scale_factor - Scaling Factor

getBeamConfig

public java.util.Vector<BeamConfig> getBeamConfig()

Returns:

Beam Configuration - message-list

setBeamConfig

public SonarData setBeamConfig(java.util.Collection<BeamConfig> beam_config)

Parameters:

beam_config - Beam Configuration

getData

public byte[] getData()

Returns:

Data - rawdata

setData

public SonarData setData(byte[] data)

Parameters:

data - Data