pt.lsts.imc

Class MapFeature

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.MapFeature

All Implemented Interfaces:

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

public class MapFeature
extends IMCMessage

IMC Message Map Feature (603)
A feature to appear on the map

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapFeature.FEATURE_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
MapFeature()
MapFeature(IMCDefinition defs)
MapFeature(IMCMessage msg)
MapFeature(java.lang.String id, MapFeature.FEATURE_TYPE feature_type, short rgb_red, short rgb_green, short rgb_blue, java.util.Collection<MapPoint> feature)

Method Summary

Modifier and Type	Method and Description
static MapFeature	clone(IMCMessage msg)
static MapFeature	create(java.lang.Object... values)
java.util.Vector<MapPoint>	getFeature()
MapFeature.FEATURE_TYPE	getFeatureType()
java.lang.String	getFeatureTypeStr()
short	getFeatureTypeVal()
java.lang.String	getId()
short	getRgbBlue()
short	getRgbGreen()
short	getRgbRed()
MapFeature	setFeature(java.util.Collection<MapPoint> feature)
MapFeature	setFeatureType(MapFeature.FEATURE_TYPE feature_type)
MapFeature	setFeatureTypeStr(java.lang.String feature_type)
MapFeature	setFeatureTypeVal(short feature_type)
MapFeature	setId(java.lang.String id)
MapFeature	setRgbBlue(short rgb_blue)
MapFeature	setRgbGreen(short rgb_green)
MapFeature	setRgbRed(short rgb_red)

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

MapFeature

public MapFeature()

MapFeature

public MapFeature(IMCMessage msg)

MapFeature

public MapFeature(IMCDefinition defs)

MapFeature

public MapFeature(java.lang.String id,
                  MapFeature.FEATURE_TYPE feature_type,
                  short rgb_red,
                  short rgb_green,
                  short rgb_blue,
                  java.util.Collection<MapPoint> feature)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getId

public java.lang.String getId()

Returns:

Identifier - plaintext

setId

public MapFeature setId(java.lang.String id)

Parameters:

id - Identifier

getFeatureType

public MapFeature.FEATURE_TYPE getFeatureType()

Returns:

FeatureType (enumerated) - uint8_t

getFeatureTypeStr

public java.lang.String getFeatureTypeStr()

getFeatureTypeVal

public short getFeatureTypeVal()

setFeatureType

public MapFeature setFeatureType(MapFeature.FEATURE_TYPE feature_type)

Parameters:

feature_type - FeatureType (enumerated)

setFeatureTypeStr

public MapFeature setFeatureTypeStr(java.lang.String feature_type)

Parameters:

feature_type - FeatureType (as a String)

setFeatureTypeVal

public MapFeature setFeatureTypeVal(short feature_type)

Parameters:

feature_type - FeatureType (integer value)

getRgbRed

public short getRgbRed()

Returns:

RedComponent - uint8_t

setRgbRed

public MapFeature setRgbRed(short rgb_red)

Parameters:

rgb_red - RedComponent

getRgbGreen

public short getRgbGreen()

Returns:

GreenComponent - uint8_t

setRgbGreen

public MapFeature setRgbGreen(short rgb_green)

Parameters:

rgb_green - GreenComponent

getRgbBlue

public short getRgbBlue()

Returns:

BlueComponent - uint8_t

setRgbBlue

public MapFeature setRgbBlue(short rgb_blue)

Parameters:

rgb_blue - BlueComponent

getFeature

public java.util.Vector<MapPoint> getFeature()

Returns:

Feature - message-list

setFeature

public MapFeature setFeature(java.util.Collection<MapPoint> feature)

Parameters:

feature - Feature