pt.lsts.imc

Class VerticalProfile

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.VerticalProfile

All Implemented Interfaces:

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

public class VerticalProfile
extends IMCMessage

IMC Message Vertical Profile (111)
This message is used to store historic profiles for water parameters: Temperature, Salinity, Chlorophyll...

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VerticalProfile.PARAMETER

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
VerticalProfile()
VerticalProfile(IMCDefinition defs)
VerticalProfile(IMCMessage msg)
VerticalProfile(VerticalProfile.PARAMETER parameter, short numSamples, java.util.Collection<ProfileSample> samples, double lat, double lon)

Method Summary

Modifier and Type	Method and Description
static VerticalProfile	clone(IMCMessage msg)
static VerticalProfile	create(java.lang.Object... values)
double	getLat()
double	getLon()
short	getNumSamples()
VerticalProfile.PARAMETER	getParameter()
java.lang.String	getParameterStr()
short	getParameterVal()
java.util.Vector<ProfileSample>	getSamples()
VerticalProfile	setLat(double lat)
VerticalProfile	setLon(double lon)
VerticalProfile	setNumSamples(short numSamples)
VerticalProfile	setParameter(VerticalProfile.PARAMETER parameter)
VerticalProfile	setParameterStr(java.lang.String parameter)
VerticalProfile	setParameterVal(short parameter)
VerticalProfile	setSamples(java.util.Collection<ProfileSample> samples)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asJSON, asMap, asXml, asXmlStripped, cloneMessage, cloneMessage, compareTo, copyFrom, copyToClipoard, 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, 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

VerticalProfile

public VerticalProfile()

VerticalProfile

public VerticalProfile(IMCMessage msg)

VerticalProfile

public VerticalProfile(IMCDefinition defs)

VerticalProfile

public VerticalProfile(VerticalProfile.PARAMETER parameter,
                       short numSamples,
                       java.util.Collection<ProfileSample> samples,
                       double lat,
                       double lon)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getParameter

public VerticalProfile.PARAMETER getParameter()

Returns:

Parameter (enumerated) - uint8_t

getParameterStr

public java.lang.String getParameterStr()

getParameterVal

public short getParameterVal()

setParameter

public VerticalProfile setParameter(VerticalProfile.PARAMETER parameter)

Parameters:

parameter - Parameter (enumerated)

setParameterStr

public VerticalProfile setParameterStr(java.lang.String parameter)

Parameters:

parameter - Parameter (as a String)

setParameterVal

public VerticalProfile setParameterVal(short parameter)

Parameters:

parameter - Parameter (integer value)

getNumSamples

public short getNumSamples()

Returns:

Number of Samples - uint8_t

setNumSamples

public VerticalProfile setNumSamples(short numSamples)

Parameters:

numSamples - Number of Samples

getSamples

public java.util.Vector<ProfileSample> getSamples()

Returns:

Samples - message-list

setSamples

public VerticalProfile setSamples(java.util.Collection<ProfileSample> samples)

Parameters:

samples - Samples

getLat

public double getLat()

Returns:

Latitude (rad) - fp64_t

setLat

public VerticalProfile setLat(double lat)

Parameters:

lat - Latitude (rad)

getLon

public double getLon()

Returns:

Longitude (rad) - fp64_t

setLon

public VerticalProfile setLon(double lon)

Parameters:

lon - Longitude (rad)