pt.lsts.imc

Class DevCalibrationState

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.DevCalibrationState

All Implemented Interfaces:

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

public class DevCalibrationState
extends IMCMessage

IMC Message Device Calibration State (13)
State of the calibration procedure.

Field Summary

Fields

Modifier and Type	Field and Description
static short	DCS_COMPLETED
static short	DCS_ERROR
static short	DCS_NEXT_NOT_SUPPORTED
static short	DCS_PREVIOUS_NOT_SUPPORTED
static short	DCS_WAITING_CONTROL
static int	ID_STATIC

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
DevCalibrationState()
DevCalibrationState(IMCDefinition defs)
DevCalibrationState(IMCMessage msg)
DevCalibrationState(short total_steps, short step_number, java.lang.String step, short flags)

Method Summary

Modifier and Type	Method and Description
static DevCalibrationState	clone(IMCMessage msg)
static DevCalibrationState	create(java.lang.Object... values)
short	getFlags()
java.lang.String	getStep()
short	getStepNumber()
short	getTotalSteps()
DevCalibrationState	setFlags(short flags)
DevCalibrationState	setStep(java.lang.String step)
DevCalibrationState	setStepNumber(short step_number)
DevCalibrationState	setTotalSteps(short total_steps)

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

DCS_PREVIOUS_NOT_SUPPORTED

public static final short DCS_PREVIOUS_NOT_SUPPORTED

See Also:

Constant Field Values

DCS_NEXT_NOT_SUPPORTED

public static final short DCS_NEXT_NOT_SUPPORTED

See Also:

Constant Field Values

DCS_WAITING_CONTROL

public static final short DCS_WAITING_CONTROL

See Also:

Constant Field Values

DCS_ERROR

public static final short DCS_ERROR

See Also:

Constant Field Values

DCS_COMPLETED

public static final short DCS_COMPLETED

See Also:

Constant Field Values

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

DevCalibrationState

public DevCalibrationState()

DevCalibrationState

public DevCalibrationState(IMCMessage msg)

DevCalibrationState

public DevCalibrationState(IMCDefinition defs)

DevCalibrationState

public DevCalibrationState(short total_steps,
                           short step_number,
                           java.lang.String step,
                           short flags)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getTotalSteps

public short getTotalSteps()

Returns:

Total Steps - uint8_t

setTotalSteps

public DevCalibrationState setTotalSteps(short total_steps)

Parameters:

total_steps - Total Steps

getStepNumber

public short getStepNumber()

Returns:

Current Step Number - uint8_t

setStepNumber

public DevCalibrationState setStepNumber(short step_number)

Parameters:

step_number - Current Step Number

getStep

public java.lang.String getStep()

Returns:

Description - plaintext

setStep

public DevCalibrationState setStep(java.lang.String step)

Parameters:

step - Description

getFlags

public short getFlags()

Returns:

Flags (bitfield) - uint8_t

setFlags

public DevCalibrationState setFlags(short flags)

Parameters:

flags - Flags (bitfield)