FormationMonitor

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

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<IMCMessage>, IMessage
```
public class FormationMonitor
extends IMCMessage
```
IMC Message Formation Monitoring Data (481)
Monitoring variables for the formation state and performance.

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
`FormationMonitor()`
`FormationMonitor(float ax_cmd, float ay_cmd, float az_cmd, float ax_des, float ay_des, float az_des, float virt_err_x, float virt_err_y, float virt_err_z, float surf_fdbk_x, float surf_fdbk_y, float surf_fdbk_z, float surf_unkn_x, float surf_unkn_y, float surf_unkn_z, float ss_x, float ss_y, float ss_z, java.util.Collection<RelativeState> rel_state)`
`FormationMonitor(IMCDefinition defs)`
`FormationMonitor(IMCMessage msg)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FormationMonitor`	`clone(IMCMessage msg)`
`static FormationMonitor`	`create(java.lang.Object... values)`
`double`	`getAxCmd()`
`double`	`getAxDes()`
`double`	`getAyCmd()`
`double`	`getAyDes()`
`double`	`getAzCmd()`
`double`	`getAzDes()`
`java.util.Vector<RelativeState>`	`getRelState()`
`double`	`getSsX()`
`double`	`getSsY()`
`double`	`getSsZ()`
`double`	`getSurfFdbkX()`
`double`	`getSurfFdbkY()`
`double`	`getSurfFdbkZ()`
`double`	`getSurfUnknX()`
`double`	`getSurfUnknY()`
`double`	`getSurfUnknZ()`
`double`	`getVirtErrX()`
`double`	`getVirtErrY()`
`double`	`getVirtErrZ()`
`FormationMonitor`	`setAxCmd(double ax_cmd)`
`FormationMonitor`	`setAxDes(double ax_des)`
`FormationMonitor`	`setAyCmd(double ay_cmd)`
`FormationMonitor`	`setAyDes(double ay_des)`
`FormationMonitor`	`setAzCmd(double az_cmd)`
`FormationMonitor`	`setAzDes(double az_des)`
`FormationMonitor`	`setRelState(java.util.Collection<RelativeState> rel_state)`
`FormationMonitor`	`setSsX(double ss_x)`
`FormationMonitor`	`setSsY(double ss_y)`
`FormationMonitor`	`setSsZ(double ss_z)`
`FormationMonitor`	`setSurfFdbkX(double surf_fdbk_x)`
`FormationMonitor`	`setSurfFdbkY(double surf_fdbk_y)`
`FormationMonitor`	`setSurfFdbkZ(double surf_fdbk_z)`
`FormationMonitor`	`setSurfUnknX(double surf_unkn_x)`
`FormationMonitor`	`setSurfUnknY(double surf_unkn_y)`
`FormationMonitor`	`setSurfUnknZ(double surf_unkn_z)`
`FormationMonitor`	`setVirtErrX(double virt_err_x)`
`FormationMonitor`	`setVirtErrY(double virt_err_y)`
`FormationMonitor`	`setVirtErrZ(double virt_err_z)`

Methods inherited from class pt.lsts.imc.IMCMessage
asJSON, asXml, asXmlStripped, 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

Constructor Detail

FormationMonitor
```
public FormationMonitor()
```

FormationMonitor

public FormationMonitor(IMCMessage msg)

FormationMonitor

public FormationMonitor(IMCDefinition defs)

FormationMonitor

public FormationMonitor(float ax_cmd,
                        float ay_cmd,
                        float az_cmd,
                        float ax_des,
                        float ay_des,
                        float az_des,
                        float virt_err_x,
                        float virt_err_y,
                        float virt_err_z,
                        float surf_fdbk_x,
                        float surf_fdbk_y,
                        float surf_fdbk_z,
                        float surf_unkn_x,
                        float surf_unkn_y,
                        float surf_unkn_z,
                        float ss_x,
                        float ss_y,
                        float ss_z,
                        java.util.Collection<RelativeState> rel_state)

Method Detail
- create
```
public static FormationMonitor create(java.lang.Object... values)
```
- clone
```
public static FormationMonitor clone(IMCMessage msg)
                              throws java.lang.Exception
```
  Throws:
  
  java.lang.Exception
- getAxCmd
```
public double getAxCmd()
```
  Returns:
  
  Commanded X Acceleration (North) - fp32_t
- getAyCmd
```
public double getAyCmd()
```
  Returns:
  
  Commanded Y Acceleration (East) - fp32_t
- getAzCmd
```
public double getAzCmd()
```
  Returns:
  
  Commanded Z Acceleration (Down) - fp32_t
- getAxDes
```
public double getAxDes()
```
  Returns:
  
  Desired X Acceleration (North) - fp32_t
- getAyDes
```
public double getAyDes()
```
  Returns:
  
  Desired Y Acceleration (East) - fp32_t
- getAzDes
```
public double getAzDes()
```
  Returns:
  
  Desired Z Acceleration (Down) - fp32_t
- getVirtErrX
```
public double getVirtErrX()
```
  Returns:
  
  X Virtual Error (North) - fp32_t
- getVirtErrY
```
public double getVirtErrY()
```
  Returns:
  
  Y Virtual Error (East) - fp32_t
- getVirtErrZ
```
public double getVirtErrZ()
```
  Returns:
  
  Z Virtual Error (Down) - fp32_t
- getSurfFdbkX
```
public double getSurfFdbkX()
```
  Returns:
  
  X Sliding Surface Feedback (North) - fp32_t
- getSurfFdbkY
```
public double getSurfFdbkY()
```
  Returns:
  
  Y Sliding Surface Feedback (East) - fp32_t
- getSurfFdbkZ
```
public double getSurfFdbkZ()
```
  Returns:
  
  Z Sliding Surface Feedback (Down) - fp32_t
- getSurfUnknX
```
public double getSurfUnknX()
```
  Returns:
  
  X Uncertainty Compensation (North) - fp32_t
- getSurfUnknY
```
public double getSurfUnknY()
```
  Returns:
  
  Y Uncertainty Compensation (East) - fp32_t
- getSurfUnknZ
```
public double getSurfUnknZ()
```
  Returns:
  
  Z Uncertainty Compensation (Down) - fp32_t
- getSsX
```
public double getSsX()
```
  Returns:
  
  X Convergence Deviation (North) - fp32_t
- getSsY
```
public double getSsY()
```
  Returns:
  
  Y Convergence Deviation (East) - fp32_t
- getSsZ
```
public double getSsZ()
```
  Returns:
  
  Z Convergence Deviation (Down) - fp32_t
- getRelState
```
public java.util.Vector<RelativeState> getRelState()
```
  Returns:
  
  Relative State - message-list
- setAxCmd
```
public FormationMonitor setAxCmd(double ax_cmd)
```
  Parameters:
  
  ax_cmd - Commanded X Acceleration (North)
- setAyCmd
```
public FormationMonitor setAyCmd(double ay_cmd)
```
  Parameters:
  
  ay_cmd - Commanded Y Acceleration (East)
- setAzCmd
```
public FormationMonitor setAzCmd(double az_cmd)
```
  Parameters:
  
  az_cmd - Commanded Z Acceleration (Down)
- setAxDes
```
public FormationMonitor setAxDes(double ax_des)
```
  Parameters:
  
  ax_des - Desired X Acceleration (North)
- setAyDes
```
public FormationMonitor setAyDes(double ay_des)
```
  Parameters:
  
  ay_des - Desired Y Acceleration (East)
- setAzDes
```
public FormationMonitor setAzDes(double az_des)
```
  Parameters:
  
  az_des - Desired Z Acceleration (Down)
- setVirtErrX
```
public FormationMonitor setVirtErrX(double virt_err_x)
```
  Parameters:
  
  virt_err_x - X Virtual Error (North)
- setVirtErrY
```
public FormationMonitor setVirtErrY(double virt_err_y)
```
  Parameters:
  
  virt_err_y - Y Virtual Error (East)
- setVirtErrZ
```
public FormationMonitor setVirtErrZ(double virt_err_z)
```
  Parameters:
  
  virt_err_z - Z Virtual Error (Down)
- setSurfFdbkX
```
public FormationMonitor setSurfFdbkX(double surf_fdbk_x)
```
  Parameters:
  
  surf_fdbk_x - X Sliding Surface Feedback (North)
- setSurfFdbkY
```
public FormationMonitor setSurfFdbkY(double surf_fdbk_y)
```
  Parameters:
  
  surf_fdbk_y - Y Sliding Surface Feedback (East)
- setSurfFdbkZ
```
public FormationMonitor setSurfFdbkZ(double surf_fdbk_z)
```
  Parameters:
  
  surf_fdbk_z - Z Sliding Surface Feedback (Down)
- setSurfUnknX
```
public FormationMonitor setSurfUnknX(double surf_unkn_x)
```
  Parameters:
  
  surf_unkn_x - X Uncertainty Compensation (North)
- setSurfUnknY
```
public FormationMonitor setSurfUnknY(double surf_unkn_y)
```
  Parameters:
  
  surf_unkn_y - Y Uncertainty Compensation (East)
- setSurfUnknZ
```
public FormationMonitor setSurfUnknZ(double surf_unkn_z)
```
  Parameters:
  
  surf_unkn_z - Z Uncertainty Compensation (Down)
- setSsX
```
public FormationMonitor setSsX(double ss_x)
```
  Parameters:
  
  ss_x - X Convergence Deviation (North)
- setSsY
```
public FormationMonitor setSsY(double ss_y)
```
  Parameters:
  
  ss_y - Y Convergence Deviation (East)
- setSsZ
```
public FormationMonitor setSsZ(double ss_z)
```
  Parameters:
  
  ss_z - Z Convergence Deviation (Down)
- setRelState
```
public FormationMonitor setRelState(java.util.Collection<RelativeState> rel_state)
```
  Parameters:
  
  rel_state - Relative State

Class FormationMonitor

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

FormationMonitor

FormationMonitor

FormationMonitor

FormationMonitor

Method Detail

create

clone

getAxCmd

getAyCmd

getAzCmd

getAxDes

getAyDes

getAzDes

getVirtErrX

getVirtErrY

getVirtErrZ

getSurfFdbkX

getSurfFdbkY

getSurfFdbkZ

getSurfUnknX

getSurfUnknY

getSurfUnknZ

getSsX

getSsY

getSsZ

getRelState

setAxCmd

setAyCmd

setAzCmd

setAxDes

setAyDes

setAzDes

setVirtErrX

setVirtErrY

setVirtErrZ

setSurfFdbkX

setSurfFdbkY

setSurfFdbkZ

setSurfUnknX

setSurfUnknY

setSurfUnknZ

setSsX

setSsY

setSsZ

setRelState