JausMessageSet (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- jaus.JausMessageSet

```
public class JausMessageSet
extends Object
```
Contains a JAXB object corresponding to a set of JAUS messages

Author:

dtdavis

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`JAUSHEADERSIZE` Number of bytes to be used in the header
`static int`	`NULLCOMMAND` Enumeration for 2-byte command codes
`static int[]`	`NULLCOMMAND_BYTES` Binary enumeration for 2-byte command codes
`static int`	`QUERYGLOBALPOSE`
`static int[]`	`QUERYGLOBALPOSE_BYTES`
`static int`	`QUERYGLOBALVECTOR`
`static int[]`	`QUERYGLOBALVECTOR_BYTES`
`static int`	`QUERYGLOBALWAYPOINT`
`static int[]`	`QUERYGLOBALWAYPOINT_BYTES`
`static int`	`QUERYHEARTBEATPULSE`
`static int[]`	`QUERYHEARTBEATPULSE_BYTES`
`static int`	`QUERYPLATFORMSPECS`
`static int[]`	`QUERYPLATFORMSPECS_BYTES`
`static int`	`QUERYTIME`
`static int[]`	`QUERYTIME_BYTES`
`static int`	`QUERYTRAVELSPEED`
`static int[]`	`QUERYTRAVELSPEED_BYTES`
`static int`	`QUERYVELOCITYSTATE`
`static int[]`	`QUERYVELOCITYSTATE_BYTES`
`static int`	`QUERYWRENCHEFFORT`
`static int[]`	`QUERYWRENCHEFFORT_BYTES`
`static int`	`REPORTGLOBALPOSE`
`static int[]`	`REPORTGLOBALPOSE_BYTES`
`static int`	`REPORTGLOBALVECTOR`
`static int[]`	`REPORTGLOBALVECTOR_BYTES`
`static int`	`REPORTGLOBALWAYPOINT`
`static int[]`	`REPORTGLOBALWAYPOINT_BYTES`
`static int`	`REPORTHEARTBEATPULSE`
`static int[]`	`REPORTHEARTBEATPULSE_BYTES`
`static int`	`REPORTPLATFORMSPECS`
`static int[]`	`REPORTPLATFORMSPECS_BYTES`
`static int`	`REPORTTIME`
`static int[]`	`REPORTTIME_BYTES`
`static int`	`REPORTTRAVELSPEED`
`static int[]`	`REPORTTRAVELSPEED_BYTES`
`static int`	`REPORTVELOCITYSTATE`
`static int[]`	`REPORTVELOCITYSTATE_BYTES`
`static int`	`REPORTWRENCHEFFORT`
`static int[]`	`REPORTWRENCHEFFORT_BYTES`
`static int`	`SETGLOBALVECTOR`
`static int[]`	`SETGLOBALVECTOR_BYTES`
`static int`	`SETGLOBALWAYPOINT`
`static int[]`	`SETGLOBALWAYPOINT_BYTES`
`static int`	`SETTIME`
`static int[]`	`SETTIME_BYTES`
`static int`	`SETTRAVELSPEED`
`static int[]`	`SETTRAVELSPEED_BYTES`
`static int`	`SETWRENCHEFFORT`
`static int[]`	`SETWRENCHEFFORT_BYTES`
`static int`	`SHUTDOWN`
`static int[]`	`SHUTDOWN_BYTES`

Constructor Summary

Constructors
Constructor and Description
`JausMessageSet()` Creates a new instance of JausMessageSet
`JausMessageSet(ArrayList binaryJaus)` Creates a new instance of JausMessageSet
`JausMessageSet(Object source)` Creates a new instance of JausMessageSet

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ArrayList`	`generateBinary()` Generates a int[] containing a series of binary JAUS messages corresponding to a JAXB JAUSMessageSet object
`static int[]`	`getCommandCodeBytes(jaus.jaxb.JAUSMessageType msg)` Returns the 2-byte command code for the message
`static int`	`getMessageType(jaus.jaxb.JAUSMessageType msg)` Returns an enumeration identifying the type of command contained in a JAUS message
`void`	`loadFromBinary(ArrayList binaryJaus)` Loads the JAXB object for a set of JAUS messages from a int[] containing the binary messages
`static void`	`main(String[] args)` Main method used for trouble shooting only
`void`	`marshal(File outFile)` Writes an XML (AVCL) to a designated file
`void`	`marshal(OutputStream stream)` Writes an XML (AVCL) to a designated output stream
`void`	`marshal(String outFile)` Writes an XML (AVCL) to a designated file

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

- Field Detail
  - JAUSHEADERSIZE
```
public static final int JAUSHEADERSIZE
```
    Number of bytes to be used in the header
    
    See Also:
    
    Constant Field Values
  - NULLCOMMAND
```
public static final int NULLCOMMAND
```
    Enumeration for 2-byte command codes
    
    See Also:
    
    Constant Field Values
  - SHUTDOWN
```
public static final int SHUTDOWN
```
    See Also:
    
    Constant Field Values
  - SETTIME
```
public static final int SETTIME
```
    See Also:
    
    Constant Field Values
  - QUERYTIME
```
public static final int QUERYTIME
```
    See Also:
    
    Constant Field Values
  - REPORTTIME
```
public static final int REPORTTIME
```
    See Also:
    
    Constant Field Values
  - SETWRENCHEFFORT
```
public static final int SETWRENCHEFFORT
```
    See Also:
    
    Constant Field Values
  - QUERYWRENCHEFFORT
```
public static final int QUERYWRENCHEFFORT
```
    See Also:
    
    Constant Field Values
  - REPORTWRENCHEFFORT
```
public static final int REPORTWRENCHEFFORT
```
    See Also:
    
    Constant Field Values
  - SETGLOBALVECTOR
```
public static final int SETGLOBALVECTOR
```
    See Also:
    
    Constant Field Values
  - QUERYGLOBALVECTOR
```
public static final int QUERYGLOBALVECTOR
```
    See Also:
    
    Constant Field Values
  - REPORTGLOBALVECTOR
```
public static final int REPORTGLOBALVECTOR
```
    See Also:
    
    Constant Field Values
  - SETTRAVELSPEED
```
public static final int SETTRAVELSPEED
```
    See Also:
    
    Constant Field Values
  - QUERYTRAVELSPEED
```
public static final int QUERYTRAVELSPEED
```
    See Also:
    
    Constant Field Values
  - REPORTTRAVELSPEED
```
public static final int REPORTTRAVELSPEED
```
    See Also:
    
    Constant Field Values
  - SETGLOBALWAYPOINT
```
public static final int SETGLOBALWAYPOINT
```
    See Also:
    
    Constant Field Values
  - QUERYGLOBALWAYPOINT
```
public static final int QUERYGLOBALWAYPOINT
```
    See Also:
    
    Constant Field Values
  - REPORTGLOBALWAYPOINT
```
public static final int REPORTGLOBALWAYPOINT
```
    See Also:
    
    Constant Field Values
  - QUERYHEARTBEATPULSE
```
public static final int QUERYHEARTBEATPULSE
```
    See Also:
    
    Constant Field Values
  - REPORTHEARTBEATPULSE
```
public static final int REPORTHEARTBEATPULSE
```
    See Also:
    
    Constant Field Values
  - QUERYPLATFORMSPECS
```
public static final int QUERYPLATFORMSPECS
```
    See Also:
    
    Constant Field Values
  - REPORTPLATFORMSPECS
```
public static final int REPORTPLATFORMSPECS
```
    See Also:
    
    Constant Field Values
  - QUERYGLOBALPOSE
```
public static final int QUERYGLOBALPOSE
```
    See Also:
    
    Constant Field Values
  - REPORTGLOBALPOSE
```
public static final int REPORTGLOBALPOSE
```
    See Also:
    
    Constant Field Values
  - QUERYVELOCITYSTATE
```
public static final int QUERYVELOCITYSTATE
```
    See Also:
    
    Constant Field Values
  - REPORTVELOCITYSTATE
```
public static final int REPORTVELOCITYSTATE
```
    See Also:
    
    Constant Field Values
  - NULLCOMMAND_BYTES
```
public static final int[] NULLCOMMAND_BYTES
```
    Binary enumeration for 2-byte command codes
  - SHUTDOWN_BYTES
```
public static final int[] SHUTDOWN_BYTES
```
  - SETTIME_BYTES
```
public static final int[] SETTIME_BYTES
```
  - QUERYTIME_BYTES
```
public static final int[] QUERYTIME_BYTES
```
  - REPORTTIME_BYTES
```
public static final int[] REPORTTIME_BYTES
```
  - SETWRENCHEFFORT_BYTES
```
public static final int[] SETWRENCHEFFORT_BYTES
```
  - QUERYWRENCHEFFORT_BYTES
```
public static final int[] QUERYWRENCHEFFORT_BYTES
```
  - REPORTWRENCHEFFORT_BYTES
```
public static final int[] REPORTWRENCHEFFORT_BYTES
```
  - SETGLOBALVECTOR_BYTES
```
public static final int[] SETGLOBALVECTOR_BYTES
```
  - QUERYGLOBALVECTOR_BYTES
```
public static final int[] QUERYGLOBALVECTOR_BYTES
```
  - REPORTGLOBALVECTOR_BYTES
```
public static final int[] REPORTGLOBALVECTOR_BYTES
```
  - SETTRAVELSPEED_BYTES
```
public static final int[] SETTRAVELSPEED_BYTES
```
  - QUERYTRAVELSPEED_BYTES
```
public static final int[] QUERYTRAVELSPEED_BYTES
```
  - REPORTTRAVELSPEED_BYTES
```
public static final int[] REPORTTRAVELSPEED_BYTES
```
  - SETGLOBALWAYPOINT_BYTES
```
public static final int[] SETGLOBALWAYPOINT_BYTES
```
  - QUERYGLOBALWAYPOINT_BYTES
```
public static final int[] QUERYGLOBALWAYPOINT_BYTES
```
  - REPORTGLOBALWAYPOINT_BYTES
```
public static final int[] REPORTGLOBALWAYPOINT_BYTES
```
  - QUERYHEARTBEATPULSE_BYTES
```
public static final int[] QUERYHEARTBEATPULSE_BYTES
```
  - REPORTHEARTBEATPULSE_BYTES
```
public static final int[] REPORTHEARTBEATPULSE_BYTES
```
  - QUERYPLATFORMSPECS_BYTES
```
public static final int[] QUERYPLATFORMSPECS_BYTES
```
  - REPORTPLATFORMSPECS_BYTES
```
public static final int[] REPORTPLATFORMSPECS_BYTES
```
  - QUERYGLOBALPOSE_BYTES
```
public static final int[] QUERYGLOBALPOSE_BYTES
```
  - REPORTGLOBALPOSE_BYTES
```
public static final int[] REPORTGLOBALPOSE_BYTES
```
  - QUERYVELOCITYSTATE_BYTES
```
public static final int[] QUERYVELOCITYSTATE_BYTES
```
  - REPORTVELOCITYSTATE_BYTES
```
public static final int[] REPORTVELOCITYSTATE_BYTES
```
- Constructor Detail
  - JausMessageSet
```
public JausMessageSet()
```
    Creates a new instance of JausMessageSet
  - JausMessageSet
```
public JausMessageSet(ArrayList binaryJaus)
```
    Creates a new instance of JausMessageSet
    
    Parameters:
    
    binaryJaus - ArrayList containing a sequence of int[]s with JAUS messages in binary form
  - JausMessageSet
```
public JausMessageSet(Object source)
               throws Exception
```
    Creates a new instance of JausMessageSet
    
    Parameters:
    
    source - InputStream, filename, or File object from which the file is to be loaded
    
    Throws:
    
    Exception
- Method Detail
  - loadFromBinary
```
public void loadFromBinary(ArrayList binaryJaus)
```
    Loads the JAXB object for a set of JAUS messages from a int[] containing the binary messages
    
    Parameters:
    
    binaryJaus - ArrayList containing a sequence of int[]s with JAUS messages in binary form
  - generateBinary
```
public ArrayList generateBinary()
```
    Generates a int[] containing a series of binary JAUS messages corresponding to a JAXB JAUSMessageSet object
    
    Returns:
  - marshal
```
public void marshal(OutputStream stream)
```
    Writes an XML (AVCL) to a designated output stream
    
    Parameters:
    
    stream - OutputStream to whichout put is to be directed
  - marshal
```
public void marshal(String outFile)
```
    Writes an XML (AVCL) to a designated file
    
    Parameters:
    
    outFile - filename and path to which output is to be directed
  - marshal
```
public void marshal(File outFile)
```
    Writes an XML (AVCL) to a designated file
    
    Parameters:
    
    outFile - filename and path to which output is to be directed
  - getCommandCodeBytes
```
public static int[] getCommandCodeBytes(jaus.jaxb.JAUSMessageType msg)
```
    Returns the 2-byte command code for the message
    
    Parameters:
    
    msg - JAXB object containing a single JAUS message
    
    Returns:
    
    int[] with the 2-byte command code
  - getMessageType
```
public static int getMessageType(jaus.jaxb.JAUSMessageType msg)
```
    Returns an enumeration identifying the type of command contained in a JAUS message
    
    Parameters:
    
    msg - JAXB object containing a single JAUS message
    
    Returns:
    
    int identifying uniquely identifying the command (matches the JAUS command code)
  - main
```
public static void main(String[] args)
```
    Main method used for trouble shooting only
    
    Parameters:
    
    args -

Class JausMessageSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JAUSHEADERSIZE

NULLCOMMAND

SHUTDOWN

SETTIME

QUERYTIME

REPORTTIME

SETWRENCHEFFORT

QUERYWRENCHEFFORT

REPORTWRENCHEFFORT

SETGLOBALVECTOR

QUERYGLOBALVECTOR

REPORTGLOBALVECTOR

SETTRAVELSPEED

QUERYTRAVELSPEED

REPORTTRAVELSPEED

SETGLOBALWAYPOINT

QUERYGLOBALWAYPOINT

REPORTGLOBALWAYPOINT

QUERYHEARTBEATPULSE

REPORTHEARTBEATPULSE

QUERYPLATFORMSPECS

REPORTPLATFORMSPECS

QUERYGLOBALPOSE

REPORTGLOBALPOSE

QUERYVELOCITYSTATE

REPORTVELOCITYSTATE

NULLCOMMAND_BYTES

SHUTDOWN_BYTES

SETTIME_BYTES

QUERYTIME_BYTES

REPORTTIME_BYTES

SETWRENCHEFFORT_BYTES

QUERYWRENCHEFFORT_BYTES

REPORTWRENCHEFFORT_BYTES

SETGLOBALVECTOR_BYTES

QUERYGLOBALVECTOR_BYTES

REPORTGLOBALVECTOR_BYTES

SETTRAVELSPEED_BYTES

QUERYTRAVELSPEED_BYTES

REPORTTRAVELSPEED_BYTES

SETGLOBALWAYPOINT_BYTES

QUERYGLOBALWAYPOINT_BYTES

REPORTGLOBALWAYPOINT_BYTES

QUERYHEARTBEATPULSE_BYTES

REPORTHEARTBEATPULSE_BYTES

QUERYPLATFORMSPECS_BYTES

REPORTPLATFORMSPECS_BYTES

QUERYGLOBALPOSE_BYTES

REPORTGLOBALPOSE_BYTES

QUERYVELOCITYSTATE_BYTES

REPORTVELOCITYSTATE_BYTES

Constructor Detail

JausMessageSet

JausMessageSet

JausMessageSet

Method Detail

loadFromBinary

generateBinary

marshal

marshal

marshal

getCommandCodeBytes

getMessageType

main