pt.lsts.imc

Class PlanGeneration

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.PlanGeneration

All Implemented Interfaces:

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

public class PlanGeneration
extends IMCMessage

IMC Message Plan Generation (562)
This message is used to order the generation of plans based on
id and set of parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlanGeneration.CMD
static class	PlanGeneration.OP

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
PlanGeneration()
PlanGeneration(IMCDefinition defs)
PlanGeneration(IMCMessage msg)
PlanGeneration(PlanGeneration.CMD cmd, PlanGeneration.OP op, java.lang.String plan_id, java.lang.String params)

Method Summary

Modifier and Type	Method and Description
static PlanGeneration	clone(IMCMessage msg)
static PlanGeneration	create(java.lang.Object... values)
PlanGeneration.CMD	getCmd()
java.lang.String	getCmdStr()
short	getCmdVal()
PlanGeneration.OP	getOp()
java.lang.String	getOpStr()
short	getOpVal()
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getParams()
java.lang.String	getPlanId()
PlanGeneration	setCmd(PlanGeneration.CMD cmd)
PlanGeneration	setCmdStr(java.lang.String cmd)
PlanGeneration	setCmdVal(short cmd)
PlanGeneration	setOp(PlanGeneration.OP op)
PlanGeneration	setOpStr(java.lang.String op)
PlanGeneration	setOpVal(short op)
PlanGeneration	setParams(java.util.LinkedHashMap<java.lang.String,?> params)
PlanGeneration	setParams(java.lang.String params)
PlanGeneration	setPlanId(java.lang.String plan_id)

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

PlanGeneration

public PlanGeneration()

PlanGeneration

public PlanGeneration(IMCMessage msg)

PlanGeneration

public PlanGeneration(IMCDefinition defs)

PlanGeneration

public PlanGeneration(PlanGeneration.CMD cmd,
                      PlanGeneration.OP op,
                      java.lang.String plan_id,
                      java.lang.String params)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getCmd

public PlanGeneration.CMD getCmd()

Returns:

Command (enumerated) - uint8_t

getCmdStr

public java.lang.String getCmdStr()

getCmdVal

public short getCmdVal()

setCmd

public PlanGeneration setCmd(PlanGeneration.CMD cmd)

Parameters:

cmd - Command (enumerated)

setCmdStr

public PlanGeneration setCmdStr(java.lang.String cmd)

Parameters:

cmd - Command (as a String)

setCmdVal

public PlanGeneration setCmdVal(short cmd)

Parameters:

cmd - Command (integer value)

getOp

public PlanGeneration.OP getOp()

Returns:

Operation (enumerated) - uint8_t

getOpStr

public java.lang.String getOpStr()

getOpVal

public short getOpVal()

setOp

public PlanGeneration setOp(PlanGeneration.OP op)

Parameters:

op - Operation (enumerated)

setOpStr

public PlanGeneration setOpStr(java.lang.String op)

Parameters:

op - Operation (as a String)

setOpVal

public PlanGeneration setOpVal(short op)

Parameters:

op - Operation (integer value)

getPlanId

public java.lang.String getPlanId()

Returns:

Plan Identifier - plaintext

setPlanId

public PlanGeneration setPlanId(java.lang.String plan_id)

Parameters:

plan_id - Plan Identifier

getParams

public java.util.LinkedHashMap<java.lang.String,java.lang.String> getParams()

Returns:

Parameters (tuplelist) - plaintext

setParams

public PlanGeneration setParams(java.util.LinkedHashMap<java.lang.String,?> params)

Parameters:

params - Parameters (tuplelist)

setParams

public PlanGeneration setParams(java.lang.String params)