PathControlState

java.lang.Object
- pt.lsts.imc.IMCMessage
- - pt.lsts.imc.PathControlState

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<IMCMessage>, IMessage
```
public class PathControlState
extends IMCMessage
```
IMC Message Path Control State (410)
Path control state issued by Path Controller.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PathControlState.END_Z_UNITS

static class PathControlState.START_Z_UNITS

Nested Classes
Modifier and Type	Class and Description
`static class`	`PathControlState.END_Z_UNITS`
`static class`	`PathControlState.START_Z_UNITS`

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`FL_3DTRACK`
`static short`	`FL_CCLOCKW`
`static short`	`FL_LOITERING`
`static short`	`FL_NEAR`
`static short`	`FL_NO_Z`
`static int`	`ID_STATIC`

Fields inherited from class pt.lsts.imc.IMCMessage
DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors
Constructor and Description
`PathControlState()`
`PathControlState(double start_lat, double start_lon, float start_z, PathControlState.START_Z_UNITS start_z_units, double end_lat, double end_lon, float end_z, PathControlState.END_Z_UNITS end_z_units, float lradius, short flags, float x, float y, float z, float vx, float vy, float vz, float course_error, int eta)`
`PathControlState(IMCDefinition defs)`
`PathControlState(IMCMessage msg)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PathControlState`	`clone(IMCMessage msg)`
`static PathControlState`	`create(java.lang.Object... values)`
`double`	`getCourseError()`
`double`	`getEndLat()`
`double`	`getEndLon()`
`double`	`getEndZ()`
`PathControlState.END_Z_UNITS`	`getEndZUnits()` Units of the end point's z reference.
`int`	`getEta()`
`short`	`getFlags()` Path control state flags.
`double`	`getLradius()`
`double`	`getStartLat()`
`double`	`getStartLon()`
`double`	`getStartZ()`
`PathControlState.START_Z_UNITS`	`getStartZUnits()` Units of the start point's z reference.
`double`	`getVx()`
`double`	`getVy()`
`double`	`getVz()`
`double`	`getX()`
`double`	`getY()`
`double`	`getZ()`
`PathControlState`	`setCourseError(double course_error)`
`PathControlState`	`setEndLat(double end_lat)`
`PathControlState`	`setEndLon(double end_lon)`
`PathControlState`	`setEndZ(double end_z)`
`PathControlState`	`setEndZUnits(PathControlState.END_Z_UNITS end_z_units)`
`PathControlState`	`setEndZUnits(short end_z_units)`
`PathControlState`	`setEndZUnits(java.lang.String end_z_units)`
`PathControlState`	`setEta(int eta)`
`PathControlState`	`setFlags(short flags)`
`PathControlState`	`setLradius(double lradius)`
`PathControlState`	`setStartLat(double start_lat)`
`PathControlState`	`setStartLon(double start_lon)`
`PathControlState`	`setStartZ(double start_z)`
`PathControlState`	`setStartZUnits(PathControlState.START_Z_UNITS start_z_units)`
`PathControlState`	`setStartZUnits(short start_z_units)`
`PathControlState`	`setStartZUnits(java.lang.String start_z_units)`
`PathControlState`	`setVx(double vx)`
`PathControlState`	`setVy(double vy)`
`PathControlState`	`setVz(double vz)`
`PathControlState`	`setX(double x)`
`PathControlState`	`setY(double y)`
`PathControlState`	`setZ(double z)`

Methods inherited from class pt.lsts.imc.IMCMessage
asJSON, asXml, cloneMessage, cloneMessage, compareTo, copyFrom, decodeTupleList, dump, encodeTupleList, get, getAbbrev, getAsNumber, getAsString, getBitmask, getDate, getDouble, getDst, getDstEnt, getFieldNames, getFloat, getHeader, getHeaderValue, getInteger, getLong, getLongFieldName, getLongName, getMessage, getMessage, getMessageList, getMessageList, getMessageType, getMgid, getPayloadSize, getProtocolFactory, getRawData, getSize, getSourceName, getSrc, getSrcEnt, getString, getString, getTimestamp, getTimestampMillis, getTupleList, getTypeOf, getUnitsOf, getValue, getValues, hasFlag, hexdump, isNull, isPeriodic, main, makeImmutable, parseXml, payloadMD5, serialize, serialize, setBitMask, setDst, setDstEnt, setHeader, setMessageList, setSrc, setSrcEnt, setTimestamp, setTimestampMillis, setType, setValue, setValues, toString, validate

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

Field Detail
- ID_STATIC
```
public static final int ID_STATIC
```
  See Also:
  
  Constant Field Values
- FL_NEAR
```
public static final short FL_NEAR
```
  See Also:
  
  Constant Field Values
- FL_LOITERING
```
public static final short FL_LOITERING
```
  See Also:
  
  Constant Field Values
- FL_NO_Z
```
public static final short FL_NO_Z
```
  See Also:
  
  Constant Field Values
- FL_3DTRACK
```
public static final short FL_3DTRACK
```
  See Also:
  
  Constant Field Values
- FL_CCLOCKW
```
public static final short FL_CCLOCKW
```
  See Also:
  
  Constant Field Values

Constructor Detail

PathControlState
```
public PathControlState()
```

PathControlState

public PathControlState(IMCMessage msg)

PathControlState

public PathControlState(IMCDefinition defs)

PathControlState

public PathControlState(double start_lat,
                        double start_lon,
                        float start_z,
                        PathControlState.START_Z_UNITS start_z_units,
                        double end_lat,
                        double end_lon,
                        float end_z,
                        PathControlState.END_Z_UNITS end_z_units,
                        float lradius,
                        short flags,
                        float x,
                        float y,
                        float z,
                        float vx,
                        float vy,
                        float vz,
                        float course_error,
                        int eta)

Method Detail
- create
```
public static PathControlState create(java.lang.Object... values)
```
- clone
```
public static PathControlState clone(IMCMessage msg)
                              throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- getStartLat
```
public double getStartLat()
```
  Returns:
  
  Start Point -- Latitude WGS-84 (rad) - fp64_t
- getStartLon
```
public double getStartLon()
```
  Returns:
  
  Start Point -- WGS-84 Longitude (rad) - fp64_t
- getStartZ
```
public double getStartZ()
```
  Returns:
  
  Start Point -- Z Reference (m) - fp32_t
- getStartZUnits
```
public PathControlState.START_Z_UNITS getStartZUnits()
```
  Units of the start point's z reference.
  
  Returns:
  
  Start Point -- Z Units (enumerated) - uint8_t
- getEndLat
```
public double getEndLat()
```
  Returns:
  
  End Point -- Latitude WGS-84 (rad) - fp64_t
- getEndLon
```
public double getEndLon()
```
  Returns:
  
  End Point -- WGS-84 Longitude (rad) - fp64_t
- getEndZ
```
public double getEndZ()
```
  Returns:
  
  End Point -- Z Reference (m) - fp32_t
- getEndZUnits
```
public PathControlState.END_Z_UNITS getEndZUnits()
```
  Units of the end point's z reference.
  
  Returns:
  
  End Point -- Z Units (enumerated) - uint8_t
- getLradius
```
public double getLradius()
```
  Returns:
  
  Loiter -- Radius (m) - fp32_t
- getFlags
```
public short getFlags()
```
  Path control state flags.
  
  Returns:
  
  Flags (bitfield) - uint8_t
- getX
```
public double getX()
```
  Returns:
  
  Along Track Position (m) - fp32_t
- getY
```
public double getY()
```
  Returns:
  
  Cross Track Position (m) - fp32_t
- getZ
```
public double getZ()
```
  Returns:
  
  Vertical Track Position (m) - fp32_t
- getVx
```
public double getVx()
```
  Returns:
  
  Along Track Velocity (m/s) - fp32_t
- getVy
```
public double getVy()
```
  Returns:
  
  Cross Track Velocity (m/s) - fp32_t
- getVz
```
public double getVz()
```
  Returns:
  
  Vertical Track Velocity (m/s) - fp32_t
- getCourseError
```
public double getCourseError()
```
  Returns:
  
  Course Error (rad) - fp32_t
- getEta
```
public int getEta()
```
  Returns:
  
  Estimated Time to Arrival (ETA) (s) - uint16_t
- setStartLat
```
public PathControlState setStartLat(double start_lat)
```
  Parameters:
  
  start_lat - Start Point -- Latitude WGS-84 (rad)
- setStartLon
```
public PathControlState setStartLon(double start_lon)
```
  Parameters:
  
  start_lon - Start Point -- WGS-84 Longitude (rad)
- setStartZ
```
public PathControlState setStartZ(double start_z)
```
  Parameters:
  
  start_z - Start Point -- Z Reference (m)
- setStartZUnits
```
public PathControlState setStartZUnits(PathControlState.START_Z_UNITS start_z_units)
```
  Parameters:
  
  start_z_units - Start Point -- Z Units (enumerated)
- setStartZUnits
```
public PathControlState setStartZUnits(java.lang.String start_z_units)
```
  Parameters:
  
  start_z_units - Start Point -- Z Units (as a String)
- setStartZUnits
```
public PathControlState setStartZUnits(short start_z_units)
```
  Parameters:
  
  start_z_units - Start Point -- Z Units (integer value)
- setEndLat
```
public PathControlState setEndLat(double end_lat)
```
  Parameters:
  
  end_lat - End Point -- Latitude WGS-84 (rad)
- setEndLon
```
public PathControlState setEndLon(double end_lon)
```
  Parameters:
  
  end_lon - End Point -- WGS-84 Longitude (rad)
- setEndZ
```
public PathControlState setEndZ(double end_z)
```
  Parameters:
  
  end_z - End Point -- Z Reference (m)
- setEndZUnits
```
public PathControlState setEndZUnits(PathControlState.END_Z_UNITS end_z_units)
```
  Parameters:
  
  end_z_units - End Point -- Z Units (enumerated)
- setEndZUnits
```
public PathControlState setEndZUnits(java.lang.String end_z_units)
```
  Parameters:
  
  end_z_units - End Point -- Z Units (as a String)
- setEndZUnits
```
public PathControlState setEndZUnits(short end_z_units)
```
  Parameters:
  
  end_z_units - End Point -- Z Units (integer value)
- setLradius
```
public PathControlState setLradius(double lradius)
```
  Parameters:
  
  lradius - Loiter -- Radius (m)
- setFlags
```
public PathControlState setFlags(short flags)
```
  Parameters:
  
  flags - Flags (bitfield)
- setX
```
public PathControlState setX(double x)
```
  Parameters:
  
  x - Along Track Position (m)
- setY
```
public PathControlState setY(double y)
```
  Parameters:
  
  y - Cross Track Position (m)
- setZ
```
public PathControlState setZ(double z)
```
  Parameters:
  
  z - Vertical Track Position (m)
- setVx
```
public PathControlState setVx(double vx)
```
  Parameters:
  
  vx - Along Track Velocity (m/s)
- setVy
```
public PathControlState setVy(double vy)
```
  Parameters:
  
  vy - Cross Track Velocity (m/s)
- setVz
```
public PathControlState setVz(double vz)
```
  Parameters:
  
  vz - Vertical Track Velocity (m/s)
- setCourseError
```
public PathControlState setCourseError(double course_error)
```
  Parameters:
  
  course_error - Course Error (rad)
- setEta
```
public PathControlState setEta(int eta)
```
  Parameters:
  
  eta - Estimated Time to Arrival (ETA) (s)

Class PathControlState

Nested Class Summary

Field Summary

Fields inherited from class pt.lsts.imc.IMCMessage

Constructor Summary

Method Summary

Methods inherited from class pt.lsts.imc.IMCMessage

Methods inherited from class java.lang.Object

Field Detail

ID_STATIC

FL_NEAR

FL_LOITERING

FL_NO_Z

FL_3DTRACK

FL_CCLOCKW

Constructor Detail

PathControlState

PathControlState

PathControlState

PathControlState

Method Detail

create

clone

getStartLat

getStartLon

getStartZ

getStartZUnits

getEndLat

getEndLon

getEndZ

getEndZUnits

getLradius

getFlags

getX

getY

getZ

getVx

getVy

getVz

getCourseError

getEta

setStartLat

setStartLon

setStartZ

setStartZUnits

setStartZUnits

setStartZUnits

setEndLat

setEndLon

setEndZ

setEndZUnits

setEndZUnits

setEndZUnits

setLradius

setFlags

setX

setY

setZ

setVx

setVy

setVz

setCourseError

setEta