pt.lsts.imc

Class TransmissionStatus

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.TransmissionStatus

All Implemented Interfaces:

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

public class TransmissionStatus
extends IMCMessage

IMC Message Transmission Status (516)
Reply sent in response to a communications request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransmissionStatus.STATUS

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
TransmissionStatus()
TransmissionStatus(IMCDefinition defs)
TransmissionStatus(IMCMessage msg)
TransmissionStatus(int req_id, TransmissionStatus.STATUS status, java.lang.String info)

Method Summary

Modifier and Type	Method and Description
static TransmissionStatus	clone(IMCMessage msg)
static TransmissionStatus	create(java.lang.Object... values)
java.lang.String	getInfo()
int	getReqId()
TransmissionStatus.STATUS	getStatus()
java.lang.String	getStatusStr()
short	getStatusVal()
TransmissionStatus	setInfo(java.lang.String info)
TransmissionStatus	setReqId(int req_id)
TransmissionStatus	setStatus(TransmissionStatus.STATUS status)
TransmissionStatus	setStatusStr(java.lang.String status)
TransmissionStatus	setStatusVal(short status)

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

TransmissionStatus

public TransmissionStatus()

TransmissionStatus

public TransmissionStatus(IMCMessage msg)

TransmissionStatus

public TransmissionStatus(IMCDefinition defs)

TransmissionStatus

public TransmissionStatus(int req_id,
                          TransmissionStatus.STATUS status,
                          java.lang.String info)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getReqId

public int getReqId()

Returns:

Request Identifier - uint16_t

setReqId

public TransmissionStatus setReqId(int req_id)

Parameters:

req_id - Request Identifier

getStatus

public TransmissionStatus.STATUS getStatus()

Returns:

Status (enumerated) - uint8_t

getStatusStr

public java.lang.String getStatusStr()

getStatusVal

public short getStatusVal()

setStatus

public TransmissionStatus setStatus(TransmissionStatus.STATUS status)

Parameters:

status - Status (enumerated)

setStatusStr

public TransmissionStatus setStatusStr(java.lang.String status)

Parameters:

status - Status (as a String)

setStatusVal

public TransmissionStatus setStatusVal(short status)

Parameters:

status - Status (integer value)

getInfo

public java.lang.String getInfo()

Returns:

Information - plaintext

setInfo

public TransmissionStatus setInfo(java.lang.String info)

Parameters:

info - Information