pt.lsts.imc

Class ReportControl

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.ReportControl

All Implemented Interfaces:

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

public class ReportControl
extends IMCMessage

IMC Message Report Control (513)
This message is sent to trigger reports to a destination system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportControl.OP

Field Summary

Fields

Modifier and Type	Field and Description
static short	CI_ACOUSTIC
static short	CI_GSM
static short	CI_MOBILE
static short	CI_SATELLITE
static int	ID_STATIC

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
ReportControl()
ReportControl(IMCDefinition defs)
ReportControl(IMCMessage msg)
ReportControl(ReportControl.OP op, short comm_interface, int period, java.lang.String sys_dst)

Method Summary

Modifier and Type	Method and Description
static ReportControl	clone(IMCMessage msg)
static ReportControl	create(java.lang.Object... values)
short	getCommInterface()
ReportControl.OP	getOp()
java.lang.String	getOpStr()
short	getOpVal()
int	getPeriod()
java.lang.String	getSysDst()
ReportControl	setCommInterface(short comm_interface)
ReportControl	setOp(ReportControl.OP op)
ReportControl	setOpStr(java.lang.String op)
ReportControl	setOpVal(short op)
ReportControl	setPeriod(int period)
ReportControl	setSysDst(java.lang.String sys_dst)

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

CI_ACOUSTIC

public static final short CI_ACOUSTIC

See Also:

Constant Field Values

CI_SATELLITE

public static final short CI_SATELLITE

See Also:

Constant Field Values

CI_GSM

public static final short CI_GSM

See Also:

Constant Field Values

CI_MOBILE

public static final short CI_MOBILE

See Also:

Constant Field Values

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

ReportControl

public ReportControl()

ReportControl

public ReportControl(IMCMessage msg)

ReportControl

public ReportControl(IMCDefinition defs)

ReportControl

public ReportControl(ReportControl.OP op,
                     short comm_interface,
                     int period,
                     java.lang.String sys_dst)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getOp

public ReportControl.OP getOp()

Returns:

Operation (enumerated) - uint8_t

getOpStr

public java.lang.String getOpStr()

getOpVal

public short getOpVal()

setOp

public ReportControl setOp(ReportControl.OP op)

Parameters:

op - Operation (enumerated)

setOpStr

public ReportControl setOpStr(java.lang.String op)

Parameters:

op - Operation (as a String)

setOpVal

public ReportControl setOpVal(short op)

Parameters:

op - Operation (integer value)

getCommInterface

public short getCommInterface()

Returns:

Communication Interface (bitfield) - uint8_t

setCommInterface

public ReportControl setCommInterface(short comm_interface)

Parameters:

comm_interface - Communication Interface (bitfield)

getPeriod

public int getPeriod()

Returns:

Period (s) - uint16_t

setPeriod

public ReportControl setPeriod(int period)

Parameters:

period - Period (s)

getSysDst

public java.lang.String getSysDst()

Returns:

Destination System - plaintext

setSysDst

public ReportControl setSysDst(java.lang.String sys_dst)

Parameters:

sys_dst - Destination System