pt.up.fe.dceg.neptus.imc

Class MapFeature

java.lang.Object

pt.up.fe.dceg.neptus.imc.IMCMessage

pt.up.fe.dceg.neptus.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.up.fe.dceg.neptus.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
MapFeature()
MapFeature(IMCDefinition defs)
MapFeature(java.lang.String id, short feature_type, short rgb_red, short rgb_green, short rgb_blue, java.util.Collection<MapPoint> feature)

Method Summary

Methods

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() The type of feature
java.lang.String	getId()
short	getRgbBlue()
short	getRgbGreen()
short	getRgbRed()
void	setFeature(java.util.Collection<MapPoint> feature)
void	setFeatureType(MapFeature.FEATURE_TYPE feature_type)
void	setFeatureType(short feature_type)
void	setFeatureType(java.lang.String feature_type)
void	setId(java.lang.String id)
void	setRgbBlue(short rgb_blue)
void	setRgbGreen(short rgb_green)
void	setRgbRed(short rgb_red)

Methods inherited from class pt.up.fe.dceg.neptus.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, 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

MapFeature

public MapFeature()

MapFeature

public MapFeature(IMCDefinition defs)

MapFeature

public MapFeature(java.lang.String id,
          short 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

getFeatureType

public MapFeature.FEATURE_TYPE getFeatureType()

The type of feature

Returns:

FeatureType (enumerated) - uint8_t

getRgbRed

public short getRgbRed()

Returns:

RedComponent - uint8_t

getRgbGreen

public short getRgbGreen()

Returns:

GreenComponent - uint8_t

getRgbBlue

public short getRgbBlue()

Returns:

BlueComponent - uint8_t

getFeature

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

Returns:

Feature - message-list

setId

public void setId(java.lang.String id)

Parameters:

id - Identifier

setFeatureType

public void setFeatureType(MapFeature.FEATURE_TYPE feature_type)

Parameters:

feature_type - FeatureType (enumerated)

setFeatureType

public void setFeatureType(java.lang.String feature_type)

Parameters:

feature_type - FeatureType (as a String)

setFeatureType

public void setFeatureType(short feature_type)

Parameters:

feature_type - FeatureType (integer value)

setRgbRed

public void setRgbRed(short rgb_red)

Parameters:

rgb_red - RedComponent

setRgbGreen

public void setRgbGreen(short rgb_green)

Parameters:

rgb_green - GreenComponent

setRgbBlue

public void setRgbBlue(short rgb_blue)

Parameters:

rgb_blue - BlueComponent

setFeature

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

Parameters:

feature - Feature