pt.lsts.imc

Class PowerChannelState

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.PowerChannelState

All Implemented Interfaces:

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

public class PowerChannelState
extends IMCMessage

IMC Message Power Channel State (311)
Message conveying the state of a power channel.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PowerChannelState.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
PowerChannelState()
PowerChannelState(IMCDefinition defs)
PowerChannelState(IMCMessage msg)
PowerChannelState(java.lang.String name, PowerChannelState.STATE state)

Method Summary

Modifier and Type	Method and Description
static PowerChannelState	clone(IMCMessage msg)
static PowerChannelState	create(java.lang.Object... values)
java.lang.String	getName()
PowerChannelState.STATE	getState()
java.lang.String	getStateStr()
short	getStateVal()
PowerChannelState	setName(java.lang.String name)
PowerChannelState	setState(PowerChannelState.STATE state)
PowerChannelState	setStateStr(java.lang.String state)
PowerChannelState	setStateVal(short state)

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

PowerChannelState

public PowerChannelState()

PowerChannelState

public PowerChannelState(IMCMessage msg)

PowerChannelState

public PowerChannelState(IMCDefinition defs)

PowerChannelState

public PowerChannelState(java.lang.String name,
                         PowerChannelState.STATE state)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getName

public java.lang.String getName()

Returns:

Name - plaintext

setName

public PowerChannelState setName(java.lang.String name)

Parameters:

name - Name

getState

public PowerChannelState.STATE getState()

Returns:

State (enumerated) - uint8_t

getStateStr

public java.lang.String getStateStr()

getStateVal

public short getStateVal()

setState

public PowerChannelState setState(PowerChannelState.STATE state)

Parameters:

state - State (enumerated)

setStateStr

public PowerChannelState setStateStr(java.lang.String state)

Parameters:

state - State (as a String)

setStateVal

public PowerChannelState setStateVal(short state)

Parameters:

state - State (integer value)