org.llrp.ltk.generated.parameters
Class ChannelIndex

java.lang.Object
  org.llrp.ltk.types.LLRPParameter
      org.llrp.ltk.types.TVParameter
          org.llrp.ltk.generated.parameters.ChannelIndex

public class ChannelIndex
extends TVParameter

This parameter carries the one-based ChannelIndex informationvalue. See also LLRP Specification Section 13.2.3.8 and LLRP Specification Section 16.2.7.3.8 .

Field Summary

protected UnsignedShort	channelIndex
static SignedShort	TYPENUM

Fields inherited from class org.llrp.ltk.types.TVParameter

PARAMETERTYPELENGTH

Fields inherited from class org.llrp.ltk.types.LLRPParameter

bitLength

Constructor Summary

ChannelIndex()
empty constructor to create new parameter.

ChannelIndex(org.jdom.Element element)
Constructor to create parameter from xml encoded parameter calls decodeXML to decode parameter.

ChannelIndex(LLRPBitList list)
Constructor to create parameter from binary encoded parameter calls decodeBinary to decode parameter.

Method Summary

protected void	decodeBinarySpecific(LLRPBitList binary) function to be implemented
void	decodeXML(org.jdom.Element element) create objects from xml.
LLRPBitList	encodeBinarySpecific() protected method to force subclasses to implement their specific encoding
org.jdom.Content	encodeXML(java.lang.String name, org.jdom.Namespace ns) create xml representation of this parameter.
UnsignedShort	getChannelIndex() get channelIndex of type UnsignedShort.
java.lang.String	getName() name of parameter (same as class name)
SignedShort	getTypeNum() type number uniquely identifies a parameter.
static java.lang.Integer	length() return length of parameter.
void	setChannelIndex(UnsignedShort channelIndex) set channelIndex of type UnsignedShort .
java.lang.String	toString() return string representation.

Methods inherited from class org.llrp.ltk.types.TVParameter

decodeBinary, encodeBinary

Methods inherited from class org.llrp.ltk.types.LLRPParameter

getByteLength

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPENUM

public static final SignedShort TYPENUM

channelIndex

protected UnsignedShort channelIndex

Constructor Detail

ChannelIndex

public ChannelIndex()

empty constructor to create new parameter.

ChannelIndex

public ChannelIndex(LLRPBitList list)

Constructor to create parameter from binary encoded parameter calls decodeBinary to decode parameter.

Parameters:

list - to be decoded

ChannelIndex

public ChannelIndex(org.jdom.Element element)
             throws InvalidLLRPMessageException

Constructor to create parameter from xml encoded parameter calls decodeXML to decode parameter.

Parameters:

element - to be decoded

Throws:

InvalidLLRPMessageException

Method Detail

encodeBinarySpecific

public LLRPBitList encodeBinarySpecific()

protected method to force subclasses to implement their specific encoding

Specified by:

encodeBinarySpecific in class TVParameter

Returns:

LLRPBitList

encodeXML

public org.jdom.Content encodeXML(java.lang.String name,
                                  org.jdom.Namespace ns)

create xml representation of this parameter.

Specified by:

encodeXML in class LLRPParameter

Parameters:

name - of element

ns - Namespace of elements

decodeBinarySpecific

protected void decodeBinarySpecific(LLRPBitList binary)

function to be implemented

Specified by:

decodeBinarySpecific in class TVParameter

Parameters:

binary - binary representation of this parameter

decodeXML

public void decodeXML(org.jdom.Element element)
               throws InvalidLLRPMessageException

create objects from xml.

Specified by:

decodeXML in class LLRPParameter

Parameters:

element - to be decoded

Throws:

InvalidLLRPMessageException

setChannelIndex

public void setChannelIndex(UnsignedShort channelIndex)

set channelIndex of type UnsignedShort .

Parameters:

channelIndex - to be set

getChannelIndex

public UnsignedShort getChannelIndex()

get channelIndex of type UnsignedShort.

Returns:

type UnsignedShort to be set

length

public static java.lang.Integer length()

return length of parameter. For TV Parameter it is always length of its field plus 8 bits for type.

Returns:

Integer giving length

getTypeNum

public SignedShort getTypeNum()

type number uniquely identifies a parameter.

Specified by:

getTypeNum in class LLRPParameter

Returns:

typeNum

getName

public java.lang.String getName()

name of parameter (same as class name)

Specified by:

getName in class LLRPParameter

Returns:

String

toString

public java.lang.String toString()

return string representation. All field values but no parameters are included

Overrides:

toString in class java.lang.Object

Returns:

String