pt.lsts.imc

Class LogBookEntry

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.LogBookEntry

All Implemented Interfaces:

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

public class LogBookEntry
extends IMCMessage

IMC Message Log Book Entry (103)
Human readable message reporting an event of interest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogBookEntry.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
LogBookEntry()
LogBookEntry(IMCDefinition defs)
LogBookEntry(IMCMessage msg)
LogBookEntry(LogBookEntry.TYPE type, double htime, java.lang.String context, java.lang.String text)

Method Summary

Modifier and Type	Method and Description
static LogBookEntry	clone(IMCMessage msg)
static LogBookEntry	create(java.lang.Object... values)
java.lang.String	getContext()
double	getHtime()
java.lang.String	getText()
LogBookEntry.TYPE	getType()
java.lang.String	getTypeStr()
short	getTypeVal()
LogBookEntry	setContext(java.lang.String context)
LogBookEntry	setHtime(double htime)
LogBookEntry	setText(java.lang.String text)
LogBookEntry	setType(LogBookEntry.TYPE type)
LogBookEntry	setTypeStr(java.lang.String type)
LogBookEntry	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

LogBookEntry

public LogBookEntry()

LogBookEntry

public LogBookEntry(IMCMessage msg)

LogBookEntry

public LogBookEntry(IMCDefinition defs)

LogBookEntry

public LogBookEntry(LogBookEntry.TYPE type,
                    double htime,
                    java.lang.String context,
                    java.lang.String text)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getType

public LogBookEntry.TYPE getType()

Returns:

Type (enumerated) - uint8_t

getTypeStr

public java.lang.String getTypeStr()

getTypeVal

public short getTypeVal()

setType

public LogBookEntry setType(LogBookEntry.TYPE type)

Parameters:

type - Type (enumerated)

setTypeStr

public LogBookEntry setTypeStr(java.lang.String type)

Parameters:

type - Type (as a String)

setTypeVal

public LogBookEntry setTypeVal(short type)

Parameters:

type - Type (integer value)

getHtime

public double getHtime()

Returns:

Timestamp (s) - fp64_t

setHtime

public LogBookEntry setHtime(double htime)

Parameters:

htime - Timestamp (s)

getContext

public java.lang.String getContext()

Returns:

Context - plaintext

setContext

public LogBookEntry setContext(java.lang.String context)

Parameters:

context - Context

getText

public java.lang.String getText()

Returns:

Text - plaintext

setText

public LogBookEntry setText(java.lang.String text)

Parameters:

text - Text