/*
*
* 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 org.llrp.ltk.types.Bit;
import org.llrp.ltk.types.BitList;
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;
/**
* This parameter carries the data pertinent to perform the write to a general purpose output port.Readers that do not support GPOs SHALL set NumGPOs in the GPIOCapabilities to zero. If such a Reader receives a SET_READER_CONFIG with GPOWriteData Parameter, the Reader SHALL return an error message and not process any of the parameters in that message.
See also {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=72&view=fit">LLRP Specification Section 12.2.3</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.3</a>}
*/
/**
* This parameter carries the data pertinent to perform the write to a general purpose output port.Readers that do not support GPOs SHALL set NumGPOs in the GPIOCapabilities to zero. If such a Reader receives a SET_READER_CONFIG with GPOWriteData Parameter, the Reader SHALL return an error message and not process any of the parameters in that message.
See also {@link <a href="http://www.epcglobalinc.org/standards/llrp/llrp_1_0_1-standard-20070813.pdf#page=72&view=fit">LLRP Specification Section 12.2.3</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.3</a>}
.
*/
public class GPOWriteData extends TLVParameter {
public static final SignedShort TYPENUM = new SignedShort(219);
private static final Logger LOGGER = Logger.getLogger(GPOWriteData.class);
protected UnsignedShort gPOPortNumber;
protected Bit gPOData;
protected BitList reserved0 = new BitList(7);
/**
* empty constructor to create new parameter.
*/
public GPOWriteData() {
}
/**
* Constructor to create parameter from binary encoded parameter
* calls decodeBinary to decode parameter.
* @param list to be decoded
*/
public GPOWriteData(LLRPBitList list) {
decodeBinary(list);
}
/**
* Constructor to create parameter from xml encoded parameter
* calls decodeXML to decode parameter.
* @param element to be decoded
*/
public GPOWriteData(Element element) throws InvalidLLRPMessageException {
decodeXML(element);
}
/**
* {@inheritDoc}
*/
public LLRPBitList encodeBinarySpecific() {
LLRPBitList resultBits = new LLRPBitList();
if (gPOPortNumber == null) {
LOGGER.warn(" gPOPortNumber not set");
throw new MissingParameterException(
" gPOPortNumber not set for Parameter of Type GPOWriteData");
}
resultBits.append(gPOPortNumber.encodeBinary());
if (gPOData == null) {
LOGGER.warn(" gPOData not set");
throw new MissingParameterException(
" gPOData not set for Parameter of Type GPOWriteData");
}
resultBits.append(gPOData.encodeBinary());
resultBits.append(reserved0.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 (gPOPortNumber == null) {
LOGGER.warn(" gPOPortNumber not set");
throw new MissingParameterException(" gPOPortNumber not set");
} else {
element.addContent(gPOPortNumber.encodeXML("GPOPortNumber", ns));
}
if (gPOData == null) {
LOGGER.warn(" gPOData not set");
throw new MissingParameterException(" gPOData not set");
} else {
element.addContent(gPOData.encodeXML("GPOData", ns));
}
//element.addContent(reserved0.encodeXML("reserved",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;
gPOPortNumber = new UnsignedShort(binary.subList(position,
UnsignedShort.length()));
position += UnsignedShort.length();
gPOData = new Bit(binary.subList(position, Bit.length()));
position += Bit.length();
position += reserved0.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("GPOPortNumber", ns);
if (temp != null) {
gPOPortNumber = new UnsignedShort(temp);
}
element.removeChild("GPOPortNumber", ns);
temp = element.getChild("GPOData", ns);
if (temp != null) {
gPOData = new Bit(temp);
}
element.removeChild("GPOData", ns);
if (element.getChildren().size() > 0) {
String message = "GPOWriteData has unknown element " +
((Element) element.getChildren().get(0)).getName();
throw new InvalidLLRPMessageException(message);
}
}
//setters
/**
* set gPOPortNumber of type UnsignedShort .
* @param gPOPortNumber to be set
*/
public void setGPOPortNumber(final UnsignedShort gPOPortNumber) {
this.gPOPortNumber = gPOPortNumber;
}
/**
* set gPOData of type Bit .
* @param gPOData to be set
*/
public void setGPOData(final Bit gPOData) {
this.gPOData = gPOData;
}
// end setter
//getters
/**
* get gPOPortNumber of type UnsignedShort.
* @return type UnsignedShort to be set
*/
public UnsignedShort getGPOPortNumber() {
return this.gPOPortNumber;
}
/**
* get gPOData of type Bit.
* @return type Bit to be set
*/
public Bit getGPOData() {
return this.gPOData;
}
// 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 "GPOWriteData";
}
/**
* return string representation. All field values but no parameters are included
* @return String
*/
public String toString() {
String result = "GPOWriteData: ";
result += ", gPOPortNumber: ";
result += gPOPortNumber;
result += ", gPOData: ";
result += gPOData;
result = result.replaceFirst(", ", "");
return result;
}
}