pt.lsts.imc

Class PlanDB

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.PlanDB

All Implemented Interfaces:

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

public class PlanDB
extends IMCMessage

IMC Message Plan DB (556)
Request/reply to plan database.

Nested Class Summary

Nested Classes

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

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
PlanDB()
PlanDB(IMCDefinition defs)
PlanDB(IMCMessage msg)
PlanDB(PlanDB.TYPE type, PlanDB.OP op, int request_id, java.lang.String plan_id, IMCMessage arg, java.lang.String info)

Method Summary

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

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

PlanDB

public PlanDB()

PlanDB

public PlanDB(IMCMessage msg)

PlanDB

public PlanDB(IMCDefinition defs)

PlanDB

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

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getType

public PlanDB.TYPE getType()

Returns:

Type (enumerated) - uint8_t

getTypeStr

public java.lang.String getTypeStr()

getTypeVal

public short getTypeVal()

setType

public PlanDB setType(PlanDB.TYPE type)

Parameters:

type - Type (enumerated)

setTypeStr

public PlanDB setTypeStr(java.lang.String type)

Parameters:

type - Type (as a String)

setTypeVal

public PlanDB setTypeVal(short type)

Parameters:

type - Type (integer value)

getOp

public PlanDB.OP getOp()

Returns:

Operation (enumerated) - uint8_t

getOpStr

public java.lang.String getOpStr()

getOpVal

public short getOpVal()

setOp

public PlanDB setOp(PlanDB.OP op)

Parameters:

op - Operation (enumerated)

setOpStr

public PlanDB setOpStr(java.lang.String op)

Parameters:

op - Operation (as a String)

setOpVal

public PlanDB setOpVal(short op)

Parameters:

op - Operation (integer value)

getRequestId

public int getRequestId()

Returns:

Request ID - uint16_t

setRequestId

public PlanDB setRequestId(int request_id)

Parameters:

request_id - Request ID

getPlanId

public java.lang.String getPlanId()

Returns:

Plan ID - plaintext

setPlanId

public PlanDB setPlanId(java.lang.String plan_id)

Parameters:

plan_id - Plan ID

getArg

public IMCMessage getArg()

Returns:

Argument - message

getArg

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

Throws:

java.lang.Exception

setArg

public PlanDB setArg(IMCMessage arg)

Parameters:

arg - Argument

getInfo

public java.lang.String getInfo()

Returns:

Complementary Information - plaintext

setInfo

public PlanDB setInfo(java.lang.String info)

Parameters:

info - Complementary Information