pt.lsts.imc

Class SoiCommand

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.SoiCommand

All Implemented Interfaces:

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

public class SoiCommand
extends IMCMessage

IMC Message SOI Command (852)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoiCommand.COMMAND
static class	SoiCommand.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
SoiCommand()
SoiCommand(IMCDefinition defs)
SoiCommand(IMCMessage msg)
SoiCommand(SoiCommand.TYPE type, SoiCommand.COMMAND command, java.lang.String settings, SoiPlan plan, java.lang.String info)

Method Summary

Modifier and Type	Method and Description
static SoiCommand	clone(IMCMessage msg)
static SoiCommand	create(java.lang.Object... values)
SoiCommand.COMMAND	getCommand()
java.lang.String	getCommandStr()
short	getCommandVal()
java.lang.String	getInfo()
SoiPlan	getPlan()
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getSettings()
SoiCommand.TYPE	getType()
java.lang.String	getTypeStr()
short	getTypeVal()
SoiCommand	setCommand(SoiCommand.COMMAND command)
SoiCommand	setCommandStr(java.lang.String command)
SoiCommand	setCommandVal(short command)
SoiCommand	setInfo(java.lang.String info)
SoiCommand	setPlan(SoiPlan plan)
SoiCommand	setSettings(java.util.LinkedHashMap<java.lang.String,?> settings)
SoiCommand	setSettings(java.lang.String settings)
SoiCommand	setType(SoiCommand.TYPE type)
SoiCommand	setTypeStr(java.lang.String type)
SoiCommand	setTypeVal(short type)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asJSON, asMap, asXml, asXmlStripped, cloneMessage, cloneMessage, compareTo, copyFrom, copyToClipoard, 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, makeImmutable, parseJson, parseXml, pasteFromClipoard, payloadMD5, serialize, serialize, serialize, serializePayload, setBitMask, setDst, setDstEnt, setHeader, setMessageInfo, setMessageList, setSrc, setSrcEnt, setTimestamp, setTimestampMillis, setType, setValue, setValues, toByteArray, toByteArray, 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

SoiCommand

public SoiCommand()

SoiCommand

public SoiCommand(IMCMessage msg)

SoiCommand

public SoiCommand(IMCDefinition defs)

SoiCommand

public SoiCommand(SoiCommand.TYPE type,
                  SoiCommand.COMMAND command,
                  java.lang.String settings,
                  SoiPlan plan,
                  java.lang.String info)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getType

public SoiCommand.TYPE getType()

Returns:

Type (enumerated) - uint8_t

getTypeStr

public java.lang.String getTypeStr()

getTypeVal

public short getTypeVal()

setType

public SoiCommand setType(SoiCommand.TYPE type)

Parameters:

type - Type (enumerated)

setTypeStr

public SoiCommand setTypeStr(java.lang.String type)

Parameters:

type - Type (as a String)

setTypeVal

public SoiCommand setTypeVal(short type)

Parameters:

type - Type (integer value)

getCommand

public SoiCommand.COMMAND getCommand()

Returns:

Command (enumerated) - uint8_t

getCommandStr

public java.lang.String getCommandStr()

getCommandVal

public short getCommandVal()

setCommand

public SoiCommand setCommand(SoiCommand.COMMAND command)

Parameters:

command - Command (enumerated)

setCommandStr

public SoiCommand setCommandStr(java.lang.String command)

Parameters:

command - Command (as a String)

setCommandVal

public SoiCommand setCommandVal(short command)

Parameters:

command - Command (integer value)

getSettings

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

Returns:

Settings (tuplelist) - plaintext

setSettings

public SoiCommand setSettings(java.util.LinkedHashMap<java.lang.String,?> settings)

Parameters:

settings - Settings (tuplelist)

setSettings

public SoiCommand setSettings(java.lang.String settings)

getPlan

public SoiPlan getPlan()

Returns:

Plan - message

setPlan

public SoiCommand setPlan(SoiPlan plan)

Parameters:

plan - Plan

getInfo

public java.lang.String getInfo()

Returns:

Extra Information - plaintext

setInfo

public SoiCommand setInfo(java.lang.String info)

Parameters:

info - Extra Information