IMCMessage

java.lang.Object
- pt.lsts.imc.IMCMessage

All Implemented Interfaces:

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

Direct Known Subclasses:

Abort, Aborted, Acceleration, AcousticMessage, AcousticOperation, AcousticSystems, AcousticSystemsQuery, AlignmentState, AllocatedControlTorques, AngularVelocity, Announce, AnnounceService, AutopilotMode, BeamConfig, Brake, ButtonEvent, CacheControl, Calibration, CameraZoom, CcuEvent, ClockControl, CloseSession, Collision, CompressedImage, Conductivity, ControlCommand, ControlLoops, ControlParcel, CpuUsage, CreateSession, CrudeOil, Current, DataSanity, Depth, DepthOffset, DesiredControl, DesiredHeadingRate, DesiredVelocity, DesiredVerticalRate, DevCalibrationControl, DevCalibrationState, DevDataBinary, DevDataText, DeviceState, Distance, DvlRejection, DynamicsSimParam, EmergencyControl, EmergencyControlState, EntityActivationState, EntityInfo, EntityList, EntityMonitoringState, EntityParameter, EntityParameters, EntityState, EstimatedState, EstimatedStreamVelocity, EulerAngles, EulerAnglesDelta, Event, FineOil, FollowRefState, FollowSystem, Formation, FormationControlParams, FormationEval, FormationEvaluation, FormationMonitor, FormationParameters, FormationState, FormCtrlParam, FormState, FuelLevel, GetOperationalLimits, GetParametersXml, GpsFix, GpsFixRejection, GpsNavData, GroundVelocity, GroupMembershipState, GroupStreamVelocity, Header, Heartbeat, ImageTxSettings, IndicatedSpeed, IoEvent, IridiumMsgRx, IridiumMsgTx, IridiumTxStatus, LblBeacon, LblConfig, LblEstimate, LblRange, LblRangeAcceptance, LcdControl, LeaderState, LeakSimulation, LedBrightness, LinkLevel, LogBookControl, LogBookEntry, LoggingControl, MagneticField, Maneuver, ManeuverControlState, Map, MapFeature, MapPoint, MessagePart, MonitorEntityState, MsgList, NavigationData, NavigationUncertainty, NeptusBlob, OperationalLimits, ParametersXml, PathControlState, PathPoint, PlanControl, PlanControlState, PlanDB, PlanDBInformation, PlanDBState, PlanGeneration, PlanManeuver, PlanSpecification, PlanStatistics, PlanTransition, PlanVariable, PolygonVertex, PopEntityParameters, PowerChannelControl, PowerChannelState, PowerOperation, Pressure, Pulse, PulseDetectionControl, PushEntityParameters, PWM, QueryEntityActivationState, QueryEntityInfo, QueryEntityParameters, QueryEntityState, QueryLedBrightness, QueryPowerChannelState, Reference, RegisterManeuver, RelativeHumidity, RelativeState, RemoteActions, RemoteActionsRequest, RemoteSensorInfo, RemoteState, ReplayControl, ReportedState, RestartSystem, RhodamineDye, Rpm, RSSI, Salinity, SaveEntityParameters, ServoPosition, SessionKeepAlive, SessionStatus, SessionSubscription, SetControlSurfaceDeflection, SetEntityParameters, SetLedBrightness, SetPWM, SetServoPosition, SetThrusterActuation, SimulatedState, Sms, SmsRx, SmsState, SmsTx, SonarData, SoundSpeed, StopManeuver, StorageUsage, SystemGroup, Target, TeleoperationDone, Temperature, TextMessage, TrajectoryPoint, TransportBindings, TrexAttribute, TrexCommand, TrexObservation, TrexOperation, TrexPlan, TrexToken, TrueSpeed, Turbidity, UamRxFrame, UamRxRange, UamTxFrame, UamTxStatus, UASimulation, UsblAngles, UsblFix, UsblPosition, VehicleCommand, VehicleFormationParticipant, VehicleLinks, VehicleMedium, VehicleOperationalLimits, VehicleState, VelocityDelta, Voltage, VSWR, WaterDensity, WaterVelocity, WindSpeed
```
public class IMCMessage
extends java.lang.Object
implements IMessage, java.lang.Comparable<IMCMessage>
```
This class holds a message structure, including header and payload.
The message structure can be accessed with getMessageType() and header with getHeader()

Author:

zp

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_ENTITY_ID

static int DEFAULT_SYSTEM_ID

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_ENTITY_ID`
`static int`	`DEFAULT_SYSTEM_ID`

Constructor Summary

Constructors
Constructor and Description
`IMCMessage()` Creates a new (dummy) message
`IMCMessage(Header header)` Creates a new message based on an existing header and using default IMC definitions
`IMCMessage(IMCDefinition defs, IMCMessageType type)` Creates a new message given its type.
`IMCMessage(IMCMessageType type)` Creates a new IMCMessage given its type and using default IMC definitions
`IMCMessage(java.lang.Integer type)` Uses the default IMC definitions and calls `IMCMessage(IMCDefinition, Integer)`
`IMCMessage(java.lang.String abbreviatedName)` Resolves the type, given an abbreviated name and creates a corresponding message using default IMC definitions
`IMCMessage(java.lang.String abbreviatedName, java.lang.Object... values)` Creates a new message given its abbreviated name and fills it with given values

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`asJSON()` Retrieve this message as a JSON string
`java.lang.String`	`asJSON(boolean includeHeader)`
`java.util.Map<java.lang.String,java.lang.Object>`	`asMap(boolean inner)`
`java.lang.String`	`asXml(boolean isInline)`
`java.lang.String`	`asXmlStripped(int tabAmount, boolean isInline)`
`IMCMessage`	`cloneMessage()` Creates a cloned message with copied values
`IMCMessage`	`cloneMessage(IMCDefinition defs)` Create a copy of this message using the given definitions.
`int`	`compareTo(IMCMessage arg0)` Natural order uses the timestamp of the message for comparison
`IMCMessage`	`copyFrom(IMCMessage otherMessage)` Set all values from another message of same type
`static java.util.LinkedHashMap<java.lang.String,java.lang.String>`	`decodeTupleList(java.lang.String tupleList)` Reverse from `encodeTupleList(LinkedHashMap)`
`void`	`dump(java.io.OutputStream err)` Write this message as text into the given OutputStream.
`static java.lang.String`	`encodeTupleList(java.util.LinkedHashMap<java.lang.String,?> map)` Given a map of Strings to Objects, encodes a tuplelist in the type: name1=value1;name2=value2 ...
`<T> T`	`get(java.lang.String field, java.lang.Class<T> type)`
`java.lang.String`	`getAbbrev()`
`double`	`getAgeInSeconds()` Calculates the difference between current time and the timestamp in this message
`java.lang.Number`	`getAsNumber(java.lang.String fieldName)` Retrieve the value of the field as a Number
`java.lang.String`	`getAsString(java.lang.String fieldName)` Retrieve the value of a field as a String
`java.util.LinkedHashMap<java.lang.String,java.lang.Boolean>`	`getBitmask(java.lang.String field)` Retrieves the value of a Bitmask as map of booleans
`java.util.Date`	`getDate()` Retrieve the timestamp of this message as a Date
`double`	`getDouble(java.lang.String field)` Retrives the value of a field as a double value.
`int`	`getDst()` The numeric id of this message destination (header field "dst")
`short`	`getDstEnt()` Retrieve IMC id of this message destination entity (header field "dst_ent")
`java.lang.String`	`getEntityName()`
`java.lang.String[]`	`getFieldNames()`
`float`	`getFloat(java.lang.String field)` Retrives the value of a field as a float value.
`Header`	`getHeader()` Retrieves the header of this message, stored as an inner IMC Message (payload fields match header fields and header is NULL)
`java.lang.Object`	`getHeaderValue(java.lang.String field)` Retrieve a value from the header
`int`	`getInteger(java.lang.String field)` Retrives the value of a field as an integer value.
`long`	`getLong(java.lang.String field)` Retrives the value of a field as a long value.
`java.lang.String`	`getLongFieldName(java.lang.String fieldName)` Retrieve the long name (human readable) of a given field
`java.lang.String`	`getLongName()`
`<T extends IMCMessage> T`	`getMessage(java.lang.Class<T> clazz, java.lang.String field)` Retrieves an IMCMessage from a field and converts it to a chosen type. Example:
`IMCMessage`	`getMessage(java.lang.String field)` Retrieves an IMCMesssage from a field (used for inline messages)
`pt.lsts.neptus.messages.listener.MessageInfo`	`getMessageInfo()`
`java.util.Vector<IMCMessage>`	`getMessageList(java.lang.String field)` Retrieve all the messages in a MessageList as a Vector
`<T extends IMCMessage> java.util.Vector<T>`	`getMessageList(java.lang.String field, java.lang.Class<T> clazz)` Retrieve a message list from this message using a given type
`IMCMessageType`	`getMessageType()`
`int`	`getMgid()`
`int`	`getPayloadSize()`
`IMessageProtocol<? extends IMessage>`	`getProtocolFactory()`
`byte[]`	`getRawData(java.lang.String field)` Returns a byte array from a rawdata field
`int`	`getSize()` Retrieve the size indicated on the header of this message (header field "size")
`java.lang.String`	`getSourceName()`
`int`	`getSrc()` Retrieve IMC id of this message source (header field "src")
`short`	`getSrcEnt()` Retrieve IMC id of this message source entity (header field "src_ent")
`java.lang.String`	`getString(java.lang.String field)` Returns a String representation for the value in the given field
`java.lang.String`	`getString(java.lang.String field, boolean addUnits)`
`double`	`getTimestamp()`
`long`	`getTimestampMillis()`
`java.util.LinkedHashMap<java.lang.String,java.lang.String>`	`getTupleList(java.lang.String field)` Returns the value of a field as an hash map
`java.lang.String`	`getTypeOf(java.lang.String fieldName)` Retrieve the field type of the given field
`java.lang.String`	`getUnitsOf(java.lang.String fieldName)` Retrieves the units of the given field
`java.lang.Object`	`getValue(java.lang.String field)` Retrieve a value in the message
`java.util.Map<java.lang.String,java.lang.Object>`	`getValues()` Returns all the values in this message.
`boolean`	`hasFlag(java.lang.String flagName)` Verify if the message has the given flag set
`void`	`hexdump(java.io.OutputStream err)`
`boolean`	`isNull()` Check in this is a null inline message
`boolean`	`isPeriodic()`
`static void`	`main(java.lang.String[] args)`
`void`	`makeImmutable()` This method enforces all values in this message as immutable.
`static IMCMessage`	`parseJson(java.lang.String json)`
`static IMCMessage`	`parseXml(java.lang.String xml)` Parse an IMC-XML file and retrieve the messages found on the file
`byte[]`	`payloadMD5()` Compute this message's payload MD5
`int`	`serialize(java.nio.ByteBuffer destination, int offset)`
`int`	`serialize(IMCDefinition def, IMCOutputStream out)` Writes this message to an OutputStream
`int`	`serialize(IMCOutputStream out)` Serialize this message to an IMCOutputStream
`int`	`serializePayload(java.nio.ByteBuffer destination, int offset)`
`void`	`setBitMask(java.lang.String field, java.util.LinkedHashMap<java.lang.String,java.lang.Boolean> bitmask)` Set the value of a bitmask field using a map from Strings to Booleans
`void`	`setDst(int dst)` Set the destination of this message (header field "dst")
`void`	`setDstEnt(int dst_ent)` Set the destination entity of this message (header field "dst_ent")
`void`	`setHeader(Header header)` Change the header of this message
`void`	`setMessageInfo(pt.lsts.neptus.messages.listener.MessageInfo messageInfo)`
`void`	`setMessageList(java.util.Vector<? extends IMCMessage> messages, java.lang.String field)` This method receives a vector of messages and sets a field with a MessageList of those messages
`void`	`setSrc(int src)` Set the source of this message (header field "src")
`void`	`setSrcEnt(int src_ent)` Set the source entity of this message (header field "src_ent")
`void`	`setTimestamp(double time)` Change the timestamp of this message (stored in the header field "time")
`void`	`setTimestampMillis(long timestampMillis)`
`void`	`setType(IMCMessageType type)` Change the type of the message.
`IMCMessage`	`setValue(java.lang.String field, java.lang.Object value)` Sets a field value
`void`	`setValues(java.util.Map<java.lang.String,java.lang.Object> values)` All the values in the given hashtable will be copied to this message without any conversions
`java.lang.String`	`toString()` Returns a String representation of this message (used for debugging)
`void`	`validate()` Verifies if the message is valid by generating exceptions when the message is not valid

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_ENTITY_ID
```
public static final int DEFAULT_ENTITY_ID
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SYSTEM_ID
```
public static final int DEFAULT_SYSTEM_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IMCMessage
```
public IMCMessage()
```
    Creates a new (dummy) message
  - IMCMessage
```
public IMCMessage(IMCMessageType type)
```
    Creates a new IMCMessage given its type and using default IMC definitions
    
    Parameters:
    
    type - The IMCMessageType of the message to be created
  - IMCMessage
```
public IMCMessage(Header header)
```
    Creates a new message based on an existing header and using default IMC definitions
    
    Parameters:
    
    header - The header of the message, which will define its type
  - IMCMessage
```
public IMCMessage(java.lang.Integer type)
```
    Uses the default IMC definitions and calls IMCMessage(IMCDefinition, Integer)
    
    Parameters:
    
    type - The type (mgid) of the message to be created
  - IMCMessage
```
public IMCMessage(java.lang.String abbreviatedName)
```
    Resolves the type, given an abbreviated name and creates a corresponding message using default IMC definitions
    
    Parameters:
    
    abbreviatedName - The abbreviated name of the message to be created
  - IMCMessage
```
public IMCMessage(java.lang.String abbreviatedName,
                  java.lang.Object... values)
```
    Creates a new message given its abbreviated name and fills it with given values
    Parameters:
    
    abbreviatedName - The message's abbreviated name
    values - A list of objects which will be parse in pairs.
    Example:
    IMCMessage state = new IMCMessage("EstimatedState", "ref", "NED_ONLY", "x", 10.343, y, -100);
  - IMCMessage
```
public IMCMessage(IMCDefinition defs,
                  IMCMessageType type)
```
    Creates a new message given its type.
    If it's not an header, an empty header will be added.
    
    Parameters:
    
    type - The type for this message.
- Method Detail
  - getMessageType
```
public final IMCMessageType getMessageType()
```
    Returns:
    
    The message type for this message
  - getHeader
```
public Header getHeader()
```
    Retrieves the header of this message, stored as an inner IMC Message (payload fields match header fields and header is NULL)
    
    Returns:
    
    The header of this message
  - setHeader
```
public void setHeader(Header header)
```
    Change the header of this message
    
    Parameters:
    
    header - The new header for this message
  - copyFrom
```
public IMCMessage copyFrom(IMCMessage otherMessage)
                    throws java.lang.Exception
```
    Set all values from another message of same type
    
    Parameters:
    
    otherMessage - Message where to read values from
    
    Throws:
    
    java.lang.Exception - In case the types of the messages do not match
  - setValues
```
public void setValues(java.util.Map<java.lang.String,java.lang.Object> values)
```
    All the values in the given hashtable will be copied to this message without any conversions
    
    Parameters:
    
    values -
  - getValues
```
public java.util.Map<java.lang.String,java.lang.Object> getValues()
```
    Returns all the values in this message. The returned map may not be modified, otherwise a UnsupportedOperationException will be thrown
    
    Returns:
    
    All the values in this message
  - setType
```
public void setType(IMCMessageType type)
```
    Change the type of the message. Bear in mind that values are preserved but may not match the new type's fields
    
    Parameters:
    
    type - The new type for this message
  - cloneMessage
```
public IMCMessage cloneMessage(IMCDefinition defs)
```
    Create a copy of this message using the given definitions. If some fields changed between IMC definitions the clone may loose some fields
    
    Parameters:
    
    defs - The definitions to be used when cloning the message
    
    Returns:
    
    A message with same values and type
  - cloneMessage
```
public IMCMessage cloneMessage()
```
    Creates a cloned message with copied values
    
    Specified by:
    
    cloneMessage in interface IMessage
    
    Returns:
    
    A clone of this instance
  - getSrc
```
public int getSrc()
```
    Retrieve IMC id of this message source (header field "src")
    
    Returns:
    
    The IMC identifier of this message source (system)
  - getSourceName
```
public java.lang.String getSourceName()
```
  - getEntityName
```
public java.lang.String getEntityName()
```
  - getDst
```
public int getDst()
```
    The numeric id of this message destination (header field "dst")
    
    Returns:
    
    The IMC identifier of this message destination (system)
  - getSrcEnt
```
public short getSrcEnt()
```
    Retrieve IMC id of this message source entity (header field "src_ent")
    
    Returns:
    
    The IMC identifier of this message source entity
  - getDstEnt
```
public short getDstEnt()
```
    Retrieve IMC id of this message destination entity (header field "dst_ent")
    
    Returns:
    
    The IMC identifier of this message destination entity
  - getSize
```
public int getSize()
```
    Retrieve the size indicated on the header of this message (header field "size")
    
    Returns:
    
    The indicated size
  - setSrc
```
public void setSrc(int src)
```
    Set the source of this message (header field "src")
    
    Parameters:
    
    src - The new source of this message
  - setDst
```
public void setDst(int dst)
```
    Set the destination of this message (header field "dst")
    
    Parameters:
    
    src - The destination of this message
  - setSrcEnt
```
public void setSrcEnt(int src_ent)
```
    Set the source entity of this message (header field "src_ent")
    
    Parameters:
    
    src - The source entity of this message
  - setDstEnt
```
public void setDstEnt(int dst_ent)
```
    Set the destination entity of this message (header field "dst_ent")
    
    Parameters:
    
    src - The destination entity of this message
  - getPayloadSize
```
public int getPayloadSize()
```
    Returns:
    
    The number of bytes that the payload occupies when serialized
  - setValue
```
public IMCMessage setValue(java.lang.String field,
                           java.lang.Object value)
```
    Sets a field value
    
    Specified by:
    
    setValue in interface IMessage
    
    Parameters:
    
    field - The field to be set
    
    value - The new value for the field.
    If the field is Enumerated, then the name of the value can be passed as a String If the field is Bitmask, then the name of the value can be passed as a LinkedHashMap
    
    Returns:
    
    TODO
  - getHeaderValue
```
public java.lang.Object getHeaderValue(java.lang.String field)
```
    Retrieve a value from the header
    
    Specified by:
    
    getHeaderValue in interface IMessage
    
    Parameters:
    
    field - The name of the field to retrieve
    
    Returns:
    
    The value of the field in the header or null if the field does not exist in the header
  - getValue
```
public java.lang.Object getValue(java.lang.String field)
```
    Retrieve a value in the message
    
    Specified by:
    
    getValue in interface IMessage
    
    Parameters:
    
    field - The name of the field to be retrieved
    
    Returns:
    
    The value of the field in the payload or in the header if it doesn't exist in the payload or null if the field does not exist on both
  - encodeTupleList
```
public static java.lang.String encodeTupleList(java.util.LinkedHashMap<java.lang.String,?> map)
```
    Given a map of Strings to Objects, encodes a tuplelist in the type: name1=value1;name2=value2 ...
    
    Parameters:
    
    map - A map from Strings (var names) to Objects (values)
    
    Returns:
    
    The encoded tuplelist
  - decodeTupleList
```
public static java.util.LinkedHashMap<java.lang.String,java.lang.String> decodeTupleList(java.lang.String tupleList)
```
    Reverse from encodeTupleList(LinkedHashMap)
    
    Parameters:
    
    tupleList - An encoded tuplelist
    
    Returns:
    
    A map from Strings to Strings
  - getTupleList
```
public java.util.LinkedHashMap<java.lang.String,java.lang.String> getTupleList(java.lang.String field)
```
    Returns the value of a field as an hash map
    
    Parameters:
    
    field - The name of the field (should be a tuplelist)
    
    Returns:
    
    An hash map with all the values of the tuplelist already parsed
  - getBitmask
```
public java.util.LinkedHashMap<java.lang.String,java.lang.Boolean> getBitmask(java.lang.String field)
```
    Retrieves the value of a Bitmask as map of booleans
    
    Parameters:
    
    field - The name of the field (should be a Bitmask)
    
    Returns:
    
    The value of the Bitmask field as map of booleans
  - setBitMask
```
public void setBitMask(java.lang.String field,
                       java.util.LinkedHashMap<java.lang.String,java.lang.Boolean> bitmask)
```
    Set the value of a bitmask field using a map from Strings to Booleans
  - getDouble
```
public double getDouble(java.lang.String field)
```
    Retrives the value of a field as a double value.
    If the field is not numeric, returns Double.NaN
    
    Parameters:
    
    field - The name of the field (should be numeric)
    
    Returns:
    
    The value of the field as double or Double.NaN if the field is not numeric
  - getFloat
```
public float getFloat(java.lang.String field)
```
    Retrives the value of a field as a float value.
    If the field is not numeric, returns Float.NaN
    
    Parameters:
    
    field - The name of the field (should be numeric)
    
    Returns:
    
    The value of the field as float or Float.NaN if the field is not numeric
  - getInteger
```
public int getInteger(java.lang.String field)
```
    Retrives the value of a field as an integer value.
    If the field is not numeric, returns 0
    
    Parameters:
    
    field - The name of the field (should be numeric)
    
    Returns:
    
    The value of the field as integer or 0 if the field is not numeric
  - getLong
```
public long getLong(java.lang.String field)
```
    Retrives the value of a field as a long value.
    If the field is not numeric, returns 0
    
    Parameters:
    
    field - The name of the field (should be numeric)
    
    Returns:
    
    The value of the field as long or 0 if the field is not numeric
  - getString
```
public java.lang.String getString(java.lang.String field,
                                  boolean addUnits)
```
  - getString
```
public java.lang.String getString(java.lang.String field)
```
    Returns a String representation for the value in the given field
    
    Parameters:
    
    field - The field to be returned as String
    
    Returns:
    
    A String representation of the value in the given field
  - getRawData
```
public byte[] getRawData(java.lang.String field)
```
    Returns a byte array from a rawdata field
    
    Parameters:
    
    field - The field whose value is to be returned
    
    Returns:
    
    The value of the rawdata as a byte array or null if an error occurs
  - getMessage
```
public IMCMessage getMessage(java.lang.String field)
```
    Retrieves an IMCMesssage from a field (used for inline messages)
    
    Parameters:
    
    field - The field whose value is to be returned
    
    Returns:
    
    The IMCMessage in the field or null if the value is not a message
  - getMessage
```
public <T extends IMCMessage> T getMessage(java.lang.Class<T> clazz,
                                           java.lang.String field)
                                    throws java.lang.Exception
```
    Retrieves an IMCMessage from a field and converts it to a chosen type.
    Example:
```
 PlanSpecification plan = planControl.getMessage(PlanSpecification.class, "arg");
 
```
    Parameters:
    
    clazz - The expected class of the inline message
    
    field - The field corresponding to the inline message
    
    Returns:
    
    The inline message, converted to chosen type
    
    Throws:
    
    java.lang.Exception
  - getMessageList
```
public java.util.Vector<IMCMessage> getMessageList(java.lang.String field)
```
    Retrieve all the messages in a MessageList as a Vector
    
    Parameters:
    
    field - The name of the field in this message which is of type MessageList
    
    Returns:
    
    all the messages in a MessageList as a Vector
  - setMessageList
```
public void setMessageList(java.util.Vector<? extends IMCMessage> messages,
                           java.lang.String field)
```
    This method receives a vector of messages and sets a field with a MessageList of those messages
    
    Parameters:
    
    messages - The messages in the MessageList
    
    field - The field to be set with a list of messages
  - getMessageList
```
public <T extends IMCMessage> java.util.Vector<T> getMessageList(java.lang.String field,
                                                                 java.lang.Class<T> clazz)
                                                          throws java.lang.Exception
```
    Retrieve a message list from this message using a given type
    
    Parameters:
    
    field - The field from where to retrieve the message list
    
    clazz - The type of the messages in this list
    
    Returns:
    
    A Vector of typed messages
    
    Throws:
    
    java.lang.Exception - If the messages found do not correspond to expected type
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this message (used for debugging)
    
    Overrides:
    
    toString in class java.lang.Object
  - serialize
```
public int serialize(IMCDefinition def,
                     IMCOutputStream out)
              throws java.io.IOException
```
    Writes this message to an OutputStream
    
    Parameters:
    
    out - The OutputStream to write to
    
    Returns:
    
    The number of bytes written
    
    Throws:
    
    java.io.IOException
  - serialize
```
public int serialize(IMCOutputStream out)
              throws java.io.IOException
```
    Serialize this message to an IMCOutputStream
    
    Returns:
    
    The number of bytes writen
    
    Throws:
    
    java.io.IOException
  - setTimestamp
```
public void setTimestamp(double time)
```
    Change the timestamp of this message (stored in the header field "time")
    
    Parameters:
    
    time - The new unix time (seconds since 1970)
  - setTimestampMillis
```
public void setTimestampMillis(long timestampMillis)
```
  - getTimestampMillis
```
public long getTimestampMillis()
```
    Returns:
    
    The message timestamp in milliseconds
  - getTimestamp
```
public double getTimestamp()
```
    Returns:
    
    The message timestamp in seconds
  - getDate
```
public java.util.Date getDate()
```
    Retrieve the timestamp of this message as a Date
  - getAsNumber
```
public java.lang.Number getAsNumber(java.lang.String fieldName)
```
    Description copied from interface: IMessage
    
    Retrieve the value of the field as a Number
    
    Specified by:
    
    getAsNumber in interface IMessage
    
    Parameters:
    
    fieldName - The name of the field to consult
    
    Returns:
    
    The numeric value of the field of null in case the field is not numeric / does not exist
  - getAsString
```
public java.lang.String getAsString(java.lang.String fieldName)
```
    Description copied from interface: IMessage
    
    Retrieve the value of a field as a String
    
    Specified by:
    
    getAsString in interface IMessage
    
    Parameters:
    
    fieldName - The name of the field to consult
    
    Returns:
    
    The value of the field as a String or null in case of an error
  - getMgid
```
public int getMgid()
```
    Specified by:
    
    getMgid in interface IMessage
    
    Returns:
    
    the message serial ID
  - getAbbrev
```
public java.lang.String getAbbrev()
```
    Specified by:
    
    getAbbrev in interface IMessage
    
    Returns:
    
    the message abbreviated name
  - getLongName
```
public java.lang.String getLongName()
```
    Specified by:
    
    getLongName in interface IMessage
    
    Returns:
    
    the message human readable name
  - getFieldNames
```
public java.lang.String[] getFieldNames()
```
    Specified by:
    
    getFieldNames in interface IMessage
    
    Returns:
    
    the list of field names
  - getLongFieldName
```
public java.lang.String getLongFieldName(java.lang.String fieldName)
```
    Description copied from interface: IMessage
    
    Retrieve the long name (human readable) of a given field
    
    Specified by:
    
    getLongFieldName in interface IMessage
    
    Parameters:
    
    fieldName - The field's (abbreviated) name
    
    Returns:
    
    the long name (human readable) of a given field
  - getTypeOf
```
public java.lang.String getTypeOf(java.lang.String fieldName)
```
    Description copied from interface: IMessage
    
    Retrieve the field type of the given field
    
    Specified by:
    
    getTypeOf in interface IMessage
    
    Returns:
    
    The field type of given field like "uint8_t" or "plaintext"
  - getUnitsOf
```
public java.lang.String getUnitsOf(java.lang.String fieldName)
```
    Description copied from interface: IMessage
    
    Retrieves the units of the given field
    
    Specified by:
    
    getUnitsOf in interface IMessage
    
    Returns:
    
    The units of the field or an empty String in case no units are defined
  - hasFlag
```
public boolean hasFlag(java.lang.String flagName)
```
    Description copied from interface: IMessage
    
    Verify if the message has the given flag set
    
    Specified by:
    
    hasFlag in interface IMessage
    
    Returns:
    
    true if the flag is set or false otherwise
  - isPeriodic
```
public boolean isPeriodic()
```
  - validate
```
public void validate()
              throws InvalidMessageException
```
    Description copied from interface: IMessage
    
    Verifies if the message is valid by generating exceptions when the message is not valid
    
    Specified by:
    
    validate in interface IMessage
    
    Throws:
    
    InvalidMessageException
  - getProtocolFactory
```
public IMessageProtocol<? extends IMessage> getProtocolFactory()
```
    Specified by:
    
    getProtocolFactory in interface IMessage
  - isNull
```
public boolean isNull()
```
    Check in this is a null inline message
    
    Returns:
    
    true if the type of this message is -1
  - dump
```
public void dump(java.io.OutputStream err)
```
    Write this message as text into the given OutputStream. Example:
```
 IMCMessage estate = new IMCMessage("EstimatedState");
 estate.dump(System.out);
 
```
    Parameters:
    
    err - Where to write this message to.
  - hexdump
```
public void hexdump(java.io.OutputStream err)
```
  - parseJson
```
public static IMCMessage parseJson(java.lang.String json)
```
  - asJSON
```
public java.lang.String asJSON()
```
    Retrieve this message as a JSON string
    
    Returns:
    
    this message as a JSON string
  - asJSON
```
public java.lang.String asJSON(boolean includeHeader)
```
  - asXmlStripped
```
public java.lang.String asXmlStripped(int tabAmount,
                                      boolean isInline)
```
  - asMap
```
public java.util.Map<java.lang.String,java.lang.Object> asMap(boolean inner)
```
  - asXml
```
public java.lang.String asXml(boolean isInline)
```
  - payloadMD5
```
public byte[] payloadMD5()
```
    Compute this message's payload MD5
    
    Returns:
    
    The computed MD5 of this message's payload
  - get
```
public <T> T get(java.lang.String field,
                 java.lang.Class<T> type)
          throws java.lang.ClassCastException
```
    Throws:
    
    java.lang.ClassCastException
  - parseXml
```
public static IMCMessage parseXml(java.lang.String xml)
                           throws java.lang.Exception
```
    Parse an IMC-XML file and retrieve the messages found on the file
    
    Parameters:
    
    xml - The xml to be parsed
    
    Returns:
    
    The messages that exist in the file
    
    Throws:
    
    java.lang.Exception - Malformed XML, incompatible types, etc
  - compareTo
```
public int compareTo(IMCMessage arg0)
```
    Natural order uses the timestamp of the message for comparison
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<IMCMessage>
  - getAgeInSeconds
```
public double getAgeInSeconds()
```
    Calculates the difference between current time and the timestamp in this message
    
    Returns:
    
    The difference between current time and the timestamp in this message, in seconds
  - makeImmutable
```
public void makeImmutable()
```
    This method enforces all values in this message as immutable. Will give run time exceptions if someone tries to change the values.
  - getMessageInfo
```
public final pt.lsts.neptus.messages.listener.MessageInfo getMessageInfo()
```
    Returns:
    
    the messageInfo
  - serialize
```
public int serialize(java.nio.ByteBuffer destination,
                     int offset)
```
  - serializePayload
```
public int serializePayload(java.nio.ByteBuffer destination,
                            int offset)
```
  - setMessageInfo
```
public final void setMessageInfo(pt.lsts.neptus.messages.listener.MessageInfo messageInfo)
```
    Parameters:
    
    messageInfo - the messageInfo to set
  - main
```
public static void main(java.lang.String[] args)
                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception

Class IMCMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ENTITY_ID

DEFAULT_SYSTEM_ID

Constructor Detail

IMCMessage

IMCMessage

IMCMessage

IMCMessage

IMCMessage

IMCMessage

IMCMessage

Method Detail

getMessageType

getHeader

setHeader

copyFrom

setValues

getValues

setType

cloneMessage

cloneMessage

getSrc

getSourceName

getEntityName

getDst

getSrcEnt

getDstEnt

getSize

setSrc

setDst

setSrcEnt

setDstEnt

getPayloadSize

setValue

getHeaderValue

getValue

encodeTupleList

decodeTupleList

getTupleList

getBitmask

setBitMask

getDouble

getFloat

getInteger

getLong

getString

getString

getRawData

getMessage

getMessage

getMessageList

setMessageList

getMessageList

toString

serialize

serialize

setTimestamp

setTimestampMillis

getTimestampMillis

getTimestamp

getDate

getAsNumber

getAsString

getMgid

getAbbrev

getLongName

getFieldNames

getLongFieldName

getTypeOf

getUnitsOf

hasFlag

isPeriodic

validate

getProtocolFactory

isNull