pt.lsts.imc

Class DesiredSpeed

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.ControlCommand

pt.lsts.imc.DesiredSpeed

All Implemented Interfaces:

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

public class DesiredSpeed
extends ControlCommand

IMC Message Desired Speed (402)
Desired Speed reference value for the control layer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DesiredSpeed.SPEED_UNITS

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
DesiredSpeed()
DesiredSpeed(double value, DesiredSpeed.SPEED_UNITS speed_units)
DesiredSpeed(IMCDefinition defs)

Method Summary

Modifier and Type	Method and Description
static DesiredSpeed	clone(IMCMessage msg)
static DesiredSpeed	create(java.lang.Object... values)
DesiredSpeed.SPEED_UNITS	getSpeedUnits() Indicates the units used for the speed value.
double	getValue()
void	setSpeedUnits(DesiredSpeed.SPEED_UNITS speed_units)
void	setSpeedUnits(short speed_units)
void	setSpeedUnits(java.lang.String speed_units)
void	setValue(double value)

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

DesiredSpeed

public DesiredSpeed()

DesiredSpeed

public DesiredSpeed(IMCDefinition defs)

DesiredSpeed

public DesiredSpeed(double value,
                    DesiredSpeed.SPEED_UNITS speed_units)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getValue

public double getValue()

Returns:

Value - fp64_t

getSpeedUnits

public DesiredSpeed.SPEED_UNITS getSpeedUnits()

Indicates the units used for the speed value.

Returns:

Speed Units (enumerated) - uint8_t

setValue

public void setValue(double value)

Parameters:

value - Value

setSpeedUnits

public void setSpeedUnits(DesiredSpeed.SPEED_UNITS speed_units)

Parameters:

speed_units - Speed Units (enumerated)

setSpeedUnits

public void setSpeedUnits(java.lang.String speed_units)

Parameters:

speed_units - Speed Units (as a String)

setSpeedUnits

public void setSpeedUnits(short speed_units)

Parameters:

speed_units - Speed Units (integer value)