pt.lsts.imc

Class HistoricEvent

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.HistoricEvent

All Implemented Interfaces:

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

public class HistoricEvent
extends IMCMessage

IMC Message Historic Event (110)
This message is used to store historic event log entries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HistoricEvent.TYPE

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
HistoricEvent()
HistoricEvent(IMCDefinition defs)
HistoricEvent(IMCMessage msg)
HistoricEvent(java.lang.String text, HistoricEvent.TYPE type)

Method Summary

Modifier and Type	Method and Description
static HistoricEvent	clone(IMCMessage msg)
static HistoricEvent	create(java.lang.Object... values)
java.lang.String	getText()
HistoricEvent.TYPE	getType()
java.lang.String	getTypeStr()
short	getTypeVal()
HistoricEvent	setText(java.lang.String text)
HistoricEvent	setType(HistoricEvent.TYPE type)
HistoricEvent	setTypeStr(java.lang.String type)
HistoricEvent	setTypeVal(short type)

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

HistoricEvent

public HistoricEvent()

HistoricEvent

public HistoricEvent(IMCMessage msg)

HistoricEvent

public HistoricEvent(IMCDefinition defs)

HistoricEvent

public HistoricEvent(java.lang.String text,
                     HistoricEvent.TYPE type)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getText

public java.lang.String getText()

Returns:

Event - plaintext

setText

public HistoricEvent setText(java.lang.String text)

Parameters:

text - Event

getType

public HistoricEvent.TYPE getType()

Returns:

Event Type (enumerated) - uint8_t

getTypeStr

public java.lang.String getTypeStr()

getTypeVal

public short getTypeVal()

setType

public HistoricEvent setType(HistoricEvent.TYPE type)

Parameters:

type - Event Type (enumerated)

setTypeStr

public HistoricEvent setTypeStr(java.lang.String type)

Parameters:

type - Event Type (as a String)

setTypeVal

public HistoricEvent setTypeVal(short type)

Parameters:

type - Event Type (integer value)