pt.lsts.imc

Class FormCtrlParam

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.FormCtrlParam

All Implemented Interfaces:

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

public class FormCtrlParam
extends IMCMessage

IMC Message Formation Control Parameters (820)
Formation controller paramenters, as: trajectory gains, control boundary layer thickness, and formation shape gains.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FormCtrlParam.ACTION

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
FormCtrlParam()
FormCtrlParam(FormCtrlParam.ACTION Action, long LonGain, long LatGain, long BondThick, long LeadGain, long DeconflGain)
FormCtrlParam(IMCDefinition defs)

Method Summary

Modifier and Type	Method and Description
static FormCtrlParam	clone(IMCMessage msg)
static FormCtrlParam	create(java.lang.Object... values)
FormCtrlParam.ACTION	getAction() Action on the vehicle formation control parameters.
long	getBondThick()
long	getDeconflGain()
long	getLatGain()
long	getLeadGain()
long	getLonGain()
void	setAction(FormCtrlParam.ACTION Action)
void	setAction(short Action)
void	setAction(java.lang.String Action)
void	setBondThick(long BondThick)
void	setDeconflGain(long DeconflGain)
void	setLatGain(long LatGain)
void	setLeadGain(long LeadGain)
void	setLonGain(long LonGain)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asXml, cloneMessage, cloneMessage, compareTo, 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, hasFlag, hexdump, isNull, isPeriodic, main, makeImmutable, parseXml, payloadMD5, serialize, serialize, setBitMask, setDst, setDstEnt, setHeader, setMessage, 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

FormCtrlParam

public FormCtrlParam()

FormCtrlParam

public FormCtrlParam(IMCDefinition defs)

FormCtrlParam

public FormCtrlParam(FormCtrlParam.ACTION Action,
                     long LonGain,
                     long LatGain,
                     long BondThick,
                     long LeadGain,
                     long DeconflGain)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getAction

public FormCtrlParam.ACTION getAction()

Action on the vehicle formation control parameters.

Returns:

Action (enumerated) - uint8_t

getLonGain

public long getLonGain()

Returns:

Longitudinal Gain - uint32_t

getLatGain

public long getLatGain()

Returns:

Lateral Gain - uint32_t

getBondThick

public long getBondThick()

Returns:

Boundary Layer Thickness - uint32_t

getLeadGain

public long getLeadGain()

Returns:

Leader Gain - uint32_t

getDeconflGain

public long getDeconflGain()

Returns:

Deconfliction Gain - uint32_t

setAction

public void setAction(FormCtrlParam.ACTION Action)

Parameters:

Action - Action (enumerated)

setAction

public void setAction(java.lang.String Action)

Parameters:

Action - Action (as a String)

setAction

public void setAction(short Action)

Parameters:

Action - Action (integer value)

setLonGain

public void setLonGain(long LonGain)

Parameters:

LonGain - Longitudinal Gain

setLatGain

public void setLatGain(long LatGain)

Parameters:

LatGain - Lateral Gain

setBondThick

public void setBondThick(long BondThick)

Parameters:

BondThick - Boundary Layer Thickness

setLeadGain

public void setLeadGain(long LeadGain)

Parameters:

LeadGain - Leader Gain

setDeconflGain

public void setDeconflGain(long DeconflGain)

Parameters:

DeconflGain - Deconfliction Gain