pt.lsts.imc

Class LoggingControl

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.LoggingControl

All Implemented Interfaces:

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

public class LoggingControl
extends IMCMessage

IMC Message Logging Control (102)
Control logging of messages to persistent storage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoggingControl.OP

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
LoggingControl()
LoggingControl(IMCDefinition defs)
LoggingControl(IMCMessage msg)
LoggingControl(LoggingControl.OP op, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
static LoggingControl	clone(IMCMessage msg)
static LoggingControl	create(java.lang.Object... values)
java.lang.String	getName()
LoggingControl.OP	getOp()
java.lang.String	getOpStr()
short	getOpVal()
LoggingControl	setName(java.lang.String name)
LoggingControl	setOp(LoggingControl.OP op)
LoggingControl	setOpStr(java.lang.String op)
LoggingControl	setOpVal(short op)

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

LoggingControl

public LoggingControl()

LoggingControl

public LoggingControl(IMCMessage msg)

LoggingControl

public LoggingControl(IMCDefinition defs)

LoggingControl

public LoggingControl(LoggingControl.OP op,
                      java.lang.String name)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getOp

public LoggingControl.OP getOp()

Returns:

Control Operation (enumerated) - uint8_t

getOpStr

public java.lang.String getOpStr()

getOpVal

public short getOpVal()

setOp

public LoggingControl setOp(LoggingControl.OP op)

Parameters:

op - Control Operation (enumerated)

setOpStr

public LoggingControl setOpStr(java.lang.String op)

Parameters:

op - Control Operation (as a String)

setOpVal

public LoggingControl setOpVal(short op)

Parameters:

op - Control Operation (integer value)

getName

public java.lang.String getName()

Returns:

Log Label / Path - plaintext

setName

public LoggingControl setName(java.lang.String name)

Parameters:

name - Log Label / Path