/*
*
* 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.UnsignedByte;
import org.llrp.ltk.types.UnsignedShort;
import java.util.LinkedList;
import java.util.List;
/**
* A Reader can warn the Client that the Reader's report buffer is filling up. A Client can act upon this warning by requesting report data from the Reader, thereby freeing the Reader's report memory resources.A Reader MAY send a report buffer level warning event whenever the Reader senses that its report memory resources are running short. The buffer level at which a warning is reported is Reader implementation dependent. A Client MAY act upon a report buffer level warning event by requesting report data from the Reader and thereby free report memory resources in the Reader.
See also {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=89&view=fit">LLRP Specification Section 13.2.6.5</a>}
and {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=149&view=fit">LLRP Specification Section 16.2.7.6.4</a>}
*/
/**
* A Reader can warn the Client that the Reader's report buffer is filling up. A Client can act upon this warning by requesting report data from the Reader, thereby freeing the Reader's report memory resources.A Reader MAY send a report buffer level warning event whenever the Reader senses that its report memory resources are running short. The buffer level at which a warning is reported is Reader implementation dependent. A Client MAY act upon a report buffer level warning event by requesting report data from the Reader and thereby free report memory resources in the Reader.
See also {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=89&view=fit">LLRP Specification Section 13.2.6.5</a>}
and {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=149&view=fit">LLRP Specification Section 16.2.7.6.4</a>}
.
*/
public class ReportBufferLevelWarningEvent extends TLVParameter {
public static final SignedShort TYPENUM = new SignedShort(250);
private static final Logger LOGGER = Logger.getLogger(ReportBufferLevelWarningEvent.class);
protected UnsignedByte reportBufferPercentageFull;
/**
* empty constructor to create new parameter.
*/
public ReportBufferLevelWarningEvent() {
}
/**
* Constructor to create parameter from binary encoded parameter
* calls decodeBinary to decode parameter.
* @param list to be decoded
*/
public ReportBufferLevelWarningEvent(LLRPBitList list) {
decodeBinary(list);
}
/**
* Constructor to create parameter from xml encoded parameter
* calls decodeXML to decode parameter.
* @param element to be decoded
*/
public ReportBufferLevelWarningEvent(Element element)
throws InvalidLLRPMessageException {
decodeXML(element);
}
/**
* {@inheritDoc}
*/
public LLRPBitList encodeBinarySpecific() {
LLRPBitList resultBits = new LLRPBitList();
if (reportBufferPercentageFull == null) {
LOGGER.warn(" reportBufferPercentageFull not set");
throw new MissingParameterException(
" reportBufferPercentageFull not set for Parameter of Type ReportBufferLevelWarningEvent");
}
resultBits.append(reportBufferPercentageFull.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 (reportBufferPercentageFull == null) {
LOGGER.warn(" reportBufferPercentageFull not set");
throw new MissingParameterException(
" reportBufferPercentageFull not set");
} else {
element.addContent(reportBufferPercentageFull.encodeXML(
"ReportBufferPercentageFull", 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;
reportBufferPercentageFull = new UnsignedByte(binary.subList(position,
UnsignedByte.length()));
position += UnsignedByte.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("ReportBufferPercentageFull", ns);
if (temp != null) {
reportBufferPercentageFull = new UnsignedByte(temp);
}
element.removeChild("ReportBufferPercentageFull", ns);
if (element.getChildren().size() > 0) {
String message = "ReportBufferLevelWarningEvent has unknown element " +
((Element) element.getChildren().get(0)).getName();
throw new InvalidLLRPMessageException(message);
}
}
//setters
/**
* set reportBufferPercentageFull of type UnsignedByte .
* @param reportBufferPercentageFull to be set
*/
public void setReportBufferPercentageFull(
final UnsignedByte reportBufferPercentageFull) {
this.reportBufferPercentageFull = reportBufferPercentageFull;
}
// end setter
//getters
/**
* get reportBufferPercentageFull of type UnsignedByte.
* @return type UnsignedByte to be set
*/
public UnsignedByte getReportBufferPercentageFull() {
return this.reportBufferPercentageFull;
}
// 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 "ReportBufferLevelWarningEvent";
}
/**
* return string representation. All field values but no parameters are included
* @return String
*/
public String toString() {
String result = "ReportBufferLevelWarningEvent: ";
result += ", reportBufferPercentageFull: ";
result += reportBufferPercentageFull;
result = result.replaceFirst(", ", "");
return result;
}
}