org.llrp.ltk.generated.messages
Class CUSTOM_MESSAGE

java.lang.Object
  org.llrp.ltk.types.LLRPMessage
      org.llrp.ltk.generated.messages.CUSTOM_MESSAGE

public class CUSTOM_MESSAGE
extends LLRPMessage

This message carries a vendor defined format from Reader to Client or Client to Reader. No requirements are made as to the content or parameters contained within the Data portion of these messages. Clients MAY ignore CUSTOM_MESSAGEs. Readers SHALL accept CUSTOM_MESSAGE and return an ERROR_MESSAGE if CUSTOM_MESSAGE is unsupported by the Reader or the CUSTOM_MESSAGE contains fields and/or parameters that are unsupported by the Reader. See also LLRP Specification Section 8.1 and LLRP Specification Section 16.1.42

Field Summary

protected BytesToEnd_HEX	data
protected UnsignedByte	messageSubtype
static java.lang.String	RESPONSETYPE
static SignedShort	TYPENUM
protected UnsignedInteger	vendorIdentifier

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

messageID, messageLength, messageReservedLength, MINHEADERLENGTH, reserved, RESERVEDLENGTH, TYPENUMBERLENGTH, version, VERSIONLENGTH

Constructor Summary

CUSTOM_MESSAGE()
empty constructor to create new message with LLRP version set to 1.0 (0x1).

CUSTOM_MESSAGE(byte[] byteArray)
Constructor to create message from binary encoded message calls decodeBinary to decode message.

CUSTOM_MESSAGE(org.jdom.Document document)
Constructor to create message from xml encoded message calls decodeXML to decode message.

CUSTOM_MESSAGE(LLRPBitList list)
Constructor to create message from binary encoded message calls decodeBinary to decode message.

Method Summary

protected void	decodeBinarySpecific(LLRPBitList binary) to be implemented by specific message.
void	decodeXML(org.jdom.Document document) create objects from xml.
protected LLRPBitList	encodeBinarySpecific() encoding function - has to be implemented by each message.
org.jdom.Document	encodeXML() create xml representation of this parameter.
BytesToEnd_HEX	getData() get data of type BytesToEnd_HEX.
UnsignedByte	getMessageSubtype() get messageSubtype of type UnsignedByte.
java.lang.String	getName() name of message (same as class name)
java.lang.String	getResponseType() response message type awaited
SignedShort	getTypeNum() return uniuque type number.
UnsignedInteger	getVendorIdentifier() get vendorIdentifier of type UnsignedInteger.
void	setData(BytesToEnd_HEX data) set data of type BytesToEnd_HEX .
void	setMessageSubtype(UnsignedByte messageSubtype) set messageSubtype of type UnsignedByte .
void	setVendorIdentifier(UnsignedInteger vendorIdentifier) set vendorIdentifier of type UnsignedInteger .

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

decodeBinary, encodeBinary, getMessageID, getMessageLength, getVersion, isValidXMLMessage, setMessageID, setVersion, toBinaryString, toHexString, toXMLString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPENUM

public static final SignedShort TYPENUM

RESPONSETYPE

public static final java.lang.String RESPONSETYPE

See Also:

Constant Field Values

vendorIdentifier

protected UnsignedInteger vendorIdentifier

messageSubtype

protected UnsignedByte messageSubtype

data

protected BytesToEnd_HEX data

Constructor Detail

CUSTOM_MESSAGE

public CUSTOM_MESSAGE()

empty constructor to create new message with LLRP version set to 1.0 (0x1).

CUSTOM_MESSAGE

public CUSTOM_MESSAGE(LLRPBitList list)
               throws InvalidLLRPMessageException

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

Parameters:

list - to be decoded

Throws:

InvalidLLRPMessageException

CUSTOM_MESSAGE

public CUSTOM_MESSAGE(byte[] byteArray)
               throws InvalidLLRPMessageException

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

Parameters:

byteArray - representing message

Throws:

InvalidLLRPMessageException

CUSTOM_MESSAGE

public CUSTOM_MESSAGE(org.jdom.Document document)
               throws InvalidLLRPMessageException

Constructor to create message from xml encoded message calls decodeXML to decode message.

Parameters:

document - to be decoded

Throws:

InvalidLLRPMessageException

Method Detail

encodeBinarySpecific

protected LLRPBitList encodeBinarySpecific()
                                    throws InvalidLLRPMessageException

encoding function - has to be implemented by each message.

Specified by:

encodeBinarySpecific in class LLRPMessage

Returns:

LLRPBitList

Throws:

InvalidLLRPMessageException

encodeXML

public org.jdom.Document encodeXML()
                            throws InvalidLLRPMessageException

create xml representation of this parameter.

Specified by:

encodeXML in class LLRPMessage

Returns:

Dom Document

Throws:

InvalidLLRPMessageException

decodeBinarySpecific

protected void decodeBinarySpecific(LLRPBitList binary)
                             throws InvalidLLRPMessageException

to be implemented by specific message.

Specified by:

decodeBinarySpecific in class LLRPMessage

Parameters:

binary - without header

Throws:

InvalidLLRPMessageException

decodeXML

public void decodeXML(org.jdom.Document document)
               throws InvalidLLRPMessageException

create objects from xml.

Specified by:

decodeXML in class LLRPMessage

Parameters:

document - document as jdom document

Throws:

InvalidLLRPMessageException

setVendorIdentifier

public void setVendorIdentifier(UnsignedInteger vendorIdentifier)

set vendorIdentifier of type UnsignedInteger .

Parameters:

vendorIdentifier - to be set

setMessageSubtype

public void setMessageSubtype(UnsignedByte messageSubtype)

set messageSubtype of type UnsignedByte .

Parameters:

messageSubtype - to be set

setData

public void setData(BytesToEnd_HEX data)

set data of type BytesToEnd_HEX .

Parameters:

data - to be set

getVendorIdentifier

public UnsignedInteger getVendorIdentifier()

get vendorIdentifier of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getMessageSubtype

public UnsignedByte getMessageSubtype()

get messageSubtype of type UnsignedByte.

Returns:

type UnsignedByte to be set

getData

public BytesToEnd_HEX getData()

get data of type BytesToEnd_HEX.

Returns:

BytesToEnd_HEX

getResponseType

public java.lang.String getResponseType()

Description copied from class: LLRPMessage

response message type awaited

Specified by:

getResponseType in class LLRPMessage

Returns:

String

getName

public java.lang.String getName()

Description copied from class: LLRPMessage

name of message (same as class name)

Specified by:

getName in class LLRPMessage

Returns:

String

getTypeNum

public SignedShort getTypeNum()

return uniuque type number.

Specified by:

getTypeNum in class LLRPMessage

Returns:

SignedShort holding unique type number