pt.lsts.imc

Class EntityActivationState

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.EntityActivationState

All Implemented Interfaces:

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

public class EntityActivationState
extends IMCMessage

IMC Message Entity Activation State (14)
State of entity activation/deactivation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityActivationState.STATE

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
EntityActivationState()
EntityActivationState(EntityActivationState.STATE state, java.lang.String error)
EntityActivationState(IMCDefinition defs)
EntityActivationState(IMCMessage msg)

Method Summary

Modifier and Type	Method and Description
static EntityActivationState	clone(IMCMessage msg)
static EntityActivationState	create(java.lang.Object... values)
java.lang.String	getError()
EntityActivationState.STATE	getState() Current state.
EntityActivationState	setError(java.lang.String error)
EntityActivationState	setState(EntityActivationState.STATE state)
EntityActivationState	setState(short state)
EntityActivationState	setState(java.lang.String state)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asXml, cloneMessage, cloneMessage, compareTo, copyFrom, decodeTupleList, dump, encodeTupleList, get, getAbbrev, getAsNumber, getAsString, getBitmask, getDate, getDouble, getDst, getDstEnt, getFieldNames, getFloat, getHeader, getHeaderValue, getInteger, getLong, getLongFieldName, getLongName, getMessage, getMessage, 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, parseXml, payloadMD5, serialize, serialize, setBitMask, setDst, setDstEnt, setHeader, 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

EntityActivationState

public EntityActivationState()

EntityActivationState

public EntityActivationState(IMCMessage msg)

EntityActivationState

public EntityActivationState(IMCDefinition defs)

EntityActivationState

public EntityActivationState(EntityActivationState.STATE state,
                             java.lang.String error)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getState

public EntityActivationState.STATE getState()

Current state.

Returns:

State (enumerated) - uint8_t

getError

public java.lang.String getError()

Returns:

Error - plaintext

setState

public EntityActivationState setState(EntityActivationState.STATE state)

Parameters:

state - State (enumerated)

setState

public EntityActivationState setState(java.lang.String state)

Parameters:

state - State (as a String)

setState

public EntityActivationState setState(short state)

Parameters:

state - State (integer value)

setError

public EntityActivationState setError(java.lang.String error)

Parameters:

error - Error