/*
*
* This file was generated by LLRP Code Generator
* see http://llrp-toolkit.cvs.sourceforge.net/llrp-toolkit
* for more information
* Generated on: Mon Mar 10 14:26:48 KST 2014;
*
*/
/*
* Copyright 2007 ETH Zurich
*
* Licensed under the Apache License, Version 2.0 (the "License");
*
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions
* and limitations under the License.
*
*/
package kr.ac.kaist.resl.ltk.generated.parameters;
import org.apache.log4j.Logger;
import org.jdom.Content;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.Namespace;
import org.llrp.ltk.exceptions.InvalidLLRPMessageException;
import org.llrp.ltk.exceptions.MissingParameterException;
import kr.ac.kaist.resl.ltk.generated.LLRPConstants;
import org.llrp.ltk.types.LLRPBitList;
import org.llrp.ltk.types.LLRPMessage;
import org.llrp.ltk.types.SignedShort;
import org.llrp.ltk.types.TLVParameter;
import org.llrp.ltk.types.TVParameter;
import org.llrp.ltk.types.UnsignedShort;
import java.util.LinkedList;
import java.util.List;
/**
* A Reader reports this event every time it hops frequency.NextChannelIndex: This is the one-based ChannelIindex of the next channel to which the Reader is going to hop change to. The channel Ids are listed in the Frequency Hop Table.
See also {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=88&view=fit">LLRP Specification Section 13.2.6.2</a>}
and {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=148&view=fit">LLRP Specification Section 16.2.7.6.1</a>}
*/
/**
* A Reader reports this event every time it hops frequency.NextChannelIndex: This is the one-based ChannelIindex of the next channel to which the Reader is going to hop change to. The channel Ids are listed in the Frequency Hop Table.
See also {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=88&view=fit">LLRP Specification Section 13.2.6.2</a>}
and {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=148&view=fit">LLRP Specification Section 16.2.7.6.1</a>}
.
*/
public class HoppingEvent extends TLVParameter {
public static final SignedShort TYPENUM = new SignedShort(247);
private static final Logger LOGGER = Logger.getLogger(HoppingEvent.class);
protected UnsignedShort hopTableID;
protected UnsignedShort nextChannelIndex;
/**
* empty constructor to create new parameter.
*/
public HoppingEvent() {
}
/**
* Constructor to create parameter from binary encoded parameter
* calls decodeBinary to decode parameter.
* @param list to be decoded
*/
public HoppingEvent(LLRPBitList list) {
decodeBinary(list);
}
/**
* Constructor to create parameter from xml encoded parameter
* calls decodeXML to decode parameter.
* @param element to be decoded
*/
public HoppingEvent(Element element) throws InvalidLLRPMessageException {
decodeXML(element);
}
/**
* {@inheritDoc}
*/
public LLRPBitList encodeBinarySpecific() {
LLRPBitList resultBits = new LLRPBitList();
if (hopTableID == null) {
LOGGER.warn(" hopTableID not set");
throw new MissingParameterException(
" hopTableID not set for Parameter of Type HoppingEvent");
}
resultBits.append(hopTableID.encodeBinary());
if (nextChannelIndex == null) {
LOGGER.warn(" nextChannelIndex not set");
throw new MissingParameterException(
" nextChannelIndex not set for Parameter of Type HoppingEvent");
}
resultBits.append(nextChannelIndex.encodeBinary());
return resultBits;
}
/**
* {@inheritDoc}
*/
public Content encodeXML(String name, Namespace ns) {
// element in namespace defined by parent element
Element element = new Element(name, ns);
// child element are always in default LLRP namespace
ns = Namespace.getNamespace("llrp", LLRPConstants.LLRPNAMESPACE);
if (hopTableID == null) {
LOGGER.warn(" hopTableID not set");
throw new MissingParameterException(" hopTableID not set");
} else {
element.addContent(hopTableID.encodeXML("HopTableID", ns));
}
if (nextChannelIndex == null) {
LOGGER.warn(" nextChannelIndex not set");
throw new MissingParameterException(" nextChannelIndex not set");
} else {
element.addContent(nextChannelIndex.encodeXML("NextChannelIndex", ns));
}
//parameters
return element;
}
/**
* {@inheritDoc}
*/
protected void decodeBinarySpecific(LLRPBitList binary) {
int position = 0;
int tempByteLength;
int tempLength = 0;
int count;
SignedShort type;
int fieldCount;
Custom custom;
hopTableID = new UnsignedShort(binary.subList(position,
UnsignedShort.length()));
position += UnsignedShort.length();
nextChannelIndex = new UnsignedShort(binary.subList(position,
UnsignedShort.length()));
position += UnsignedShort.length();
}
/**
* {@inheritDoc}
*/
public void decodeXML(Element element) throws InvalidLLRPMessageException {
List<Element> tempList = null;
boolean atLeastOnce = false;
Custom custom;
Element temp = null;
// child element are always in default LLRP namespace
Namespace ns = Namespace.getNamespace(LLRPConstants.LLRPNAMESPACE);
temp = element.getChild("HopTableID", ns);
if (temp != null) {
hopTableID = new UnsignedShort(temp);
}
element.removeChild("HopTableID", ns);
temp = element.getChild("NextChannelIndex", ns);
if (temp != null) {
nextChannelIndex = new UnsignedShort(temp);
}
element.removeChild("NextChannelIndex", ns);
if (element.getChildren().size() > 0) {
String message = "HoppingEvent has unknown element " +
((Element) element.getChildren().get(0)).getName();
throw new InvalidLLRPMessageException(message);
}
}
//setters
/**
* set hopTableID of type UnsignedShort .
* @param hopTableID to be set
*/
public void setHopTableID(final UnsignedShort hopTableID) {
this.hopTableID = hopTableID;
}
/**
* set nextChannelIndex of type UnsignedShort .
* @param nextChannelIndex to be set
*/
public void setNextChannelIndex(final UnsignedShort nextChannelIndex) {
this.nextChannelIndex = nextChannelIndex;
}
// end setter
//getters
/**
* get hopTableID of type UnsignedShort.
* @return type UnsignedShort to be set
*/
public UnsignedShort getHopTableID() {
return this.hopTableID;
}
/**
* get nextChannelIndex of type UnsignedShort.
* @return type UnsignedShort to be set
*/
public UnsignedShort getNextChannelIndex() {
return this.nextChannelIndex;
}
// end getters
//add methods
// end add
/**
* For TLV Parameter length can not be determined at compile time. This method therefore always returns 0.
* @return Integer always zero
*/
public static Integer length() {
return 0;
}
/**
* {@inheritDoc}
*/
public SignedShort getTypeNum() {
return TYPENUM;
}
/**
* {@inheritDoc}
*/
public String getName() {
return "HoppingEvent";
}
/**
* return string representation. All field values but no parameters are included
* @return String
*/
public String toString() {
String result = "HoppingEvent: ";
result += ", hopTableID: ";
result += hopTableID;
result += ", nextChannelIndex: ";
result += nextChannelIndex;
result = result.replaceFirst(", ", "");
return result;
}
}