pt.lsts.imc

Class TransmissionRequest

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.TransmissionRequest

All Implemented Interfaces:

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

public class TransmissionRequest
extends IMCMessage

IMC Message Transmission Request (515)
Request data to be sent over a specified communication mean.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransmissionRequest.COMM_MEAN
static class	TransmissionRequest.DATA_MODE

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
TransmissionRequest()
TransmissionRequest(IMCDefinition defs)
TransmissionRequest(IMCMessage msg)
TransmissionRequest(int req_id, TransmissionRequest.COMM_MEAN comm_mean, java.lang.String destination, double deadline, TransmissionRequest.DATA_MODE data_mode, IMCMessage msg_data, java.lang.String txt_data, byte[] raw_data)

Method Summary

Modifier and Type	Method and Description
static TransmissionRequest	clone(IMCMessage msg)
static TransmissionRequest	create(java.lang.Object... values)
TransmissionRequest.COMM_MEAN	getCommMean()
java.lang.String	getCommMeanStr()
short	getCommMeanVal()
TransmissionRequest.DATA_MODE	getDataMode()
java.lang.String	getDataModeStr()
short	getDataModeVal()
double	getDeadline()
java.lang.String	getDestination()
IMCMessage	getMsgData()
<T extends IMCMessage> T	getMsgData(java.lang.Class<T> clazz)
byte[]	getRawData()
int	getReqId()
java.lang.String	getTxtData()
TransmissionRequest	setCommMean(TransmissionRequest.COMM_MEAN comm_mean)
TransmissionRequest	setCommMeanStr(java.lang.String comm_mean)
TransmissionRequest	setCommMeanVal(short comm_mean)
TransmissionRequest	setDataMode(TransmissionRequest.DATA_MODE data_mode)
TransmissionRequest	setDataModeStr(java.lang.String data_mode)
TransmissionRequest	setDataModeVal(short data_mode)
TransmissionRequest	setDeadline(double deadline)
TransmissionRequest	setDestination(java.lang.String destination)
TransmissionRequest	setMsgData(IMCMessage msg_data)
TransmissionRequest	setRawData(byte[] raw_data)
TransmissionRequest	setReqId(int req_id)
TransmissionRequest	setTxtData(java.lang.String txt_data)

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

TransmissionRequest

public TransmissionRequest()

TransmissionRequest

public TransmissionRequest(IMCMessage msg)

TransmissionRequest

public TransmissionRequest(IMCDefinition defs)

TransmissionRequest

public TransmissionRequest(int req_id,
                           TransmissionRequest.COMM_MEAN comm_mean,
                           java.lang.String destination,
                           double deadline,
                           TransmissionRequest.DATA_MODE data_mode,
                           IMCMessage msg_data,
                           java.lang.String txt_data,
                           byte[] raw_data)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getReqId

public int getReqId()

Returns:

Request Identifier - uint16_t

setReqId

public TransmissionRequest setReqId(int req_id)

Parameters:

req_id - Request Identifier

getCommMean

public TransmissionRequest.COMM_MEAN getCommMean()

Returns:

Communication Mean (enumerated) - uint8_t

getCommMeanStr

public java.lang.String getCommMeanStr()

getCommMeanVal

public short getCommMeanVal()

setCommMean

public TransmissionRequest setCommMean(TransmissionRequest.COMM_MEAN comm_mean)

Parameters:

comm_mean - Communication Mean (enumerated)

setCommMeanStr

public TransmissionRequest setCommMeanStr(java.lang.String comm_mean)

Parameters:

comm_mean - Communication Mean (as a String)

setCommMeanVal

public TransmissionRequest setCommMeanVal(short comm_mean)

Parameters:

comm_mean - Communication Mean (integer value)

getDestination

public java.lang.String getDestination()

Returns:

Destination System - plaintext

setDestination

public TransmissionRequest setDestination(java.lang.String destination)

Parameters:

destination - Destination System

getDeadline

public double getDeadline()

Returns:

Deadline - fp64_t

setDeadline

public TransmissionRequest setDeadline(double deadline)

Parameters:

deadline - Deadline

getDataMode

public TransmissionRequest.DATA_MODE getDataMode()

Returns:

Data Mode (enumerated) - uint8_t

getDataModeStr

public java.lang.String getDataModeStr()

getDataModeVal

public short getDataModeVal()

setDataMode

public TransmissionRequest setDataMode(TransmissionRequest.DATA_MODE data_mode)

Parameters:

data_mode - Data Mode (enumerated)

setDataModeStr

public TransmissionRequest setDataModeStr(java.lang.String data_mode)

Parameters:

data_mode - Data Mode (as a String)

setDataModeVal

public TransmissionRequest setDataModeVal(short data_mode)

Parameters:

data_mode - Data Mode (integer value)

getMsgData

public IMCMessage getMsgData()

Returns:

Message Data - message

getMsgData

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

Throws:

java.lang.Exception

setMsgData

public TransmissionRequest setMsgData(IMCMessage msg_data)

Parameters:

msg_data - Message Data

getTxtData

public java.lang.String getTxtData()

Returns:

Text Data - plaintext

setTxtData

public TransmissionRequest setTxtData(java.lang.String txt_data)

Parameters:

txt_data - Text Data

getRawData

public byte[] getRawData()

Returns:

Raw Data - rawdata

setRawData

public TransmissionRequest setRawData(byte[] raw_data)

Parameters:

raw_data - Raw Data