RelativeState

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

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<IMCMessage>, IMessage
```
public class RelativeState
extends IMCMessage
```
IMC Message Relative State (482)
Inter-vehicle formation state.

Field Summary

Fields
Modifier and Type Field and Description

static int ID_STATIC
- Fields inherited from class pt.lsts.imc.IMCMessage
  DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Fields
Modifier and Type	Field and Description
`static int`	`ID_STATIC`

Constructor Summary

Constructors
Constructor and Description
`RelativeState()`
`RelativeState(IMCDefinition defs)`
`RelativeState(IMCMessage msg)`
`RelativeState(java.lang.String s_id, float dist, float err, float ctrl_imp, float rel_dir_x, float rel_dir_y, float rel_dir_z, float err_x, float err_y, float err_z, float rf_err_x, float rf_err_y, float rf_err_z, float rf_err_vx, float rf_err_vy, float rf_err_vz, float ss_x, float ss_y, float ss_z, float virt_err_x, float virt_err_y, float virt_err_z)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RelativeState`	`clone(IMCMessage msg)`
`static RelativeState`	`create(java.lang.Object... values)`
`double`	`getCtrlImp()`
`double`	`getDist()`
`double`	`getErr()`
`double`	`getErrX()`
`double`	`getErrY()`
`double`	`getErrZ()`
`double`	`getRelDirX()`
`double`	`getRelDirY()`
`double`	`getRelDirZ()`
`double`	`getRfErrVx()`
`double`	`getRfErrVy()`
`double`	`getRfErrVz()`
`double`	`getRfErrX()`
`double`	`getRfErrY()`
`double`	`getRfErrZ()`
`java.lang.String`	`getSId()`
`double`	`getSsX()`
`double`	`getSsY()`
`double`	`getSsZ()`
`double`	`getVirtErrX()`
`double`	`getVirtErrY()`
`double`	`getVirtErrZ()`
`RelativeState`	`setCtrlImp(double ctrl_imp)`
`RelativeState`	`setDist(double dist)`
`RelativeState`	`setErr(double err)`
`RelativeState`	`setErrX(double err_x)`
`RelativeState`	`setErrY(double err_y)`
`RelativeState`	`setErrZ(double err_z)`
`RelativeState`	`setRelDirX(double rel_dir_x)`
`RelativeState`	`setRelDirY(double rel_dir_y)`
`RelativeState`	`setRelDirZ(double rel_dir_z)`
`RelativeState`	`setRfErrVx(double rf_err_vx)`
`RelativeState`	`setRfErrVy(double rf_err_vy)`
`RelativeState`	`setRfErrVz(double rf_err_vz)`
`RelativeState`	`setRfErrX(double rf_err_x)`
`RelativeState`	`setRfErrY(double rf_err_y)`
`RelativeState`	`setRfErrZ(double rf_err_z)`
`RelativeState`	`setSId(java.lang.String s_id)`
`RelativeState`	`setSsX(double ss_x)`
`RelativeState`	`setSsY(double ss_y)`
`RelativeState`	`setSsZ(double ss_z)`
`RelativeState`	`setVirtErrX(double virt_err_x)`
`RelativeState`	`setVirtErrY(double virt_err_y)`
`RelativeState`	`setVirtErrZ(double virt_err_z)`

Methods inherited from class pt.lsts.imc.IMCMessage
asJSON, asJSON, asMap, asXml, asXmlStripped, cloneMessage, cloneMessage, compareTo, copyFrom, copyToClipoard, decodeTupleList, dump, encodeTupleList, get, getAbbrev, getAgeInSeconds, getAsNumber, getAsString, getBitmask, getDate, getDouble, getDst, getDstEnt, getEntityName, getFieldNames, getFloat, getHeader, getHeaderValue, getInteger, getLong, getLongFieldName, getLongName, getMessage, getMessage, getMessageInfo, getMessageList, getMessageList, getMessageType, getMgid, getPayloadSize, getProtocolFactory, getRawData, getSize, getSourceName, getSrc, getSrcEnt, getString, getString, getTimestamp, getTimestampMillis, getTupleList, getTypeOf, getUnitsOf, getValue, getValues, hasFlag, hexdump, isNull, isPeriodic, makeImmutable, parseJson, parseXml, pasteFromClipoard, payloadMD5, serialize, serialize, serialize, serializePayload, setBitMask, setDst, setDstEnt, setHeader, setMessageInfo, setMessageList, setSrc, setSrcEnt, setTimestamp, setTimestampMillis, setType, setValue, setValues, toByteArray, toByteArray, 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

Constructor Detail

RelativeState
```
public RelativeState()
```

RelativeState
```
public RelativeState(IMCMessage msg)
```

RelativeState

public RelativeState(IMCDefinition defs)

RelativeState

public RelativeState(java.lang.String s_id,
                     float dist,
                     float err,
                     float ctrl_imp,
                     float rel_dir_x,
                     float rel_dir_y,
                     float rel_dir_z,
                     float err_x,
                     float err_y,
                     float err_z,
                     float rf_err_x,
                     float rf_err_y,
                     float rf_err_z,
                     float rf_err_vx,
                     float rf_err_vy,
                     float rf_err_vz,
                     float ss_x,
                     float ss_y,
                     float ss_z,
                     float virt_err_x,
                     float virt_err_y,
                     float virt_err_z)

Method Detail
- create
```
public static RelativeState create(java.lang.Object... values)
```
- clone
```
public static RelativeState clone(IMCMessage msg)
                           throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- getSId
```
public java.lang.String getSId()
```
  Returns:
  
  System Identifier - plaintext
- setSId
```
public RelativeState setSId(java.lang.String s_id)
```
  Parameters:
  
  s_id - System Identifier
- getDist
```
public double getDist()
```
  Returns:
  
  Distance - fp32_t
- setDist
```
public RelativeState setDist(double dist)
```
  Parameters:
  
  dist - Distance
- getErr
```
public double getErr()
```
  Returns:
  
  Position Error - fp32_t
- setErr
```
public RelativeState setErr(double err)
```
  Parameters:
  
  err - Position Error
- getCtrlImp
```
public double getCtrlImp()
```
  Returns:
  
  Control Importance - fp32_t
- setCtrlImp
```
public RelativeState setCtrlImp(double ctrl_imp)
```
  Parameters:
  
  ctrl_imp - Control Importance
- getRelDirX
```
public double getRelDirX()
```
  Returns:
  
  Relative Direction X (North) - fp32_t
- setRelDirX
```
public RelativeState setRelDirX(double rel_dir_x)
```
  Parameters:
  
  rel_dir_x - Relative Direction X (North)
- getRelDirY
```
public double getRelDirY()
```
  Returns:
  
  Relative Direction Y (East) - fp32_t
- setRelDirY
```
public RelativeState setRelDirY(double rel_dir_y)
```
  Parameters:
  
  rel_dir_y - Relative Direction Y (East)
- getRelDirZ
```
public double getRelDirZ()
```
  Returns:
  
  Relative Direction Z (Down) - fp32_t
- setRelDirZ
```
public RelativeState setRelDirZ(double rel_dir_z)
```
  Parameters:
  
  rel_dir_z - Relative Direction Z (Down)
- getErrX
```
public double getErrX()
```
  Returns:
  
  X Position Error (North) - fp32_t
- setErrX
```
public RelativeState setErrX(double err_x)
```
  Parameters:
  
  err_x - X Position Error (North)
- getErrY
```
public double getErrY()
```
  Returns:
  
  Y Position Error (East) - fp32_t
- setErrY
```
public RelativeState setErrY(double err_y)
```
  Parameters:
  
  err_y - Y Position Error (East)
- getErrZ
```
public double getErrZ()
```
  Returns:
  
  Z Position Error (Down) - fp32_t
- setErrZ
```
public RelativeState setErrZ(double err_z)
```
  Parameters:
  
  err_z - Z Position Error (Down)
- getRfErrX
```
public double getRfErrX()
```
  Returns:
  
  X Position Error In Relative Frame (North) - fp32_t
- setRfErrX
```
public RelativeState setRfErrX(double rf_err_x)
```
  Parameters:
  
  rf_err_x - X Position Error In Relative Frame (North)
- getRfErrY
```
public double getRfErrY()
```
  Returns:
  
  Y Position Error In Relative Frame (East) - fp32_t
- setRfErrY
```
public RelativeState setRfErrY(double rf_err_y)
```
  Parameters:
  
  rf_err_y - Y Position Error In Relative Frame (East)
- getRfErrZ
```
public double getRfErrZ()
```
  Returns:
  
  Z Position Error In Relative Frame (Down) - fp32_t
- setRfErrZ
```
public RelativeState setRfErrZ(double rf_err_z)
```
  Parameters:
  
  rf_err_z - Z Position Error In Relative Frame (Down)
- getRfErrVx
```
public double getRfErrVx()
```
  Returns:
  
  X Velocity Error In Relative Frame (North) - fp32_t
- setRfErrVx
```
public RelativeState setRfErrVx(double rf_err_vx)
```
  Parameters:
  
  rf_err_vx - X Velocity Error In Relative Frame (North)
- getRfErrVy
```
public double getRfErrVy()
```
  Returns:
  
  Y Velocity Error In Relative Frame (East) - fp32_t
- setRfErrVy
```
public RelativeState setRfErrVy(double rf_err_vy)
```
  Parameters:
  
  rf_err_vy - Y Velocity Error In Relative Frame (East)
- getRfErrVz
```
public double getRfErrVz()
```
  Returns:
  
  Z Velocity Error In Relative Frame (Down) - fp32_t
- setRfErrVz
```
public RelativeState setRfErrVz(double rf_err_vz)
```
  Parameters:
  
  rf_err_vz - Z Velocity Error In Relative Frame (Down)
- getSsX
```
public double getSsX()
```
  Returns:
  
  X Convergence Deviation (North) - fp32_t
- setSsX
```
public RelativeState setSsX(double ss_x)
```
  Parameters:
  
  ss_x - X Convergence Deviation (North)
- getSsY
```
public double getSsY()
```
  Returns:
  
  Y Convergence Deviation (East) - fp32_t
- setSsY
```
public RelativeState setSsY(double ss_y)
```
  Parameters:
  
  ss_y - Y Convergence Deviation (East)
- getSsZ
```
public double getSsZ()
```
  Returns:
  
  Z Convergence Deviation (Down) - fp32_t
- setSsZ
```
public RelativeState setSsZ(double ss_z)
```
  Parameters:
  
  ss_z - Z Convergence Deviation (Down)
- getVirtErrX
```
public double getVirtErrX()
```
  Returns:
  
  X Virtual Error (North) - fp32_t
- setVirtErrX
```
public RelativeState setVirtErrX(double virt_err_x)
```
  Parameters:
  
  virt_err_x - X Virtual Error (North)
- getVirtErrY
```
public double getVirtErrY()
```
  Returns:
  
  Y Virtual Error (East) - fp32_t
- setVirtErrY
```
public RelativeState setVirtErrY(double virt_err_y)
```
  Parameters:
  
  virt_err_y - Y Virtual Error (East)
- getVirtErrZ
```
public double getVirtErrZ()
```
  Returns:
  
  Z Virtual Error (Down) - fp32_t
- setVirtErrZ
```
public RelativeState setVirtErrZ(double virt_err_z)
```
  Parameters:
  
  virt_err_z - Z Virtual Error (Down)

Class RelativeState

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

Constructor Detail

RelativeState

RelativeState

RelativeState

RelativeState

Method Detail

create

clone

getSId

setSId

getDist

setDist

getErr

setErr

getCtrlImp

setCtrlImp

getRelDirX

setRelDirX

getRelDirY

setRelDirY

getRelDirZ

setRelDirZ

getErrX

setErrX

getErrY

setErrY

getErrZ

setErrZ

getRfErrX

setRfErrX

getRfErrY

setRfErrY

getRfErrZ

setRfErrZ

getRfErrVx

setRfErrVx

getRfErrVy

setRfErrVy

getRfErrVz

setRfErrVz

getSsX

setSsX

getSsY

setSsY

getSsZ

setSsZ

getVirtErrX

setVirtErrX

getVirtErrY

setVirtErrY

getVirtErrZ

setVirtErrZ