pt.lsts.imc

Class IoEvent

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.IoEvent

All Implemented Interfaces:

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

public class IoEvent
extends IMCMessage

IMC Message I/O Event (813)
Notification of an I/O event.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static IoEvent	clone(IMCMessage msg)
static IoEvent	create(java.lang.Object... values)
java.lang.String	getError()
IoEvent.TYPE	getType()
java.lang.String	getTypeStr()
short	getTypeVal()
IoEvent	setError(java.lang.String error)
IoEvent	setType(IoEvent.TYPE type)
IoEvent	setTypeStr(java.lang.String type)
IoEvent	setTypeVal(short type)

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

IoEvent

public IoEvent()

IoEvent

public IoEvent(IMCMessage msg)

IoEvent

public IoEvent(IMCDefinition defs)

IoEvent

public IoEvent(IoEvent.TYPE type,
               java.lang.String error)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getType

public IoEvent.TYPE getType()

Returns:

Type (enumerated) - uint8_t

getTypeStr

public java.lang.String getTypeStr()

getTypeVal

public short getTypeVal()

setType

public IoEvent setType(IoEvent.TYPE type)

Parameters:

type - Type (enumerated)

setTypeStr

public IoEvent setTypeStr(java.lang.String type)

Parameters:

type - Type (as a String)

setTypeVal

public IoEvent setTypeVal(short type)

Parameters:

type - Type (integer value)

getError

public java.lang.String getError()

Returns:

Error Message - plaintext

setError

public IoEvent setError(java.lang.String error)

Parameters:

error - Error Message