/*
*
* 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:47 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 kr.ac.kaist.resl.ltk.generated.enumerations.KeepaliveTriggerType;
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.UnsignedInteger;
import org.llrp.ltk.types.UnsignedShort;
import java.util.LinkedList;
import java.util.List;
/**
* This parameter carries the specification for the keepalive message generation by the Reader. This includes the definition of the periodic trigger to send the keepalive message.
See also {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=73&view=fit">LLRP Specification Section 12.2.4</a>}
and {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=140&view=fit">LLRP Specification Section 16.2.6.4</a>}
*/
/**
* This parameter carries the specification for the keepalive message generation by the Reader. This includes the definition of the periodic trigger to send the keepalive message.
See also {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=73&view=fit">LLRP Specification Section 12.2.4</a>}
and {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=140&view=fit">LLRP Specification Section 16.2.6.4</a>}
.
*/
public class KeepaliveSpec extends TLVParameter {
public static final SignedShort TYPENUM = new SignedShort(220);
private static final Logger LOGGER = Logger.getLogger(KeepaliveSpec.class);
protected KeepaliveTriggerType keepaliveTriggerType;
protected UnsignedInteger periodicTriggerValue;
/**
* empty constructor to create new parameter.
*/
public KeepaliveSpec() {
}
/**
* Constructor to create parameter from binary encoded parameter
* calls decodeBinary to decode parameter.
* @param list to be decoded
*/
public KeepaliveSpec(LLRPBitList list) {
decodeBinary(list);
}
/**
* Constructor to create parameter from xml encoded parameter
* calls decodeXML to decode parameter.
* @param element to be decoded
*/
public KeepaliveSpec(Element element) throws InvalidLLRPMessageException {
decodeXML(element);
}
/**
* {@inheritDoc}
*/
public LLRPBitList encodeBinarySpecific() {
LLRPBitList resultBits = new LLRPBitList();
if (keepaliveTriggerType == null) {
LOGGER.warn(" keepaliveTriggerType not set");
throw new MissingParameterException(
" keepaliveTriggerType not set for Parameter of Type KeepaliveSpec");
}
resultBits.append(keepaliveTriggerType.encodeBinary());
if (periodicTriggerValue == null) {
LOGGER.warn(" periodicTriggerValue not set");
throw new MissingParameterException(
" periodicTriggerValue not set for Parameter of Type KeepaliveSpec");
}
resultBits.append(periodicTriggerValue.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 (keepaliveTriggerType == null) {
LOGGER.warn(" keepaliveTriggerType not set");
throw new MissingParameterException(" keepaliveTriggerType not set");
} else {
element.addContent(keepaliveTriggerType.encodeXML(
"KeepaliveTriggerType", ns));
}
if (periodicTriggerValue == null) {
LOGGER.warn(" periodicTriggerValue not set");
throw new MissingParameterException(" periodicTriggerValue not set");
} else {
element.addContent(periodicTriggerValue.encodeXML(
"PeriodicTriggerValue", 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;
keepaliveTriggerType = new KeepaliveTriggerType(binary.subList(
position, KeepaliveTriggerType.length()));
position += KeepaliveTriggerType.length();
periodicTriggerValue = new UnsignedInteger(binary.subList(position,
UnsignedInteger.length()));
position += UnsignedInteger.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("KeepaliveTriggerType", ns);
if (temp != null) {
keepaliveTriggerType = new KeepaliveTriggerType(temp);
}
element.removeChild("KeepaliveTriggerType", ns);
temp = element.getChild("PeriodicTriggerValue", ns);
if (temp != null) {
periodicTriggerValue = new UnsignedInteger(temp);
}
element.removeChild("PeriodicTriggerValue", ns);
if (element.getChildren().size() > 0) {
String message = "KeepaliveSpec has unknown element " +
((Element) element.getChildren().get(0)).getName();
throw new InvalidLLRPMessageException(message);
}
}
//setters
/**
* set keepaliveTriggerType of type KeepaliveTriggerType .
* @param keepaliveTriggerType to be set
*/
public void setKeepaliveTriggerType(
final KeepaliveTriggerType keepaliveTriggerType) {
this.keepaliveTriggerType = keepaliveTriggerType;
}
/**
* set periodicTriggerValue of type UnsignedInteger .
* @param periodicTriggerValue to be set
*/
public void setPeriodicTriggerValue(
final UnsignedInteger periodicTriggerValue) {
this.periodicTriggerValue = periodicTriggerValue;
}
// end setter
//getters
/**
* get keepaliveTriggerType of type KeepaliveTriggerType.
* @return KeepaliveTriggerType
*/
public KeepaliveTriggerType getKeepaliveTriggerType() {
return keepaliveTriggerType;
}
/**
* get periodicTriggerValue of type UnsignedInteger.
* @return type UnsignedInteger to be set
*/
public UnsignedInteger getPeriodicTriggerValue() {
return this.periodicTriggerValue;
}
// 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 "KeepaliveSpec";
}
/**
* return string representation. All field values but no parameters are included
* @return String
*/
public String toString() {
String result = "KeepaliveSpec: ";
result += ", keepaliveTriggerType: ";
result += keepaliveTriggerType;
result += ", periodicTriggerValue: ";
result += periodicTriggerValue;
result = result.replaceFirst(", ", "");
return result;
}
}