ATTObject (GPSd4Java 1.9 API)

java.lang.Object
- de.taimos.gpsd4java.types.ATTObject

All Implemented Interfaces:

IGPSObject
```
public class ATTObject
extends Object
implements IGPSObject
```
An ATT object is a vehicle-attitude report. It is returned by digital-compass and gyroscope sensors; depending on device, it may include: heading, pitch, roll, yaw, gyroscope, and magnetic-field readings. Because such sensors are often bundled as part of marine-navigation systems, the ATT response may also include water depth.

all getters for double values may return Double.NaN if value is not present
other getters may return null

Author:

thoeger

Field Summary

Fields
Modifier and Type Field and Description

static String NAME
the GPSd internal name

Fields
Modifier and Type	Field and Description
`static String`	`NAME` the GPSd internal name

Constructor Summary

Constructors
Constructor and Description

ATTObject()

Constructors
Constructor and Description
`ATTObject()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getAcc_len()` Scalar acceleration.
`double`	`getAcc_x()` X component of acceleration.
`double`	`getAcc_y()` Y component of acceleration.
`double`	`getAcc_z()` Z component of acceleration.
`double`	`getDepth()` Water depth in meters.
`String`	`getDevice()` Name of originating device
`double`	`getDip()` Roll in degrees.
`double`	`getGyro_x()` X component of acceleration.
`double`	`getGyro_y()` Y component of acceleration.
`double`	`getHeading()` Heading, degrees from true north.
`double`	`getMag_len()` Scalar magnetic field strength.
`double`	`getMag_x()` X component of magnetic field strength.
`double`	`getMag_y()` Y component of magnetic field strength.
`double`	`getMag_z()` Z component of magnetic field strength.
`String`	`getMagState()` Magnetometer status.
`double`	`getPitch()` Pitch in degrees.
`String`	`getPitchState()` Pitch sensor status.
`double`	`getRoll()` Roll in degrees.
`String`	`getRollState()` Roll sensor status.
`String`	`getTag()` Type tag associated with this GPS sentence; from an NMEA device this is just the NMEA sentence type.
`double`	`getTemperature()` Temperature at sensor, degrees centigrade.
`double`	`getTimestamp()` Seconds since the Unix epoch, UTC.
`double`	`getYaw()` Yaw in degrees
`String`	`getYawState()` Yaw sensor status.
`void`	`setAcc_len(double acc_len)` Scalar acceleration.
`void`	`setAcc_x(double acc_x)` X component of acceleration.
`void`	`setAcc_y(double acc_y)` Y component of acceleration.
`void`	`setAcc_z(double acc_z)` Z component of acceleration.
`void`	`setDepth(double depth)` Water depth in meters.
`void`	`setDevice(String device)` Name of originating device
`void`	`setDip(double dip)` Roll in degrees.
`void`	`setGyro_x(double gyro_x)` X component of acceleration.
`void`	`setGyro_y(double gyro_y)` Y component of acceleration.
`void`	`setHeading(double heading)` Heading, degrees from true north.
`void`	`setMag_len(double mag_len)` Scalar magnetic field strength.
`void`	`setMag_x(double mag_x)` X component of magnetic field strength.
`void`	`setMag_y(double mag_y)` Y component of magnetic field strength.
`void`	`setMag_z(double mag_z)` Z component of magnetic field strength.
`void`	`setMagState(String magState)` Magnetometer status.
`void`	`setPitch(double pitch)` Pitch in degrees.
`void`	`setPitchState(String pitchState)` Pitch sensor status.
`void`	`setRoll(double roll)` Roll in degrees.
`void`	`setRollState(String rollState)` Roll sensor status.
`void`	`setTag(String tag)` Type tag associated with this GPS sentence; from an NMEA device this is just the NMEA sentence type.
`void`	`setTemperature(double temperature)` Temperature at sensor, degrees centigrade.
`void`	`setTimestamp(double timestamp)` Seconds since the Unix epoch, UTC.
`void`	`setYaw(double yaw)` Yaw in degrees
`void`	`setYawState(String yawState)` Yaw sensor status.
`String`	`toString()`

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

- Field Detail
  - NAME
```
public static final String NAME
```
    the GPSd internal name
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ATTObject
```
public ATTObject()
```
- Method Detail
  - getTag
```
public String getTag()
```
    Type tag associated with this GPS sentence; from an NMEA device this is just the NMEA sentence type.
    
    Returns:
    
    the tag
  - setTag
```
public void setTag(String tag)
```
    Type tag associated with this GPS sentence; from an NMEA device this is just the NMEA sentence type.
    
    Parameters:
    
    tag - the tag to set
  - getDevice
```
public String getDevice()
```
    Name of originating device
    
    Returns:
    
    the device
  - setDevice
```
public void setDevice(String device)
```
    Name of originating device
    
    Parameters:
    
    device - the device to set
  - getTimestamp
```
public double getTimestamp()
```
    Seconds since the Unix epoch, UTC. May have a fractional part of up to .001sec precision.
    
    Returns:
    
    the timestamp
  - setTimestamp
```
public void setTimestamp(double timestamp)
```
    Seconds since the Unix epoch, UTC. May have a fractional part of up to .001sec precision.
    
    Parameters:
    
    timestamp - the timestamp to set
  - getHeading
```
public double getHeading()
```
    Heading, degrees from true north.
    
    Returns:
    
    the heading
  - setHeading
```
public void setHeading(double heading)
```
    Heading, degrees from true north.
    
    Parameters:
    
    heading - the heading to set
  - getPitch
```
public double getPitch()
```
    Pitch in degrees.
    
    Returns:
    
    the pitch
  - setPitch
```
public void setPitch(double pitch)
```
    Pitch in degrees.
    
    Parameters:
    
    pitch - the pitch to set
  - getYaw
```
public double getYaw()
```
    Yaw in degrees
    
    Returns:
    
    the yaw
  - setYaw
```
public void setYaw(double yaw)
```
    Yaw in degrees
    
    Parameters:
    
    yaw - the yaw to set
  - getRoll
```
public double getRoll()
```
    Roll in degrees.
    
    Returns:
    
    the roll
  - setRoll
```
public void setRoll(double roll)
```
    Roll in degrees.
    
    Parameters:
    
    roll - the roll to set
  - getDip
```
public double getDip()
```
    Roll in degrees.
    
    Returns:
    
    the dip
  - setDip
```
public void setDip(double dip)
```
    Roll in degrees.
    
    Parameters:
    
    dip - the dip to set
  - getMag_len
```
public double getMag_len()
```
    Scalar magnetic field strength.
    
    Returns:
    
    the mag_len
  - setMag_len
```
public void setMag_len(double mag_len)
```
    Scalar magnetic field strength.
    
    Parameters:
    
    mag_len - the mag_len to set
  - getMag_x
```
public double getMag_x()
```
    X component of magnetic field strength.
    
    Returns:
    
    the mag_x
  - setMag_x
```
public void setMag_x(double mag_x)
```
    X component of magnetic field strength.
    
    Parameters:
    
    mag_x - the mag_x to set
  - getMag_y
```
public double getMag_y()
```
    Y component of magnetic field strength.
    
    Returns:
    
    the mag_y
  - setMag_y
```
public void setMag_y(double mag_y)
```
    Y component of magnetic field strength.
    
    Parameters:
    
    mag_y - the mag_y to set
  - getMag_z
```
public double getMag_z()
```
    Z component of magnetic field strength.
    
    Returns:
    
    the mag_z
  - setMag_z
```
public void setMag_z(double mag_z)
```
    Z component of magnetic field strength.
    
    Parameters:
    
    mag_z - the mag_z to set
  - getAcc_len
```
public double getAcc_len()
```
    Scalar acceleration.
    
    Returns:
    
    the acc_len
  - setAcc_len
```
public void setAcc_len(double acc_len)
```
    Scalar acceleration.
    
    Parameters:
    
    acc_len - the acc_len to set
  - getAcc_x
```
public double getAcc_x()
```
    X component of acceleration.
    
    Returns:
    
    the acc_x
  - setAcc_x
```
public void setAcc_x(double acc_x)
```
    X component of acceleration.
    
    Parameters:
    
    acc_x - the acc_x to set
  - getAcc_y
```
public double getAcc_y()
```
    Y component of acceleration.
    
    Returns:
    
    the acc_y
  - setAcc_y
```
public void setAcc_y(double acc_y)
```
    Y component of acceleration.
    
    Parameters:
    
    acc_y - the acc_y to set
  - getAcc_z
```
public double getAcc_z()
```
    Z component of acceleration.
    
    Returns:
    
    the acc_z
  - setAcc_z
```
public void setAcc_z(double acc_z)
```
    Z component of acceleration.
    
    Parameters:
    
    acc_z - the acc_z to set
  - getGyro_x
```
public double getGyro_x()
```
    X component of acceleration.
    
    Returns:
    
    the gyro_x
  - setGyro_x
```
public void setGyro_x(double gyro_x)
```
    X component of acceleration.
    
    Parameters:
    
    gyro_x - the gyro_x to set
  - getGyro_y
```
public double getGyro_y()
```
    Y component of acceleration.
    
    Returns:
    
    the gyro_y
  - setGyro_y
```
public void setGyro_y(double gyro_y)
```
    Y component of acceleration.
    
    Parameters:
    
    gyro_y - the gyro_y to set
  - getDepth
```
public double getDepth()
```
    Water depth in meters.
    
    Returns:
    
    the depth
  - setDepth
```
public void setDepth(double depth)
```
    Water depth in meters.
    
    Parameters:
    
    depth - the depth to set
  - getTemperature
```
public double getTemperature()
```
    Temperature at sensor, degrees centigrade.
    
    Returns:
    
    the temperature
  - setTemperature
```
public void setTemperature(double temperature)
```
    Temperature at sensor, degrees centigrade.
    
    Parameters:
    
    temperature - the temperature to set
  - getMagState
```
public String getMagState()
```
    Magnetometer status.
    
    Returns:
    
    the magState
  - setMagState
```
public void setMagState(String magState)
```
    Magnetometer status.
    
    Parameters:
    
    magState - the magState to set
  - getPitchState
```
public String getPitchState()
```
    Pitch sensor status.
    
    Returns:
    
    the pitchState
  - setPitchState
```
public void setPitchState(String pitchState)
```
    Pitch sensor status.
    
    Parameters:
    
    pitchState - the pitchState to set
  - getYawState
```
public String getYawState()
```
    Yaw sensor status.
    
    Returns:
    
    the yawState
  - setYawState
```
public void setYawState(String yawState)
```
    Yaw sensor status.
    
    Parameters:
    
    yawState - the yawState to set
  - getRollState
```
public String getRollState()
```
    Roll sensor status.
    
    Returns:
    
    the rollState
  - setRollState
```
public void setRollState(String rollState)
```
    Roll sensor status.
    
    Parameters:
    
    rollState - the rollState to set
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ATTObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME

Constructor Detail

ATTObject

Method Detail

getTag

setTag

getDevice

setDevice

getTimestamp

setTimestamp

getHeading

setHeading

getPitch

setPitch

getYaw

setYaw

getRoll

setRoll

getDip

setDip

getMag_len

setMag_len

getMag_x

setMag_x

getMag_y

setMag_y

getMag_z

setMag_z

getAcc_len

setAcc_len

getAcc_x

setAcc_x

getAcc_y

setAcc_y

getAcc_z

setAcc_z

getGyro_x

setGyro_x

getGyro_y

setGyro_y

getDepth

setDepth

getTemperature

setTemperature

getMagState

setMagState

getPitchState

setPitchState

getYawState

setYawState

getRollState

setRollState

toString