pt.lsts.imc

Class PlanControl

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.PlanControl

All Implemented Interfaces:

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

public class PlanControl
extends IMCMessage

IMC Message Plan Control (559)
Plan control request/reply.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLG_CALIBRATE
static int	FLG_IGNORE_ERRORS
static int	ID_STATIC

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
PlanControl()
PlanControl(IMCDefinition defs)
PlanControl(IMCMessage msg)
PlanControl(PlanControl.TYPE type, PlanControl.OP op, int request_id, java.lang.String plan_id, int flags, IMCMessage arg, java.lang.String info)

Method Summary

Modifier and Type	Method and Description
static PlanControl	clone(IMCMessage msg)
static PlanControl	create(java.lang.Object... values)
IMCMessage	getArg()
<T extends IMCMessage> T	getArg(java.lang.Class<T> clazz)
int	getFlags()
java.lang.String	getInfo()
PlanControl.OP	getOp()
java.lang.String	getOpStr()
short	getOpVal()
java.lang.String	getPlanId()
int	getRequestId()
PlanControl.TYPE	getType()
java.lang.String	getTypeStr()
short	getTypeVal()
PlanControl	setArg(IMCMessage arg)
PlanControl	setFlags(int flags)
PlanControl	setInfo(java.lang.String info)
PlanControl	setOp(PlanControl.OP op)
PlanControl	setOpStr(java.lang.String op)
PlanControl	setOpVal(short op)
PlanControl	setPlanId(java.lang.String plan_id)
PlanControl	setRequestId(int request_id)
PlanControl	setType(PlanControl.TYPE type)
PlanControl	setTypeStr(java.lang.String type)
PlanControl	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

FLG_CALIBRATE

public static final int FLG_CALIBRATE

See Also:

Constant Field Values

FLG_IGNORE_ERRORS

public static final int FLG_IGNORE_ERRORS

See Also:

Constant Field Values

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

PlanControl

public PlanControl()

PlanControl

public PlanControl(IMCMessage msg)

PlanControl

public PlanControl(IMCDefinition defs)

PlanControl

public PlanControl(PlanControl.TYPE type,
                   PlanControl.OP op,
                   int request_id,
                   java.lang.String plan_id,
                   int flags,
                   IMCMessage arg,
                   java.lang.String info)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getType

public PlanControl.TYPE getType()

Returns:

Type (enumerated) - uint8_t

getTypeStr

public java.lang.String getTypeStr()

getTypeVal

public short getTypeVal()

setType

public PlanControl setType(PlanControl.TYPE type)

Parameters:

type - Type (enumerated)

setTypeStr

public PlanControl setTypeStr(java.lang.String type)

Parameters:

type - Type (as a String)

setTypeVal

public PlanControl setTypeVal(short type)

Parameters:

type - Type (integer value)

getOp

public PlanControl.OP getOp()

Returns:

Operation (enumerated) - uint8_t

getOpStr

public java.lang.String getOpStr()

getOpVal

public short getOpVal()

setOp

public PlanControl setOp(PlanControl.OP op)

Parameters:

op - Operation (enumerated)

setOpStr

public PlanControl setOpStr(java.lang.String op)

Parameters:

op - Operation (as a String)

setOpVal

public PlanControl setOpVal(short op)

Parameters:

op - Operation (integer value)

getRequestId

public int getRequestId()

Returns:

Request ID - uint16_t

setRequestId

public PlanControl setRequestId(int request_id)

Parameters:

request_id - Request ID

getPlanId

public java.lang.String getPlanId()

Returns:

Plan Identifier - plaintext

setPlanId

public PlanControl setPlanId(java.lang.String plan_id)

Parameters:

plan_id - Plan Identifier

getFlags

public int getFlags()

Returns:

Flags (bitfield) - uint16_t

setFlags

public PlanControl setFlags(int flags)

Parameters:

flags - Flags (bitfield)

getArg

public IMCMessage getArg()

Returns:

Request/Reply Argument - message

getArg

public <T extends IMCMessage> T getArg(java.lang.Class<T> clazz)
                                throws java.lang.Exception

Throws:

java.lang.Exception

setArg

public PlanControl setArg(IMCMessage arg)

Parameters:

arg - Request/Reply Argument

getInfo

public java.lang.String getInfo()

Returns:

Complementary Info - plaintext

setInfo

public PlanControl setInfo(java.lang.String info)

Parameters:

info - Complementary Info