HoverCommandType (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- avcl.jaxb.HoverCommandType

public class HoverCommandType
extends Object

Transit (if required) and hover within standoff distance of current or ordered position, also maintain heading (if specified).

Java class for hoverCommandType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="hoverCommandType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{}HorizontalPositionElements" minOccurs="0"/>
         <group ref="{}DepthTypeElements" minOccurs="0"/>
         <element ref="{}Heading" minOccurs="0"/>
         <element ref="{}ObtainGps" minOccurs="0"/>
         <element ref="{}Standoff" minOccurs="0"/>
         <element ref="{}TimeOut" minOccurs="0"/>
       </sequence>
       <attGroup ref="{}CommonAttributes"/>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected NonNegativeScalarElementType`	`altitude`
`protected NonNegativeScalarElementType`	`depth`
`protected String`	`description`
`protected HeadingElementType`	`heading`
`protected String`	`id`
`protected LatitudeLongitudeElementType`	`latitudeLongitude`
`protected BooleanElementType`	`obtainGps`
`protected XyElementType`	`relativeXYPosition`
`protected PositiveScalarElementType`	`standoff`
`protected PositiveScalarElementType`	`timeOut`
`protected Double`	`timeStamp`
`protected XyElementType`	`xyPosition`

Constructor Summary

Constructors
Constructor and Description

HoverCommandType()

Constructors
Constructor and Description
`HoverCommandType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NonNegativeScalarElementType`	`getAltitude()` Gets the value of the altitude property.
`NonNegativeScalarElementType`	`getDepth()` Gets the value of the depth property.
`String`	`getDescription()` Gets the value of the description property.
`HeadingElementType`	`getHeading()` Gets the value of the heading property.
`String`	`getId()` Gets the value of the id property.
`LatitudeLongitudeElementType`	`getLatitudeLongitude()` Gets the value of the latitudeLongitude property.
`BooleanElementType`	`getObtainGps()` Gets the value of the obtainGps property.
`XyElementType`	`getRelativeXYPosition()` Gets the value of the relativeXYPosition property.
`PositiveScalarElementType`	`getStandoff()` Gets the value of the standoff property.
`PositiveScalarElementType`	`getTimeOut()` Gets the value of the timeOut property.
`Double`	`getTimeStamp()` Gets the value of the timeStamp property.
`XyElementType`	`getXYPosition()` Gets the value of the xyPosition property.
`void`	`setAltitude(NonNegativeScalarElementType value)` Sets the value of the altitude property.
`void`	`setDepth(NonNegativeScalarElementType value)` Sets the value of the depth property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setHeading(HeadingElementType value)` Sets the value of the heading property.
`void`	`setId(String value)` Sets the value of the id property.
`void`	`setLatitudeLongitude(LatitudeLongitudeElementType value)` Sets the value of the latitudeLongitude property.
`void`	`setObtainGps(BooleanElementType value)` Sets the value of the obtainGps property.
`void`	`setRelativeXYPosition(XyElementType value)` Sets the value of the relativeXYPosition property.
`void`	`setStandoff(PositiveScalarElementType value)` Sets the value of the standoff property.
`void`	`setTimeOut(PositiveScalarElementType value)` Sets the value of the timeOut property.
`void`	`setTimeStamp(Double value)` Sets the value of the timeStamp property.
`void`	`setXYPosition(XyElementType value)` Sets the value of the xyPosition property.

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

- Field Detail
  - latitudeLongitude
```
protected LatitudeLongitudeElementType latitudeLongitude
```
  - xyPosition
```
protected XyElementType xyPosition
```
  - relativeXYPosition
```
protected XyElementType relativeXYPosition
```
  - depth
```
protected NonNegativeScalarElementType depth
```
  - altitude
```
protected NonNegativeScalarElementType altitude
```
  - heading
```
protected HeadingElementType heading
```
  - obtainGps
```
protected BooleanElementType obtainGps
```
  - standoff
```
protected PositiveScalarElementType standoff
```
  - timeOut
```
protected PositiveScalarElementType timeOut
```
  - timeStamp
```
protected Double timeStamp
```
  - description
```
protected String description
```
  - id
```
protected String id
```
- Constructor Detail
  - HoverCommandType
```
public HoverCommandType()
```
- Method Detail
  - getLatitudeLongitude
```
public LatitudeLongitudeElementType getLatitudeLongitude()
```
    Gets the value of the latitudeLongitude property.
    
    Returns:
    
    possible object is LatitudeLongitudeElementType
  - setLatitudeLongitude
```
public void setLatitudeLongitude(LatitudeLongitudeElementType value)
```
    Sets the value of the latitudeLongitude property.
    
    Parameters:
    
    value - allowed object is LatitudeLongitudeElementType
  - getXYPosition
```
public XyElementType getXYPosition()
```
    Gets the value of the xyPosition property.
    
    Returns:
    
    possible object is XyElementType
  - setXYPosition
```
public void setXYPosition(XyElementType value)
```
    Sets the value of the xyPosition property.
    
    Parameters:
    
    value - allowed object is XyElementType
  - getRelativeXYPosition
```
public XyElementType getRelativeXYPosition()
```
    Gets the value of the relativeXYPosition property.
    
    Returns:
    
    possible object is XyElementType
  - setRelativeXYPosition
```
public void setRelativeXYPosition(XyElementType value)
```
    Sets the value of the relativeXYPosition property.
    
    Parameters:
    
    value - allowed object is XyElementType
  - getDepth
```
public NonNegativeScalarElementType getDepth()
```
    Gets the value of the depth property.
    
    Returns:
    
    possible object is NonNegativeScalarElementType
  - setDepth
```
public void setDepth(NonNegativeScalarElementType value)
```
    Sets the value of the depth property.
    
    Parameters:
    
    value - allowed object is NonNegativeScalarElementType
  - getAltitude
```
public NonNegativeScalarElementType getAltitude()
```
    Gets the value of the altitude property.
    
    Returns:
    
    possible object is NonNegativeScalarElementType
  - setAltitude
```
public void setAltitude(NonNegativeScalarElementType value)
```
    Sets the value of the altitude property.
    
    Parameters:
    
    value - allowed object is NonNegativeScalarElementType
  - getHeading
```
public HeadingElementType getHeading()
```
    Gets the value of the heading property.
    
    Returns:
    
    possible object is HeadingElementType
  - setHeading
```
public void setHeading(HeadingElementType value)
```
    Sets the value of the heading property.
    
    Parameters:
    
    value - allowed object is HeadingElementType
  - getObtainGps
```
public BooleanElementType getObtainGps()
```
    Gets the value of the obtainGps property.
    
    Returns:
    
    possible object is BooleanElementType
  - setObtainGps
```
public void setObtainGps(BooleanElementType value)
```
    Sets the value of the obtainGps property.
    
    Parameters:
    
    value - allowed object is BooleanElementType
  - getStandoff
```
public PositiveScalarElementType getStandoff()
```
    Gets the value of the standoff property.
    
    Returns:
    
    possible object is PositiveScalarElementType
  - setStandoff
```
public void setStandoff(PositiveScalarElementType value)
```
    Sets the value of the standoff property.
    
    Parameters:
    
    value - allowed object is PositiveScalarElementType
  - getTimeOut
```
public PositiveScalarElementType getTimeOut()
```
    Gets the value of the timeOut property.
    
    Returns:
    
    possible object is PositiveScalarElementType
  - setTimeOut
```
public void setTimeOut(PositiveScalarElementType value)
```
    Sets the value of the timeOut property.
    
    Parameters:
    
    value - allowed object is PositiveScalarElementType
  - getTimeStamp
```
public Double getTimeStamp()
```
    Gets the value of the timeStamp property.
    
    Returns:
    
    possible object is Double
  - setTimeStamp
```
public void setTimeStamp(Double value)
```
    Sets the value of the timeStamp property.
    
    Parameters:
    
    value - allowed object is Double
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getId
```
public String getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is String
  - setId
```
public void setId(String value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is String

Class HoverCommandType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

latitudeLongitude

xyPosition

relativeXYPosition

depth

altitude

heading

obtainGps

standoff

timeOut

timeStamp

description

id

Constructor Detail

HoverCommandType

Method Detail

getLatitudeLongitude

setLatitudeLongitude

getXYPosition

setXYPosition

getRelativeXYPosition

setRelativeXYPosition

getDepth

setDepth

getAltitude

setAltitude

getHeading

setHeading

getObtainGps

setObtainGps

getStandoff

setStandoff

getTimeOut

setTimeOut

getTimeStamp

setTimeStamp

getDescription

setDescription

getId

setId