AvclMessage (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- avcl.AvclMessage

```
public class AvclMessage
extends Object
```
Programming interface for dealing with AVCL message JAXB objects

Since:

11 October 2005 Program : AUV Workbench

Version:

$Id: AvclMessage.java 9103 2015-07-29 04:39:43Z brutzman $

Author:

Duane Davis

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACKNOWLEDGE_NEGATIVE` Message acknowledgment requirement
`static int`	`ACKNOWLEDGE_NONE` Message acknowledgment requirement
`static int`	`ACKNOWLEDGE_OPTIONAL` Message acknowledgment requirement
`static int`	`ACKNOWLEDGE_POSITIVE`
`static int`	`ACKNOWLEDGE_REQUIRED` Message acknowledgment requirement
`static int`	`ACTION_REQUEST_MSG` Message content type
`static int`	`ALL_TERRAIN_CAPABLE` Vehicle capability field
`static int`	`ALTITUDE_CAPABLE` Vehicle capability field
`static int`	`BODY_THRUSTERS_INSTALLED` Vehicle capability field
`static int`	`CHARACTERISTIC_MAXALTITUDE` Specific data item that can be contained within an "inform" message
`static int`	`CHARACTERISTIC_MAXDEPTH` Specific data item that can be contained within an "inform" message
`static int`	`CHARACTERISTIC_MAXSPEED` Specific data item that can be contained within an "inform" message
`static int`	`CHARACTERISTICS` Requestable information type
`static int`	`CHARACTERISTICS_MSG` Message content type
`static int`	`COMMUNICATIONS_CAPABLE` Vehicle capability field
`protected static ObjectFactory`	`factory` Used to generate content nodes defined during editing
`static int`	`FIXED_WING` Vehicle capability field
`static int`	`GPS_CAPABLE` Vehicle capability field
`static int`	`GROUP_ACTION_MSG` Message content type
`static int`	`HOVER_CAPABLE` Vehicle capability field
`static int`	`INFORMATION_REQUEST_MSG` Message content type
`protected JAXBContext`	`jaxbContext` Context corresponding to the JAXB-derived Java AVCL representation, retain jaxbContext in attempt to speed up performance
`static int`	`JOIN_GROUP` Vehicle group maintenance request type
`static int`	`LEAVE_GROUP` Vehicle group maintenance request type
`protected AvclMessageType`	`message` JAXB Object containing the message itself
`static int`	`MULTI_ENGINE` Vehicle capability field
`static int`	`PING` Requestable information type
`static int`	`PING_MSG` Message content type
`static int`	`RENDEZVOUS` Requestable information type
`static int`	`RENDEZVOUS_MSG` Message content type
`protected JAXBElement<AvclMessageType>`	`root` Root element of the message
`static int`	`ROTARY_WING` Vehicle capability field
`static int`	`SATELLITE_COMMUNICATIONS_CAPABLE` Vehicle capability field
`static int`	`SEAGLIDER` Vehicle capability field
`static int`	`SINGLE_ENGINE` Vehicle capability field
`static int`	`STATION_CAPABLE` Vehicle capability field
`static int`	`TELEMETRY` Requestable information type
`static int`	`TELEMETRY_MSG` Message content type
`static int`	`TELEMETRY_PHI` Specific data item that can be contained within an "inform" message
`static int`	`TELEMETRY_PHIDOT` Specific data item that can be contained within an "inform" message
`static int`	`TELEMETRY_PSI` Specific data item that can be contained within an "inform" message
`static int`	`TELEMETRY_PSIDOT` Specific data item that can be contained within an "inform" message
`static int`	`TELEMETRY_THETA` Specific data item that can be contained within an "inform" message
`static int`	`TELEMETRY_THETADOT` Specific data item that can be contained within an "inform" message
`static int`	`TELEMETRY_X` Specific data item that can be contained within an "inform" message
`static int`	`TELEMETRY_XDOT` Specific data item that can be contained within an "inform" message
`static int`	`TELEMETRY_Y` Specific data item that can be contained within an "inform" message
`static int`	`TELEMETRY_YDOT` Specific data item that can be contained within an "inform" message
`static int`	`TELEMETRY_Z` Specific data item that can be contained within an "inform" message
`static int`	`TELEMETRY_ZDOT` Specific data item that can be contained within an "inform" message
`static int`	`THRUSTER_POWERED` Vehicle capability field
`static int`	`UNDERWATER_COMMUNICATIONS_CAPABLE` Vehicle capability field

Constructor Summary

Constructors
Constructor and Description
`AvclMessage()` Constructor for empty message that provides access to a marshaler
`AvclMessage(Object obj)` Constructor that loads a message from a stream, reader, or another message object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCharacteristicsMsgCapability(String newCapability)` Adds an operating capability or characteristic to the message
`void`	`addMetaData(String name, String content)` Adds a new meta tag to the message
`void`	`addRecipient(int newRec)` Adds a new recipient to the list of recipients
`void`	`clearCharacteristicsMsgVehicleType()` Clears all vehicle type info in the message
`void`	`clearContent()` Clears all message content
`void`	`clearMetaData()` Removes all existing meta tags from the message
`void`	`clearPriority()` Clears the message's priority attribute
`void`	`clearRecipients()` Clears the list of recipients
`void`	`deleteMetaData(int index)` Removes the meta tag specified by the index
`String`	`getAcknowledge()` Returns the `AcknowledgeElementType` message's acknowledge requirement
`List<String>`	`getCharacteristicsMsgCapabilities()`
`String`	`getCharacteristicsMsgDescription()`
`boolean`	`getCharacteristicsMsgGoalCapability(int goalType)` Returns the value of a specified goal capability attribute (i.e., is the vehicle capable of completing that goal type)
`double`	`getCharacteristicsMsgOperatingLimit(int limit)` Returns the value of a specific operating limit
`int`	`getCharacteristicsMsgVehicleType()`
`int`	`getContentType()`
`int`	`getGroupActionMsgAction()`
`String`	`getGroupActionMsgDescription()`
`String`	`getInformationRequestMsgDescription()`
`int`	`getInformationRequestMsgInfoType()`
`int`	`getInformMessageInfoType()`
`String`	`getMessageDescription()`
`AvclMessageType`	`getMessageObject()`
`String`	`getMetaContent(int index)` Returns the content attribute of the meta tag specified by the index
`String`	`getMetaName(int index)` Returns the name attribute of the meta tag specified by the index
`int`	`getNumMeta()` Returns the number of meta elements in the message header
`int`	`getNumRecipients()` Returns the number of intended recipients of the message
`ObjectFactory`	`getObjectFactory()`
`String`	`getPingMsgDescription()`
`int`	`getPriority()` Returns the value of the `PriorityElementType` message priority attribute
`int`	`getRecipientID(int index)` Returns the ID of the recipient referred to by the index
`String`	`getRendezvousMsgDescription()`
`int`	`getSender()` Returns the ID of the sender
`double`	`getTelemetryMsgDataItem(int item)` Returns the value of a specified data field in a Telemetry message
`String`	`getTelemetryMsgDescription()`
`double`	`getTimeStamp()`
`String`	`getTransportStatus()`
`boolean`	`isValidXMLDocument()`
`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
`void`	`marshal(Writer writer)` Writes an XML (AVCL) to a designated Writer object
`int`	`recipientIndex(int recipientID)` Returns the index of the recipient if it is already in the list, NOVALUUE if it is not
`void`	`removeRecipient(int recipient)` Removes a recipient (identified by vehicle ID) from the recipient list
`void`	`setAcknowledge(int ackType)` Sets the message's acknowledge requirement attribute
`void`	`setBroadcast()` Sets the message to be broadcast to all vehicles (recipient = 0)
`void`	`setCharacteristicsMsgDescription(String newValue)` Sets the description attribute of a Characteristics message
`void`	`setCharacteristicsMsgGoalCapability(int goalType, boolean newValue)` Sets a specified goal capability attribute
`void`	`setCharacteristicsMsgOperatingLimit(int limit, double newValue)` Sets a specific operating limit value
`void`	`setCharacteristicsMsgVehicleType(int vehicleType)` Sets the vehicle type of the Characteristics message.
`void`	`setContentType(int type)` Sets the message's content to the type indicated by the enumeration.
`void`	`setGroupActionMsgAction(int action)` Sets the type of action for the group action message
`void`	`setGroupActionMsgAction(String action)` Sets the type of action for the group action message
`void`	`setGroupActionMsgDescription(String newValue)` Sets the description attribute of a "GroupAction" message
`void`	`setInformationRequestMsgDescription(String newValue)` Sets the description attribute of an Information Request message
`void`	`setInformationRequestMsgInfoType(int infoType)` Sets the type of information requested by an information request message
`void`	`setMessageDescription(String newValue)` Sets the value of the root element description attribute
`void`	`setPingMsgDescription(String newValue)` Sets the description attribute of a Ping message
`void`	`setPriority(int newPri)` Sets the message priority
`void`	`setRendezvousMsgDescription(String newValue)` Sets the description attribute of a Rendezvous message
`void`	`setSender(int senderID)` Sets the ID of the sender (must be greater than zero)
`void`	`setTelemetryMsgDataItem(int item, double newValue)` Sets one data field in a Telemetry message
`void`	`setTelemetryMsgDescription(String newValue)` Sets the description attribute of a Telemetry message
`void`	`setTelemetryMsgPosture(double x, double y, double z, double phi, double theta, double psi)` Sets the "Posture" element values in a Telemetry message
`void`	`setTelemetryMsgPostureRate(double xDot, double yDot, double zDot, double phiDot, double thetaDot, double psiDot)` Sets the "PostureRate" element values in a Telemetry message
`void`	`setTimeStamp(double time)` Sets the "time" attribute of the message element.
`void`	`setTransportStatus(String newStatus)` Sets the message's transport status attribute

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

- Field Detail
  - GROUP_ACTION_MSG
```
public static final int GROUP_ACTION_MSG
```
    Message content type
    
    See Also:
    
    Constant Field Values
  - INFORMATION_REQUEST_MSG
```
public static final int INFORMATION_REQUEST_MSG
```
    Message content type
    
    See Also:
    
    Constant Field Values
  - ACTION_REQUEST_MSG
```
public static final int ACTION_REQUEST_MSG
```
    Message content type
    
    See Also:
    
    Constant Field Values
  - PING_MSG
```
public static final int PING_MSG
```
    Message content type
    
    See Also:
    
    Constant Field Values
  - TELEMETRY_MSG
```
public static final int TELEMETRY_MSG
```
    Message content type
    
    See Also:
    
    Constant Field Values
  - CHARACTERISTICS_MSG
```
public static final int CHARACTERISTICS_MSG
```
    Message content type
    
    See Also:
    
    Constant Field Values
  - RENDEZVOUS_MSG
```
public static final int RENDEZVOUS_MSG
```
    Message content type
    
    See Also:
    
    Constant Field Values
  - ACKNOWLEDGE_REQUIRED
```
public static final int ACKNOWLEDGE_REQUIRED
```
    Message acknowledgment requirement
    
    See Also:
    
    Constant Field Values
  - ACKNOWLEDGE_NONE
```
public static final int ACKNOWLEDGE_NONE
```
    Message acknowledgment requirement
    
    See Also:
    
    Constant Field Values
  - ACKNOWLEDGE_OPTIONAL
```
public static final int ACKNOWLEDGE_OPTIONAL
```
    Message acknowledgment requirement
    
    See Also:
    
    Constant Field Values
  - ACKNOWLEDGE_POSITIVE
```
public static final int ACKNOWLEDGE_POSITIVE
```
    See Also:
    
    Constant Field Values
  - ACKNOWLEDGE_NEGATIVE
```
public static final int ACKNOWLEDGE_NEGATIVE
```
    Message acknowledgment requirement
    
    See Also:
    
    Constant Field Values
  - PING
```
public static final int PING
```
    Requestable information type
    
    See Also:
    
    Constant Field Values
  - TELEMETRY
```
public static final int TELEMETRY
```
    Requestable information type
    
    See Also:
    
    Constant Field Values
  - CHARACTERISTICS
```
public static final int CHARACTERISTICS
```
    Requestable information type
    
    See Also:
    
    Constant Field Values
  - RENDEZVOUS
```
public static final int RENDEZVOUS
```
    Requestable information type
    
    See Also:
    
    Constant Field Values
  - JOIN_GROUP
```
public static final int JOIN_GROUP
```
    Vehicle group maintenance request type
    
    See Also:
    
    Constant Field Values
  - LEAVE_GROUP
```
public static final int LEAVE_GROUP
```
    Vehicle group maintenance request type
    
    See Also:
    
    Constant Field Values
  - TELEMETRY_X
```
public static final int TELEMETRY_X
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - TELEMETRY_Y
```
public static final int TELEMETRY_Y
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - TELEMETRY_Z
```
public static final int TELEMETRY_Z
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - TELEMETRY_PHI
```
public static final int TELEMETRY_PHI
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - TELEMETRY_THETA
```
public static final int TELEMETRY_THETA
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - TELEMETRY_PSI
```
public static final int TELEMETRY_PSI
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - TELEMETRY_XDOT
```
public static final int TELEMETRY_XDOT
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - TELEMETRY_YDOT
```
public static final int TELEMETRY_YDOT
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - TELEMETRY_ZDOT
```
public static final int TELEMETRY_ZDOT
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - TELEMETRY_PHIDOT
```
public static final int TELEMETRY_PHIDOT
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - TELEMETRY_THETADOT
```
public static final int TELEMETRY_THETADOT
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - TELEMETRY_PSIDOT
```
public static final int TELEMETRY_PSIDOT
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - CHARACTERISTIC_MAXSPEED
```
public static final int CHARACTERISTIC_MAXSPEED
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - CHARACTERISTIC_MAXDEPTH
```
public static final int CHARACTERISTIC_MAXDEPTH
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - CHARACTERISTIC_MAXALTITUDE
```
public static final int CHARACTERISTIC_MAXALTITUDE
```
    Specific data item that can be contained within an "inform" message
    
    See Also:
    
    Constant Field Values
  - COMMUNICATIONS_CAPABLE
```
public static final int COMMUNICATIONS_CAPABLE
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - SATELLITE_COMMUNICATIONS_CAPABLE
```
public static final int SATELLITE_COMMUNICATIONS_CAPABLE
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - UNDERWATER_COMMUNICATIONS_CAPABLE
```
public static final int UNDERWATER_COMMUNICATIONS_CAPABLE
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - GPS_CAPABLE
```
public static final int GPS_CAPABLE
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - ALL_TERRAIN_CAPABLE
```
public static final int ALL_TERRAIN_CAPABLE
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - FIXED_WING
```
public static final int FIXED_WING
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - ROTARY_WING
```
public static final int ROTARY_WING
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - SINGLE_ENGINE
```
public static final int SINGLE_ENGINE
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - MULTI_ENGINE
```
public static final int MULTI_ENGINE
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - THRUSTER_POWERED
```
public static final int THRUSTER_POWERED
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - SEAGLIDER
```
public static final int SEAGLIDER
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - BODY_THRUSTERS_INSTALLED
```
public static final int BODY_THRUSTERS_INSTALLED
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - HOVER_CAPABLE
```
public static final int HOVER_CAPABLE
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - STATION_CAPABLE
```
public static final int STATION_CAPABLE
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - ALTITUDE_CAPABLE
```
public static final int ALTITUDE_CAPABLE
```
    Vehicle capability field
    
    See Also:
    
    Constant Field Values
  - jaxbContext
```
protected JAXBContext jaxbContext
```
    Context corresponding to the JAXB-derived Java AVCL representation, retain jaxbContext in attempt to speed up performance
  - factory
```
protected static ObjectFactory factory
```
    Used to generate content nodes defined during editing
  - root
```
protected JAXBElement<AvclMessageType> root
```
    Root element of the message
  - message
```
protected AvclMessageType message
```
    JAXB Object containing the message itself
- Constructor Detail
  - AvclMessage
```
public AvclMessage()
```
    Constructor for empty message that provides access to a marshaler
  - AvclMessage
```
public AvclMessage(Object obj)
```
    Constructor that loads a message from a stream, reader, or another message object
    
    Parameters:
    
    obj -
- Method Detail
  - isValidXMLDocument
```
public boolean isValidXMLDocument()
```
    Returns:
    
    true iif the current object is valid against the schema
  - 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
  - marshal
```
public void marshal(OutputStream stream)
```
    Writes an XML (AVCL) to a designated output stream
    
    Parameters:
    
    stream - OutputStream to which output is to be directed
  - marshal
```
public void marshal(Writer writer)
```
    Writes an XML (AVCL) to a designated Writer object
    
    Parameters:
    
    writer - Writer object to which the message is to be marshalled
  - getMessageObject
```
public AvclMessageType getMessageObject()
```
    Returns:
    
    a reference to the JAXB message object
  - getObjectFactory
```
public ObjectFactory getObjectFactory()
```
    Returns:
    
    an instance of the JAXB ObjectFactory
  - setMessageDescription
```
public void setMessageDescription(String newValue)
```
    Sets the value of the root element description attribute
    
    Parameters:
    
    newValue -
  - getMessageDescription
```
public String getMessageDescription()
```
    Returns:
    
    the value of the message root element description attribute
  - setSender
```
public void setSender(int senderID)
```
    Sets the ID of the sender (must be greater than zero)
    
    Parameters:
    
    senderID - vehicle ID of the intended sender of the message
  - getSender
```
public int getSender()
```
    Returns the ID of the sender
    
    Returns:
    
    ID value
  - clearRecipients
```
public void clearRecipients()
```
    Clears the list of recipients
  - setBroadcast
```
public void setBroadcast()
```
    Sets the message to be broadcast to all vehicles (recipient = 0)
  - getNumRecipients
```
public int getNumRecipients()
```
    Returns the number of intended recipients of the message
    
    Returns:
    
    count
  - getRecipientID
```
public int getRecipientID(int index)
```
    Returns the ID of the recipient referred to by the index
    
    Parameters:
    
    index - linear index into the list of recipients
    
    Returns:
    
    ID value
  - recipientIndex
```
public int recipientIndex(int recipientID)
```
    Returns the index of the recipient if it is already in the list, NOVALUUE if it is not
    
    Parameters:
    
    recipientID - vehicle ID of the vehicle being tested for inclusion in the recipient list
    
    Returns:
    
    index for this recipient ID, if it exists
  - addRecipient
```
public void addRecipient(int newRec)
```
    Adds a new recipient to the list of recipients
    
    Parameters:
    
    newRec - ID of the new recipient (must be >= 0)
  - removeRecipient
```
public void removeRecipient(int recipient)
```
    Removes a recipient (identified by vehicle ID) from the recipient list
    
    Parameters:
    
    recipient - vehicle ID of the recipient to be deleted
  - setPriority
```
public void setPriority(int newPri)
```
    Sets the message priority
    
    Parameters:
    
    newPri - positive integer representing the new priority (lower number = high priority)
  - clearPriority
```
public void clearPriority()
```
    Clears the message's priority attribute
  - getPriority
```
public int getPriority()
```
    Returns the value of the PriorityElementType message priority attribute
    
    Returns:
    
    value
  - setAcknowledge
```
public void setAcknowledge(int ackType)
```
    Sets the message's acknowledge requirement attribute
    
    Parameters:
    
    ackType - enumerated value corresponding to acknowledgment requirement types (required, none, etc.)
  - getAcknowledge
```
public String getAcknowledge()
```
    Returns the AcknowledgeElementType message's acknowledge requirement
    
    Returns:
    
    string value
  - getNumMeta
```
public int getNumMeta()
```
    Returns the number of meta elements in the message header
    
    Returns:
    
    number of meta elements in the message header
  - getMetaName
```
public String getMetaName(int index)
```
    Returns the name attribute of the meta tag specified by the index
    
    Parameters:
    
    index -
    
    Returns:
    
    value of the meta element's "name" attribute
  - getMetaContent
```
public String getMetaContent(int index)
```
    Returns the content attribute of the meta tag specified by the index
    
    Parameters:
    
    index -
    
    Returns:
    
    value of the meta element's "content" attribute
  - addMetaData
```
public void addMetaData(String name,
                        String content)
```
    Adds a new meta tag to the message
    
    Parameters:
    
    name - value of the name attribute of the new meta tag
    
    content - value of the content attribute of the new meta tag
  - deleteMetaData
```
public void deleteMetaData(int index)
```
    Removes the meta tag specified by the index
    
    Parameters:
    
    index -
  - clearMetaData
```
public void clearMetaData()
```
    Removes all existing meta tags from the message
  - setTimeStamp
```
public void setTimeStamp(double time)
```
    Sets the "time" attribute of the message element. Time is typically assumed to be the number of seconds from mission commencement
    
    Parameters:
    
    time -
  - getTimeStamp
```
public double getTimeStamp()
```
    Returns:
    
    the value of the "time" attribute of the message element (or NOVALUE if missing)
  - setTransportStatus
```
public void setTransportStatus(String newStatus)
```
    Sets the message's transport status attribute
    
    Parameters:
    
    newStatus - "sent", "received" or "none"
  - getTransportStatus
```
public String getTransportStatus()
```
    Returns:
    
    the message's transport status
  - setContentType
```
public void setContentType(int type)
```
    Sets the message's content to the type indicated by the enumeration. If the content is already set appropriately, no change will be made. If the content is set to something else it will be replaced by a new (empty) content element
    
    Parameters:
    
    type - enumeration indicating the type of content. TODO: use stricter typing and checking.
  - getContentType
```
public int getContentType()
```
    Returns:
    
    an enumeration for the type of content contained in the message
  - clearContent
```
public void clearContent()
```
    Clears all message content
  - setGroupActionMsgAction
```
public void setGroupActionMsgAction(String action)
```
    Sets the type of action for the group action message
    
    Parameters:
    
    action -
  - setGroupActionMsgAction
```
public void setGroupActionMsgAction(int action)
```
    Sets the type of action for the group action message
    
    Parameters:
    
    action - enumeration indicating the type of group action
  - getGroupActionMsgAction
```
public int getGroupActionMsgAction()
```
    Returns:
    
    the type of action for the group action message
  - setGroupActionMsgDescription
```
public void setGroupActionMsgDescription(String newValue)
```
    Sets the description attribute of a "GroupAction" message
    
    Parameters:
    
    newValue -
  - getGroupActionMsgDescription
```
public String getGroupActionMsgDescription()
```
    Returns:
    
    the value of the description attribute of the "GroupAction" element
  - setInformationRequestMsgInfoType
```
public void setInformationRequestMsgInfoType(int infoType)
```
    Sets the type of information requested by an information request message
    
    Parameters:
    
    infoType - enumeration indicating the type of information requested
  - getInformationRequestMsgInfoType
```
public int getInformationRequestMsgInfoType()
```
    Returns:
    
    an enumeration for the type of information requested by the message
  - setInformationRequestMsgDescription
```
public void setInformationRequestMsgDescription(String newValue)
```
    Sets the description attribute of an Information Request message
    
    Parameters:
    
    newValue -
  - getInformationRequestMsgDescription
```
public String getInformationRequestMsgDescription()
```
    Returns:
    
    the value of the description attribute of the "InformationRequest" element
  - getInformMessageInfoType
```
public int getInformMessageInfoType()
```
    Returns:
    
    an enumeration for the type of information contained in the inform message
  - setPingMsgDescription
```
public void setPingMsgDescription(String newValue)
```
    Sets the description attribute of a Ping message
    
    Parameters:
    
    newValue -
  - getPingMsgDescription
```
public String getPingMsgDescription()
```
    Returns:
    
    the value of the description attribute of the "Ping" element
  - setRendezvousMsgDescription
```
public void setRendezvousMsgDescription(String newValue)
```
    Sets the description attribute of a Rendezvous message
    
    Parameters:
    
    newValue -
  - getRendezvousMsgDescription
```
public String getRendezvousMsgDescription()
```
    Returns:
    
    the value of the description attribute of the "Rendezvous" element
  - setTelemetryMsgPosture
```
public void setTelemetryMsgPosture(double x,
                                   double y,
                                   double z,
                                   double phi,
                                   double theta,
                                   double psi)
```
    Sets the "Posture" element values in a Telemetry message
    
    Parameters:
    
    x -
    
    y -
    
    z -
    
    phi -
    
    theta -
    
    psi -
  - setTelemetryMsgPostureRate
```
public void setTelemetryMsgPostureRate(double xDot,
                                       double yDot,
                                       double zDot,
                                       double phiDot,
                                       double thetaDot,
                                       double psiDot)
```
    Sets the "PostureRate" element values in a Telemetry message
    
    Parameters:
    
    xDot -
    
    yDot -
    
    zDot -
    
    phiDot -
    
    thetaDot -
    
    psiDot -
  - setTelemetryMsgDataItem
```
public void setTelemetryMsgDataItem(int item,
                                    double newValue)
```
    Sets one data field in a Telemetry message
    
    Parameters:
    
    item - enumeration identifying which item (x, yDot, theta, etc.)
    
    newValue -
  - getTelemetryMsgDataItem
```
public double getTelemetryMsgDataItem(int item)
```
    Returns the value of a specified data field in a Telemetry message
    
    Parameters:
    
    item - enumeration identifying which data item (x, yDot, theta, etc.)
    
    Returns:
    
    the value of the requested message data field
  - setTelemetryMsgDescription
```
public void setTelemetryMsgDescription(String newValue)
```
    Sets the description attribute of a Telemetry message
    
    Parameters:
    
    newValue -
  - getTelemetryMsgDescription
```
public String getTelemetryMsgDescription()
```
    Returns:
    
    the value of the description attribute of the "Telemetry" element
  - clearCharacteristicsMsgVehicleType
```
public void clearCharacteristicsMsgVehicleType()
```
    Clears all vehicle type info in the message
  - setCharacteristicsMsgVehicleType
```
public void setCharacteristicsMsgVehicleType(int vehicleType)
```
    Sets the vehicle type of the Characteristics message. If the vehicle type is already correct, data will be retained. If the vehicle type is incorrect, all existing data will be lost
    
    Parameters:
    
    vehicleType - enumeration indicating the type of vehicle (UAV, UGV, USV or UUV)
  - getCharacteristicsMsgVehicleType
```
public int getCharacteristicsMsgVehicleType()
```
    Returns:
    
    an enumeration indicating the type of vehicle characteristics contained
  - setCharacteristicsMsgGoalCapability
```
public void setCharacteristicsMsgGoalCapability(int goalType,
                                                boolean newValue)
```
    Sets a specified goal capability attribute
    
    Parameters:
    
    goalType - enumeration indicating which goal type is to be set
    
    newValue -
  - getCharacteristicsMsgGoalCapability
```
public boolean getCharacteristicsMsgGoalCapability(int goalType)
```
    Returns the value of a specified goal capability attribute (i.e., is the vehicle capable of completing that goal type)
    
    Parameters:
    
    goalType - enumeration indicating which goal type is to be set
    
    Returns:
    
    the boolean value of the specified goal capability attribute
  - setCharacteristicsMsgOperatingLimit
```
public void setCharacteristicsMsgOperatingLimit(int limit,
                                                double newValue)
```
    Sets a specific operating limit value
    
    Parameters:
    
    limit - enumeration indicating which limit is to be set
    
    newValue -
  - getCharacteristicsMsgOperatingLimit
```
public double getCharacteristicsMsgOperatingLimit(int limit)
```
    Returns the value of a specific operating limit
    
    Parameters:
    
    limit - enumeration indicating which limit is to be returned
    
    Returns:
    
    the value of the specified operating limit
  - addCharacteristicsMsgCapability
```
public void addCharacteristicsMsgCapability(String newCapability)
```
    Adds an operating capability or characteristic to the message
    
    Parameters:
    
    newCapability - string representation of the capability to be added
  - getCharacteristicsMsgCapabilities
```
public List<String> getCharacteristicsMsgCapabilities()
```
    Returns:
    
    a list of all of the values of the "Capability" elements in the message
  - setCharacteristicsMsgDescription
```
public void setCharacteristicsMsgDescription(String newValue)
```
    Sets the description attribute of a Characteristics message
    
    Parameters:
    
    newValue -
  - getCharacteristicsMsgDescription
```
public String getCharacteristicsMsgDescription()
```
    Returns:
    
    the value of the description attribute of the "Characteristics" element

Class AvclMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GROUP_ACTION_MSG

INFORMATION_REQUEST_MSG

ACTION_REQUEST_MSG

PING_MSG

TELEMETRY_MSG

CHARACTERISTICS_MSG

RENDEZVOUS_MSG

ACKNOWLEDGE_REQUIRED

ACKNOWLEDGE_NONE

ACKNOWLEDGE_OPTIONAL

ACKNOWLEDGE_POSITIVE

ACKNOWLEDGE_NEGATIVE

PING

TELEMETRY

CHARACTERISTICS

RENDEZVOUS

JOIN_GROUP

LEAVE_GROUP

TELEMETRY_X

TELEMETRY_Y

TELEMETRY_Z

TELEMETRY_PHI

TELEMETRY_THETA

TELEMETRY_PSI

TELEMETRY_XDOT

TELEMETRY_YDOT

TELEMETRY_ZDOT

TELEMETRY_PHIDOT

TELEMETRY_THETADOT

TELEMETRY_PSIDOT

CHARACTERISTIC_MAXSPEED

CHARACTERISTIC_MAXDEPTH

CHARACTERISTIC_MAXALTITUDE

COMMUNICATIONS_CAPABLE

SATELLITE_COMMUNICATIONS_CAPABLE

UNDERWATER_COMMUNICATIONS_CAPABLE

GPS_CAPABLE

ALL_TERRAIN_CAPABLE

FIXED_WING

ROTARY_WING

SINGLE_ENGINE

MULTI_ENGINE

THRUSTER_POWERED

SEAGLIDER

BODY_THRUSTERS_INSTALLED

HOVER_CAPABLE

STATION_CAPABLE

ALTITUDE_CAPABLE

jaxbContext

factory

root

message

Constructor Detail

AvclMessage

AvclMessage

Method Detail

isValidXMLDocument

marshal

marshal

marshal

marshal

getMessageObject

getObjectFactory

setMessageDescription

getMessageDescription

setSender

getSender

clearRecipients

setBroadcast

getNumRecipients

getRecipientID

recipientIndex

addRecipient

removeRecipient