org.llrp.ltk.generated.parameters
Class RegulatoryCapabilities

java.lang.Object
  org.llrp.ltk.types.LLRPParameter
      org.llrp.ltk.types.TLVParameter
          org.llrp.ltk.generated.parameters.RegulatoryCapabilities

public class RegulatoryCapabilities
extends TLVParameter

This parameter carries the RF regulation specific attributes. They include regulatory standard, frequency band information, power levels supported, frequencies supported, and any air protocol specific values that are determined based on regulatory restriction. The regulatory standard is encoded using two Integer fields, (Country Code, Communications standard) and it specifies the current operational regulatory mode of the device. This should not be used to reflect the ability to operate in regulatory environments which require configuration different from the current. This version of the LLRP protocol will have support for only the UHF band. See also LLRP Specification Section 9.2.4 and LLRP Specification Section 16.2.3.4 .

Field Summary

protected CommunicationsStandard	communicationsStandard
protected UnsignedShort	countryCode
protected java.util.List<Custom>	customList
static SignedShort	TYPENUM
protected UHFBandCapabilities	uHFBandCapabilities

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

RESERVEDLENGTH, TYPENUMBERLENGTH

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

bitLength

Constructor Summary

RegulatoryCapabilities()
empty constructor to create new parameter.

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

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

Method Summary

void	addToCustomList(Custom custom) add element custom of type Custom .
protected void	decodeBinarySpecific(LLRPBitList binary) decoding function to be implemented by each parameter
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.
CommunicationsStandard	getCommunicationsStandard() get communicationsStandard of type CommunicationsStandard.
UnsignedShort	getCountryCode() get countryCode of type UnsignedShort.
java.util.List<Custom>	getCustomList() get customList of type List <Custom> .
java.lang.String	getName() name of parameter (same as class name)
SignedShort	getTypeNum() type number uniquely identifies a parameter.
UHFBandCapabilities	getUHFBandCapabilities() get uHFBandCapabilities of type UHFBandCapabilities .
static java.lang.Integer	length() For TLV Parameter length can not be determined at compile time.
void	setCommunicationsStandard(CommunicationsStandard communicationsStandard) set communicationsStandard of type CommunicationsStandard .
void	setCountryCode(UnsignedShort countryCode) set countryCode of type UnsignedShort .
void	setCustomList(java.util.List<Custom> customList) set customList of type List <Custom>.
void	setUHFBandCapabilities(UHFBandCapabilities uHFBandCapabilities) set uHFBandCapabilities of type UHFBandCapabilities.
java.lang.String	toString() return string representation.

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

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

countryCode

protected UnsignedShort countryCode

communicationsStandard

protected CommunicationsStandard communicationsStandard

uHFBandCapabilities

protected UHFBandCapabilities uHFBandCapabilities

customList

protected java.util.List<Custom> customList

Constructor Detail

RegulatoryCapabilities

public RegulatoryCapabilities()

empty constructor to create new parameter.

RegulatoryCapabilities

public RegulatoryCapabilities(LLRPBitList list)

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

Parameters:

list - to be decoded

RegulatoryCapabilities

public RegulatoryCapabilities(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 TLVParameter

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)

decoding function to be implemented by each parameter

Specified by:

decodeBinarySpecific in class TLVParameter

Parameters:

binary - binary representation of the 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

setCountryCode

public void setCountryCode(UnsignedShort countryCode)

set countryCode of type UnsignedShort .

Parameters:

countryCode - to be set

setCommunicationsStandard

public void setCommunicationsStandard(CommunicationsStandard communicationsStandard)

set communicationsStandard of type CommunicationsStandard .

Parameters:

communicationsStandard - to be set

setUHFBandCapabilities

public void setUHFBandCapabilities(UHFBandCapabilities uHFBandCapabilities)

set uHFBandCapabilities of type UHFBandCapabilities.

Parameters:

uHFBandCapabilities - to be set

setCustomList

public void setCustomList(java.util.List<Custom> customList)

set customList of type List <Custom>.

Parameters:

customList - to be set

getCountryCode

public UnsignedShort getCountryCode()

get countryCode of type UnsignedShort.

Returns:

type UnsignedShort to be set

getCommunicationsStandard

public CommunicationsStandard getCommunicationsStandard()

get communicationsStandard of type CommunicationsStandard.

Returns:

CommunicationsStandard

getUHFBandCapabilities

public UHFBandCapabilities getUHFBandCapabilities()

get uHFBandCapabilities of type UHFBandCapabilities .

Returns:

UHFBandCapabilities

getCustomList

public java.util.List<Custom> getCustomList()

get customList of type List <Custom> .

Returns:

List <Custom>

addToCustomList

public void addToCustomList(Custom custom)

add element custom of type Custom .

Parameters:

custom - of type Custom

length

public static java.lang.Integer length()

For TLV Parameter length can not be determined at compile time. This method therefore always returns 0.

Returns:

Integer always zero

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