UavState (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- execution.StateVector
- - execution.uav.UavState

```
public class UavState
extends StateVector
```
Container for UAV state variables Extends StateVector to include vehicle specific state variables

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`agl` above ground level altitude (RADALT)
`protected double`	`aileron` aileron setting (degrees deflection)
`protected double`	`dopplerSOGU` doppler sonar forward speed over the ground
`protected double`	`dopplerSOGV` doppler sonar lateral speed over the ground
`protected double`	`msl` mean sea level altitude (BARALT)
`protected double`	`portStab` port stabilator setting (degrees)
`protected double`	`power` engine power setting
`protected double`	`remainingPwr` remaining power available (percent battery or fuel)
`protected double`	`rudder` vertical rudder setting (degrees)
`protected double`	`stbdStab` starboard stabilator setting (degrees)
`protected double`	`tas` true air speed

Fields inherited from class execution.StateVector
p, phi, phiDot, psi, psiDot, q, r, simulationTime, theta, thetaDot, u, v, vehicle, w, x, xDot, y, yDot, z, zDot

Constructor Summary

Constructors
Constructor and Description

UavState(UavExecution execution)
Constructor for a new state variable

Constructors
Constructor and Description
`UavState(UavExecution execution)` Constructor for a new state variable

Method Summary

Methods
Modifier and Type	Method and Description
`double`	`getAileronSetting()`
`double`	`getAltitudeAGL()`
`double`	`getAltitudeMSL()`
`double`	`getAngleOfAttack()`
`double`	`getDopplerSOGU()`
`double`	`getDopplerSOGV()`
`double[]`	`getExtraDisState()`
`double`	`getPortStabSetting()`
`double`	`getPowerSetting()`
`double`	`getRemainingPower()`
`double`	`getRudderSetting()`
`double`	`getStbdStabSetting()`
`double`	`getTrueAirSpeed()`
`protected void`	`reset()` Reset state vector values prior to repeating another simulation loop
`void`	`setAileronSetting(double newValue)`
`void`	`setAltitudeAGL(double newValue)`
`void`	`setAltitudeMSL(double newValue)`
`void`	`setDopplerSOGU(double newValue)`
`void`	`setDopplerSOGV(double newValue)`
`void`	`setPortStabSetting(double newValue)`
`void`	`setPowerSetting(double newValue)`
`void`	`setRemainingPower(double newValue)`
`void`	`setRudderSetting(double newValue)`
`void`	`setStbdStabSetting(double newValue)`
`void`	`setTrueAirSpeed(double newValue)`
`void`	`setZ(double newValue)` sets the z position

Methods inherited from class execution.StateVector
getP, getPhi, getPhiDot, getPsi, getPsiDot, getQ, getR, getSimulationTime, getTheta, getThetaDot, getU, getV, getVehicle, getW, getX, getXDot, getY, getYDot, getZ, getZDot, resetKinematics, setP, setPhi, setPhiDot, setPsi, setPsiDot, setQ, setR, setSimulationTime, setTheta, setThetaDot, setU, setV, setW, setX, setXDot, setY, setYDot, setZDot

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

- Field Detail
  - remainingPwr
```
protected double remainingPwr
```
    remaining power available (percent battery or fuel)
  - power
```
protected double power
```
    engine power setting
  - aileron
```
protected double aileron
```
    aileron setting (degrees deflection)
  - rudder
```
protected double rudder
```
    vertical rudder setting (degrees)
  - portStab
```
protected double portStab
```
    port stabilator setting (degrees)
  - stbdStab
```
protected double stbdStab
```
    starboard stabilator setting (degrees)
  - tas
```
protected double tas
```
    true air speed
  - msl
```
protected double msl
```
    mean sea level altitude (BARALT)
  - dopplerSOGU
```
protected double dopplerSOGU
```
    doppler sonar forward speed over the ground
  - dopplerSOGV
```
protected double dopplerSOGV
```
    doppler sonar lateral speed over the ground
  - agl
```
protected double agl
```
    above ground level altitude (RADALT)
- Constructor Detail
  - UavState
```
public UavState(UavExecution execution)
```
    Constructor for a new state variable
    
    Parameters:
    execution - UavExecution reference to uav to which state vector applies
- Method Detail
  - reset
```
protected void reset()
```
    Reset state vector values prior to repeating another simulation loop
    
    Specified by:
    
    reset in class StateVector
  - getRemainingPower
```
public double getRemainingPower()
```
    Returns:
    the remaining power (percent battery or fuel)
  - getPowerSetting
```
public double getPowerSetting()
```
    Returns:
    the UAV engine power setting
  - getAileronSetting
```
public double getAileronSetting()
```
    Returns:
    the UAV aileron setting
  - getRudderSetting
```
public double getRudderSetting()
```
    Returns:
    the rudder setting
  - getPortStabSetting
```
public double getPortStabSetting()
```
    Returns:
    the port stabilator setting
  - getStbdStabSetting
```
public double getStbdStabSetting()
```
    Returns:
    the starboard stabilator setting
  - getAngleOfAttack
```
public double getAngleOfAttack()
```
    Returns:
    the current angle of attack
  - getTrueAirSpeed
```
public double getTrueAirSpeed()
```
    Returns:
    the UAV true air speed
  - getAltitudeMSL
```
public double getAltitudeMSL()
```
    Returns:
    the mean sea level (MSL) altitude
  - getDopplerSOGU
```
public double getDopplerSOGU()
```
    Returns:
    the longitudinal doppler velocity (u)
  - getDopplerSOGV
```
public double getDopplerSOGV()
```
    Returns:
    the lateral doppler velocity (v)
  - getAltitudeAGL
```
public double getAltitudeAGL()
```
    Returns:
    the above ground level (AGL) altitude
  - setRemainingPower
```
public void setRemainingPower(double newValue)
```
    Parameters:
    newValue - the remaining power (percent battery or fuel)
  - setZ
```
public void setZ(double newValue)
```
    Description copied from class: StateVector
    
    sets the z position
    
    Overrides:
    
    setZ in class StateVector
    
    Parameters:
    newValue - the Z and MSL altitude fields
  - setPowerSetting
```
public void setPowerSetting(double newValue)
```
    Parameters:
    newValue - the UAV engine power setting
  - setAileronSetting
```
public void setAileronSetting(double newValue)
```
    Parameters:
    newValue - the UAV aileron setting
  - setRudderSetting
```
public void setRudderSetting(double newValue)
```
    Parameters:
    newValue - the rudder setting
  - setPortStabSetting
```
public void setPortStabSetting(double newValue)
```
    Parameters:
    newValue - the port stabilator setting
  - setStbdStabSetting
```
public void setStbdStabSetting(double newValue)
```
    Parameters:
    newValue - the starboard stabilator setting
  - setTrueAirSpeed
```
public void setTrueAirSpeed(double newValue)
```
    Parameters:
    newValue - the UAV true air speed
  - setDopplerSOGU
```
public void setDopplerSOGU(double newValue)
```
    Parameters:
    newValue - the longitudinal doppler velocity (u)
  - setDopplerSOGV
```
public void setDopplerSOGV(double newValue)
```
    Parameters:
    newValue - the lateral doppler velocity (v)
  - setAltitudeMSL
```
public void setAltitudeMSL(double newValue)
```
    Parameters:
    newValue - the mean sea level (MSLL) altitude
  - setAltitudeAGL
```
public void setAltitudeAGL(double newValue)
```
    Parameters:
    newValue - the above ground level (AGL) altitude
  - getExtraDisState
```
public double[] getExtraDisState()
```
    Specified by:
    
    getExtraDisState in class StateVector

Class UavState

Field Summary

Fields inherited from class execution.StateVector

Constructor Summary

Method Summary

Methods inherited from class execution.StateVector

Methods inherited from class java.lang.Object

Field Detail

remainingPwr

power

aileron

rudder

portStab

stbdStab

tas

msl

dopplerSOGU

dopplerSOGV

agl

Constructor Detail

UavState

Method Detail

reset

getRemainingPower

getPowerSetting

getAileronSetting

getRudderSetting

getPortStabSetting

getStbdStabSetting

getAngleOfAttack

getTrueAirSpeed

getAltitudeMSL

getDopplerSOGU

getDopplerSOGV

getAltitudeAGL

setRemainingPower

setZ

setPowerSetting

setAileronSetting

setRudderSetting

setPortStabSetting

setStbdStabSetting

setTrueAirSpeed

setDopplerSOGU

setDopplerSOGV

setAltitudeMSL

setAltitudeAGL

getExtraDisState