pt.lsts.imc

Class TrexCommand

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.TrexCommand

All Implemented Interfaces:

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

public class TrexCommand
extends IMCMessage

IMC Message TREX Command (652)
This message is used to control TREX execution

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrexCommand.COMMAND

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
TrexCommand()
TrexCommand(IMCDefinition defs)
TrexCommand(IMCMessage msg)
TrexCommand(TrexCommand.COMMAND command, java.lang.String goal_id, java.lang.String goal_xml)

Method Summary

Modifier and Type	Method and Description
static TrexCommand	clone(IMCMessage msg)
static TrexCommand	create(java.lang.Object... values)
TrexCommand.COMMAND	getCommand()
java.lang.String	getCommandStr()
short	getCommandVal()
java.lang.String	getGoalId()
java.lang.String	getGoalXml()
TrexCommand	setCommand(TrexCommand.COMMAND command)
TrexCommand	setCommandStr(java.lang.String command)
TrexCommand	setCommandVal(short command)
TrexCommand	setGoalId(java.lang.String goal_id)
TrexCommand	setGoalXml(java.lang.String goal_xml)

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

TrexCommand

public TrexCommand()

TrexCommand

public TrexCommand(IMCMessage msg)

TrexCommand

public TrexCommand(IMCDefinition defs)

TrexCommand

public TrexCommand(TrexCommand.COMMAND command,
                   java.lang.String goal_id,
                   java.lang.String goal_xml)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getCommand

public TrexCommand.COMMAND getCommand()

Returns:

Command (enumerated) - uint8_t

getCommandStr

public java.lang.String getCommandStr()

getCommandVal

public short getCommandVal()

setCommand

public TrexCommand setCommand(TrexCommand.COMMAND command)

Parameters:

command - Command (enumerated)

setCommandStr

public TrexCommand setCommandStr(java.lang.String command)

Parameters:

command - Command (as a String)

setCommandVal

public TrexCommand setCommandVal(short command)

Parameters:

command - Command (integer value)

getGoalId

public java.lang.String getGoalId()

Returns:

Goal Id - plaintext

setGoalId

public TrexCommand setGoalId(java.lang.String goal_id)

Parameters:

goal_id - Goal Id

getGoalXml

public java.lang.String getGoalXml()

Returns:

Goal XML - plaintext

setGoalXml

public TrexCommand setGoalXml(java.lang.String goal_xml)

Parameters:

goal_xml - Goal XML