TypedMessage (Federated simulaton over 0MQ bus 0.05.00 API)

java.lang.Object
- org.sim0mq.message.TypedMessage

```
public final class TypedMessage
extends Object
```
Message conversions. These take into account the endianness for coding the different values. Java is by default big-endian.
Copyright (c) 2016-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Mar 1, 2017

Author:

Alexander Verbraeck

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`BOOLEAN_ARRAY_HC` hashcode of boolean[] class.
`protected static int`	`BOOLEAN_HC` hashcode of Boolean class.
`protected static int`	`BOOLEAN_MATRIX_HC` hashcode of boolean[][] class.
`protected static int`	`BYTE_ARRAY_HC` hashcode of byte[] class.
`protected static int`	`BYTE_HC` hashcode of Byte class.
`protected static int`	`BYTE_MATRIX_HC` hashcode of byte[][] class.
`protected static int`	`CHAR_HC` hashcode of Character class.
`protected static int`	`DOUBLE_ARRAY_HC` hashcode of double[] class.
`protected static int`	`DOUBLE_HC` hashcode of Double class.
`protected static int`	`DOUBLE_MATRIX_HC` hashcode of double[][] class.
`protected static int`	`FLOAT_ARRAY_HC` hashcode of float[] class.
`protected static int`	`FLOAT_HC` hashcode of Float class.
`protected static int`	`FLOAT_MATRIX_HC` hashcode of float[][] class.
`protected static int`	`INT_ARRAY_HC` hashcode of int[] class.
`protected static int`	`INT_MATRIX_HC` hashcode of int[][] class.
`protected static int`	`INTEGER_HC` hashcode of Integer class.
`protected static int`	`LONG_ARRAY_HC` hashcode of long[] class.
`protected static int`	`LONG_HC` hashcode of Long class.
`protected static int`	`LONG_MATRIX_HC` hashcode of long[][] class.
`protected static int`	`SHORT_ARRAY_HC` hashcode of short[] class.
`protected static int`	`SHORT_HC` hashcode of Short class.
`protected static int`	`SHORT_MATRIX_HC` hashcode of short[][] class.
`protected static int`	`STRING_HC` hashcode of String class.
`protected static Charset`	`UTF16` the UTF-16 charset, big endian variant.
`protected static Charset`	`UTF8` the UTF-8 charset.
`protected static String`	`VERSION` version of the protocol, magic number.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Object[]`	`decode(byte[] message)` Decode the message into an object array.
`static Object[]`	`decodeSim0MQMessage(byte[] message)` Decode the message into an object array.
`static byte[]`	`encode0MQMessageUTF16(Object... content)` Encode the object array into a byte[] message.
`static byte[]`	`encode0MQMessageUTF8(Object... content)` Encode the object array into a byte[] message.
`static byte[]`	`encodeUTF16(Object... content)` Encode the object array into a byte[] message.
`static byte[]`	`encodeUTF8(Object... content)` Encode the object array into a byte[] message.
`static String`	`printBytes(byte[] bytes)` Return a readable string with the bytes in a byte[] message.

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

- Field Detail
  - VERSION
```
protected static final String VERSION
```
    version of the protocol, magic number.
    
    See Also:
    
    Constant Field Values
  - BYTE_HC
```
protected static final int BYTE_HC
```
    hashcode of Byte class.
  - SHORT_HC
```
protected static final int SHORT_HC
```
    hashcode of Short class.
  - INTEGER_HC
```
protected static final int INTEGER_HC
```
    hashcode of Integer class.
  - LONG_HC
```
protected static final int LONG_HC
```
    hashcode of Long class.
  - FLOAT_HC
```
protected static final int FLOAT_HC
```
    hashcode of Float class.
  - DOUBLE_HC
```
protected static final int DOUBLE_HC
```
    hashcode of Double class.
  - BOOLEAN_HC
```
protected static final int BOOLEAN_HC
```
    hashcode of Boolean class.
  - CHAR_HC
```
protected static final int CHAR_HC
```
    hashcode of Character class.
  - STRING_HC
```
protected static final int STRING_HC
```
    hashcode of String class.
  - BYTE_ARRAY_HC
```
protected static final int BYTE_ARRAY_HC
```
    hashcode of byte[] class.
  - SHORT_ARRAY_HC
```
protected static final int SHORT_ARRAY_HC
```
    hashcode of short[] class.
  - INT_ARRAY_HC
```
protected static final int INT_ARRAY_HC
```
    hashcode of int[] class.
  - LONG_ARRAY_HC
```
protected static final int LONG_ARRAY_HC
```
    hashcode of long[] class.
  - FLOAT_ARRAY_HC
```
protected static final int FLOAT_ARRAY_HC
```
    hashcode of float[] class.
  - DOUBLE_ARRAY_HC
```
protected static final int DOUBLE_ARRAY_HC
```
    hashcode of double[] class.
  - BOOLEAN_ARRAY_HC
```
protected static final int BOOLEAN_ARRAY_HC
```
    hashcode of boolean[] class.
  - BYTE_MATRIX_HC
```
protected static final int BYTE_MATRIX_HC
```
    hashcode of byte[][] class.
  - SHORT_MATRIX_HC
```
protected static final int SHORT_MATRIX_HC
```
    hashcode of short[][] class.
  - INT_MATRIX_HC
```
protected static final int INT_MATRIX_HC
```
    hashcode of int[][] class.
  - LONG_MATRIX_HC
```
protected static final int LONG_MATRIX_HC
```
    hashcode of long[][] class.
  - FLOAT_MATRIX_HC
```
protected static final int FLOAT_MATRIX_HC
```
    hashcode of float[][] class.
  - DOUBLE_MATRIX_HC
```
protected static final int DOUBLE_MATRIX_HC
```
    hashcode of double[][] class.
  - BOOLEAN_MATRIX_HC
```
protected static final int BOOLEAN_MATRIX_HC
```
    hashcode of boolean[][] class.
  - UTF8
```
protected static final Charset UTF8
```
    the UTF-8 charset.
  - UTF16
```
protected static final Charset UTF16
```
    the UTF-16 charset, big endian variant.
- Method Detail
  - encodeUTF8
```
public static byte[] encodeUTF8(Object... content)
                         throws Sim0MQException
```
    Encode the object array into a byte[] message. Use UTF8 for the characters and for the String.
    
    Parameters:
    
    content - the objects to encode
    
    Returns:
    
    the zeroMQ message to send as a byte array
    
    Throws:
    
    Sim0MQException - on unknown data type
  - encodeUTF16
```
public static byte[] encodeUTF16(Object... content)
                          throws Sim0MQException
```
    Encode the object array into a byte[] message. Use UTF16 for the characters and for the String.
    
    Parameters:
    
    content - the objects to encode
    
    Returns:
    
    the zeroMQ message to send as a byte array
    
    Throws:
    
    Sim0MQException - on unknown data type
  - encode0MQMessageUTF8
```
public static byte[] encode0MQMessageUTF8(Object... content)
                                   throws Sim0MQException
```
    Encode the object array into a byte[] message. Use UTF8 for the characters and for the String. Make sure the first field is a String and always encoded as UTF8 (for the "SIM##" magic number at the start).
    
    Parameters:
    
    content - the objects to encode
    
    Returns:
    
    the zeroMQ message to send as a byte array
    
    Throws:
    
    Sim0MQException - on unknown data type
  - encode0MQMessageUTF16
```
public static byte[] encode0MQMessageUTF16(Object... content)
                                    throws Sim0MQException
```
    Encode the object array into a byte[] message. Use UTF16 for the characters and for the String. Make sure the first field is a String and always encoded as UTF8 (for the "SIM##" magic number at the start).
    
    Parameters:
    
    content - the objects to encode
    
    Returns:
    
    the zeroMQ message to send as a byte array
    
    Throws:
    
    Sim0MQException - on unknown data type
  - decodeSim0MQMessage
```
public static Object[] decodeSim0MQMessage(byte[] message)
                                    throws Sim0MQException
```
    Decode the message into an object array.
    
    Parameters:
    
    message - the ZeroMQ byte array to decode
    
    Returns:
    
    an array of objects of the right type
    
    Throws:
    
    Sim0MQException - on unknown data type
  - decode
```
public static Object[] decode(byte[] message)
                       throws Sim0MQException
```
    Decode the message into an object array.
    
    Parameters:
    
    message - the ZeroMQ byte array to decode
    
    Returns:
    
    an array of objects of the right type
    
    Throws:
    
    Sim0MQException - on unknown data type
  - printBytes
```
public static String printBytes(byte[] bytes)
```
    Return a readable string with the bytes in a byte[] message.
    
    Parameters:
    
    bytes - byte[]; the byte array to display
    
    Returns:
    
    String; a readable string with the bytes in a byte[] message

Class TypedMessage

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

BYTE_HC

SHORT_HC

INTEGER_HC

LONG_HC

FLOAT_HC

DOUBLE_HC

BOOLEAN_HC

CHAR_HC

STRING_HC

BYTE_ARRAY_HC

SHORT_ARRAY_HC

INT_ARRAY_HC

LONG_ARRAY_HC

FLOAT_ARRAY_HC

DOUBLE_ARRAY_HC

BOOLEAN_ARRAY_HC

BYTE_MATRIX_HC

SHORT_MATRIX_HC

INT_MATRIX_HC

LONG_MATRIX_HC

FLOAT_MATRIX_HC

DOUBLE_MATRIX_HC

BOOLEAN_MATRIX_HC

UTF8

UTF16

Method Detail

encodeUTF8

encodeUTF16

encode0MQMessageUTF8

encode0MQMessageUTF16

decodeSim0MQMessage

decode

printBytes