pt.lsts.imc

Class PlanVariable

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.PlanVariable

All Implemented Interfaces:

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

public class PlanVariable
extends IMCMessage

IMC Message Plan Variable (561)
A plan variable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlanVariable.ACCESS
static class	PlanVariable.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
PlanVariable()
PlanVariable(IMCDefinition defs)
PlanVariable(IMCMessage msg)
PlanVariable(java.lang.String name, java.lang.String value, PlanVariable.TYPE type, PlanVariable.ACCESS access)

Method Summary

Modifier and Type	Method and Description
static PlanVariable	clone(IMCMessage msg)
static PlanVariable	create(java.lang.Object... values)
PlanVariable.ACCESS	getAccess()
java.lang.String	getAccessStr()
short	getAccessVal()
java.lang.String	getName()
PlanVariable.TYPE	getType()
java.lang.String	getTypeStr()
short	getTypeVal()
java.lang.String	getValue()
PlanVariable	setAccess(PlanVariable.ACCESS access)
PlanVariable	setAccessStr(java.lang.String access)
PlanVariable	setAccessVal(short access)
PlanVariable	setName(java.lang.String name)
PlanVariable	setType(PlanVariable.TYPE type)
PlanVariable	setTypeStr(java.lang.String type)
PlanVariable	setTypeVal(short type)
PlanVariable	setValue(java.lang.String value)

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

PlanVariable

public PlanVariable()

PlanVariable

public PlanVariable(IMCMessage msg)

PlanVariable

public PlanVariable(IMCDefinition defs)

PlanVariable

public PlanVariable(java.lang.String name,
                    java.lang.String value,
                    PlanVariable.TYPE type,
                    PlanVariable.ACCESS access)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getName

public java.lang.String getName()

Returns:

Name - plaintext

setName

public PlanVariable setName(java.lang.String name)

Parameters:

name - Name

getValue

public java.lang.String getValue()

Returns:

Value - plaintext

setValue

public PlanVariable setValue(java.lang.String value)

Parameters:

value - Value

getType

public PlanVariable.TYPE getType()

Returns:

Type (enumerated) - uint8_t

getTypeStr

public java.lang.String getTypeStr()

getTypeVal

public short getTypeVal()

setType

public PlanVariable setType(PlanVariable.TYPE type)

Parameters:

type - Type (enumerated)

setTypeStr

public PlanVariable setTypeStr(java.lang.String type)

Parameters:

type - Type (as a String)

setTypeVal

public PlanVariable setTypeVal(short type)

Parameters:

type - Type (integer value)

getAccess

public PlanVariable.ACCESS getAccess()

Returns:

Access Type (enumerated) - uint8_t

getAccessStr

public java.lang.String getAccessStr()

getAccessVal

public short getAccessVal()

setAccess

public PlanVariable setAccess(PlanVariable.ACCESS access)

Parameters:

access - Access Type (enumerated)

setAccessStr

public PlanVariable setAccessStr(java.lang.String access)

Parameters:

access - Access Type (as a String)

setAccessVal

public PlanVariable setAccessVal(short access)

Parameters:

access - Access Type (integer value)