pt.lsts.imc

Class FormationEvaluation

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.FormationEvaluation

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<IMCMessage>, IMessage

public class FormationEvaluation
extends IMCMessage

IMC Message Formation Evaluation Data (823)
Formation control performance evaluation variables.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FormationEvaluation.OP
static class	FormationEvaluation.TYPE

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

Constructor Summary

Constructors

Constructor and Description
FormationEvaluation()
FormationEvaluation(FormationEvaluation.TYPE type, FormationEvaluation.OP op, float err_mean, float dist_min_abs, float dist_min_mean, float roll_rate_mean, float time, FormationControlParams ControlParams)
FormationEvaluation(IMCDefinition defs)
FormationEvaluation(IMCMessage msg)

Method Summary

Modifier and Type	Method and Description
static FormationEvaluation	clone(IMCMessage msg)
static FormationEvaluation	create(java.lang.Object... values)
FormationControlParams	getControlParams()
double	getDistMinAbs()
double	getDistMinMean()
double	getErrMean()
FormationEvaluation.OP	getOp()
java.lang.String	getOpStr()
short	getOpVal()
double	getRollRateMean()
double	getTime()
FormationEvaluation.TYPE	getType()
java.lang.String	getTypeStr()
short	getTypeVal()
FormationEvaluation	setControlParams(FormationControlParams ControlParams)
FormationEvaluation	setDistMinAbs(double dist_min_abs)
FormationEvaluation	setDistMinMean(double dist_min_mean)
FormationEvaluation	setErrMean(double err_mean)
FormationEvaluation	setOp(FormationEvaluation.OP op)
FormationEvaluation	setOpStr(java.lang.String op)
FormationEvaluation	setOpVal(short op)
FormationEvaluation	setRollRateMean(double roll_rate_mean)
FormationEvaluation	setTime(double time)
FormationEvaluation	setType(FormationEvaluation.TYPE type)
FormationEvaluation	setTypeStr(java.lang.String type)
FormationEvaluation	setTypeVal(short type)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asJSON, asMap, asXml, asXmlStripped, cloneMessage, cloneMessage, compareTo, copyFrom, 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, main, makeImmutable, parseJson, parseXml, payloadMD5, serialize, serialize, serialize, serializePayload, setBitMask, setDst, setDstEnt, setHeader, setMessageInfo, 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

FormationEvaluation

public FormationEvaluation()

FormationEvaluation

public FormationEvaluation(IMCMessage msg)

FormationEvaluation

public FormationEvaluation(IMCDefinition defs)

FormationEvaluation

public FormationEvaluation(FormationEvaluation.TYPE type,
                           FormationEvaluation.OP op,
                           float err_mean,
                           float dist_min_abs,
                           float dist_min_mean,
                           float roll_rate_mean,
                           float time,
                           FormationControlParams ControlParams)

Method Detail

create

public static FormationEvaluation create(java.lang.Object... values)

clone

public static FormationEvaluation clone(IMCMessage msg)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getType

public FormationEvaluation.TYPE getType()

Returns:

Type (enumerated) - uint8_t

getTypeStr

public java.lang.String getTypeStr()

getTypeVal

public short getTypeVal()

setType

public FormationEvaluation setType(FormationEvaluation.TYPE type)

Parameters:

type - Type (enumerated)

setTypeStr

public FormationEvaluation setTypeStr(java.lang.String type)

Parameters:

type - Type (as a String)

setTypeVal

public FormationEvaluation setTypeVal(short type)

Parameters:

type - Type (integer value)

getOp

public FormationEvaluation.OP getOp()

Returns:

Operation (enumerated) - uint8_t

getOpStr

public java.lang.String getOpStr()

getOpVal

public short getOpVal()

setOp

public FormationEvaluation setOp(FormationEvaluation.OP op)

Parameters:

op - Operation (enumerated)

setOpStr

public FormationEvaluation setOpStr(java.lang.String op)

Parameters:

op - Operation (as a String)

setOpVal

public FormationEvaluation setOpVal(short op)

Parameters:

op - Operation (integer value)

getErrMean

public double getErrMean()

Returns:

Mean Position Error - fp32_t

setErrMean

public FormationEvaluation setErrMean(double err_mean)

Parameters:

err_mean - Mean Position Error

getDistMinAbs

public double getDistMinAbs()

Returns:

Absolute Minimum Distance - fp32_t

setDistMinAbs

public FormationEvaluation setDistMinAbs(double dist_min_abs)

Parameters:

dist_min_abs - Absolute Minimum Distance

getDistMinMean

public double getDistMinMean()

Returns:

Mean Minimum Distance - fp32_t

setDistMinMean

public FormationEvaluation setDistMinMean(double dist_min_mean)

Parameters:

dist_min_mean - Mean Minimum Distance

getRollRateMean

public double getRollRateMean()

Returns:

Mean Roll Rate - fp32_t

setRollRateMean

public FormationEvaluation setRollRateMean(double roll_rate_mean)

Parameters:

roll_rate_mean - Mean Roll Rate

getTime

public double getTime()

Returns:

Evaluation Time - fp32_t

setTime

public FormationEvaluation setTime(double time)

Parameters:

time - Evaluation Time

getControlParams

public FormationControlParams getControlParams()

Returns:

Formation Control Parameters - message

setControlParams

public FormationEvaluation setControlParams(FormationControlParams ControlParams)

Parameters:

ControlParams - Formation Control Parameters