org.llrp.ltk.generated.parameters
Class ReaderEventNotificationData

java.lang.Object
  org.llrp.ltk.types.LLRPParameter
      org.llrp.ltk.types.TLVParameter
          org.llrp.ltk.generated.parameters.ReaderEventNotificationData

public class ReaderEventNotificationData
extends TLVParameter

This parameter describes the contents of the event notification sent by the Reader, and defines the events that cause the notification to be sent. Event notification messages may be sent by the Reader due to connection establishment/closing event, critical events such as hopping, fault-detection in a Reader functional block, buffer overflow, due to the activation of a Reader accessory trigger input (e.g. motion detection), or due to performance monitoring events such as abnormalities in the RF environment.Timestamp is the time that the events reported occurred.LLRP assumes a reliable stream transport mechanism. Messages sent through LLRP will arrive in the order that they were sent over the transport and binding utilized. Status events within the same message SHALL be ordered chronologically.Status events delivered by reader event notifications are useful, especially in conjunction with the tag report data. The following describes the requirements of the reader event notifications ordering with respect to the ordering of tag reports and Reader Event Notifications. The following requirements are made on the ordering of Event Parameters with respect to each other and to tag report Parameters. These statements apply if the respective status events and report triggers are enabled. If the start of an ROSpec is triggered by a GPI, the GPIEvent Parameter SHALL be sent before the ROSpecEvent Parameter signaling the start of the ROSpec.If the end of an ROSpec is triggered by a GPI, the GPIEvent Parameter SHALL be sent before the ROSpecEvent Parameter signaling the end of the ROSpec.If an ROSpec contains one or more AISpecs, the ROSpecEvent parameter signaling the end of an ROSpec SHALL be sent after the AISpecEvent Parameter signaling the end of the last AISpec within that ROSpec.If one ROSpec pre-empts another ROSpec, the ROSpecEvent parameter signaling the preemption of the first ROSpec SHALL be sent before the ROSpecEvent parameter signaling the start of the next ROSpec.Tag data received during an ROSpec execution SHALL be sent between the ROSpecEvent parameter signaling the start of the ROSpec and the ROSpecEvent parameter signaling the end or preemption of the ROSpec if the ROReportTrigger is not set to "None".Tag data received during an AISpec execution SHALL be sent before the AISpecEvent Parameter signaling the end of the AISpec if the ROReportTrigger is not "None" or "end of RO Spec"Tag data received during the time on a channel SHALL be sent after the HoppingEvent parameter that announced this channel and before the next HoppingEvent parameter when the ROReportTrigger is not "None" and N=1. See also LLRP Specification Section 13.2.6 and LLRP Specification Section 16.2.7.6 .

Field Summary

protected AISpecEvent	aISpecEvent
protected AntennaEvent	antennaEvent
protected ConnectionAttemptEvent	connectionAttemptEvent
protected ConnectionCloseEvent	connectionCloseEvent
protected java.util.List<Custom>	customList
protected GPIEvent	gPIEvent
protected HoppingEvent	hoppingEvent
protected ReaderExceptionEvent	readerExceptionEvent
protected ReportBufferLevelWarningEvent	reportBufferLevelWarningEvent
protected ReportBufferOverflowErrorEvent	reportBufferOverflowErrorEvent
protected RFSurveyEvent	rFSurveyEvent
protected ROSpecEvent	rOSpecEvent
protected Timestamp	timestamp
static SignedShort	TYPENUM

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

RESERVEDLENGTH, TYPENUMBERLENGTH

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

bitLength

Constructor Summary

ReaderEventNotificationData()
empty constructor to create new parameter.

ReaderEventNotificationData(org.jdom.Element element)
Constructor to create parameter from xml encoded parameter calls decodeXML to decode parameter.

ReaderEventNotificationData(LLRPBitList list)
Constructor to create parameter from binary encoded parameter calls decodeBinary to decode parameter.

Method Summary

void	addToCustomList(Custom custom) add element custom of type Custom .
protected void	decodeBinarySpecific(LLRPBitList binary) decoding function to be implemented by each parameter
void	decodeXML(org.jdom.Element element) create objects from xml.
LLRPBitList	encodeBinarySpecific() protected method to force subclasses to implement their specific encoding
org.jdom.Content	encodeXML(java.lang.String name, org.jdom.Namespace ns) create xml representation of this parameter.
AISpecEvent	getAISpecEvent() get aISpecEvent of type AISpecEvent .
AntennaEvent	getAntennaEvent() get antennaEvent of type AntennaEvent .
ConnectionAttemptEvent	getConnectionAttemptEvent() get connectionAttemptEvent of type ConnectionAttemptEvent .
ConnectionCloseEvent	getConnectionCloseEvent() get connectionCloseEvent of type ConnectionCloseEvent .
java.util.List<Custom>	getCustomList() get customList of type List <Custom> .
GPIEvent	getGPIEvent() get gPIEvent of type GPIEvent .
HoppingEvent	getHoppingEvent() get hoppingEvent of type HoppingEvent .
java.lang.String	getName() name of parameter (same as class name)
ReaderExceptionEvent	getReaderExceptionEvent() get readerExceptionEvent of type ReaderExceptionEvent .
ReportBufferLevelWarningEvent	getReportBufferLevelWarningEvent() get reportBufferLevelWarningEvent of type ReportBufferLevelWarningEvent .
ReportBufferOverflowErrorEvent	getReportBufferOverflowErrorEvent() get reportBufferOverflowErrorEvent of type ReportBufferOverflowErrorEvent .
RFSurveyEvent	getRFSurveyEvent() get rFSurveyEvent of type RFSurveyEvent .
ROSpecEvent	getROSpecEvent() get rOSpecEvent of type ROSpecEvent .
Timestamp	getTimestamp() get timestamp of type Timestamp .
SignedShort	getTypeNum() type number uniquely identifies a parameter.
static java.lang.Integer	length() For TLV Parameter length can not be determined at compile time.
void	setAISpecEvent(AISpecEvent aISpecEvent) set aISpecEvent of type AISpecEvent.
void	setAntennaEvent(AntennaEvent antennaEvent) set antennaEvent of type AntennaEvent.
void	setConnectionAttemptEvent(ConnectionAttemptEvent connectionAttemptEvent) set connectionAttemptEvent of type ConnectionAttemptEvent.
void	setConnectionCloseEvent(ConnectionCloseEvent connectionCloseEvent) set connectionCloseEvent of type ConnectionCloseEvent.
void	setCustomList(java.util.List<Custom> customList) set customList of type List <Custom>.
void	setGPIEvent(GPIEvent gPIEvent) set gPIEvent of type GPIEvent.
void	setHoppingEvent(HoppingEvent hoppingEvent) set hoppingEvent of type HoppingEvent.
void	setReaderExceptionEvent(ReaderExceptionEvent readerExceptionEvent) set readerExceptionEvent of type ReaderExceptionEvent.
void	setReportBufferLevelWarningEvent(ReportBufferLevelWarningEvent reportBufferLevelWarningEvent) set reportBufferLevelWarningEvent of type ReportBufferLevelWarningEvent.
void	setReportBufferOverflowErrorEvent(ReportBufferOverflowErrorEvent reportBufferOverflowErrorEvent) set reportBufferOverflowErrorEvent of type ReportBufferOverflowErrorEvent.
void	setRFSurveyEvent(RFSurveyEvent rFSurveyEvent) set rFSurveyEvent of type RFSurveyEvent.
void	setROSpecEvent(ROSpecEvent rOSpecEvent) set rOSpecEvent of type ROSpecEvent.
void	setTimestamp(Timestamp timestamp) set timestamp of type Timestamp.
java.lang.String	toString() return string representation.

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

decodeBinary, encodeBinary

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

getByteLength

Methods inherited from class java.lang.Object

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

Field Detail

TYPENUM

public static final SignedShort TYPENUM

timestamp

protected Timestamp timestamp

hoppingEvent

protected HoppingEvent hoppingEvent

gPIEvent

protected GPIEvent gPIEvent

rOSpecEvent

protected ROSpecEvent rOSpecEvent

reportBufferLevelWarningEvent

protected ReportBufferLevelWarningEvent reportBufferLevelWarningEvent

reportBufferOverflowErrorEvent

protected ReportBufferOverflowErrorEvent reportBufferOverflowErrorEvent

readerExceptionEvent

protected ReaderExceptionEvent readerExceptionEvent

rFSurveyEvent

protected RFSurveyEvent rFSurveyEvent

aISpecEvent

protected AISpecEvent aISpecEvent

antennaEvent

protected AntennaEvent antennaEvent

connectionAttemptEvent

protected ConnectionAttemptEvent connectionAttemptEvent

connectionCloseEvent

protected ConnectionCloseEvent connectionCloseEvent

customList

protected java.util.List<Custom> customList

Constructor Detail

ReaderEventNotificationData

public ReaderEventNotificationData()

empty constructor to create new parameter.

ReaderEventNotificationData

public ReaderEventNotificationData(LLRPBitList list)

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

Parameters:

list - to be decoded

ReaderEventNotificationData

public ReaderEventNotificationData(org.jdom.Element element)
                            throws InvalidLLRPMessageException

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

Parameters:

element - to be decoded

Throws:

InvalidLLRPMessageException

Method Detail

encodeBinarySpecific

public LLRPBitList encodeBinarySpecific()

protected method to force subclasses to implement their specific encoding

Specified by:

encodeBinarySpecific in class TLVParameter

Returns:

LLRPBitList

encodeXML

public org.jdom.Content encodeXML(java.lang.String name,
                                  org.jdom.Namespace ns)

create xml representation of this parameter.

Specified by:

encodeXML in class LLRPParameter

Parameters:

name - of element

ns - Namespace of elements

decodeBinarySpecific

protected void decodeBinarySpecific(LLRPBitList binary)

decoding function to be implemented by each parameter

Specified by:

decodeBinarySpecific in class TLVParameter

Parameters:

binary - binary representation of the parameter

decodeXML

public void decodeXML(org.jdom.Element element)
               throws InvalidLLRPMessageException

create objects from xml.

Specified by:

decodeXML in class LLRPParameter

Parameters:

element - to be decoded

Throws:

InvalidLLRPMessageException

setTimestamp

public void setTimestamp(Timestamp timestamp)

set timestamp of type Timestamp.

Parameters:

timestamp - to be set

setHoppingEvent

public void setHoppingEvent(HoppingEvent hoppingEvent)

set hoppingEvent of type HoppingEvent.

Parameters:

hoppingEvent - to be set

setGPIEvent

public void setGPIEvent(GPIEvent gPIEvent)

set gPIEvent of type GPIEvent.

Parameters:

gPIEvent - to be set

setROSpecEvent

public void setROSpecEvent(ROSpecEvent rOSpecEvent)

set rOSpecEvent of type ROSpecEvent.

Parameters:

rOSpecEvent - to be set

setReportBufferLevelWarningEvent

public void setReportBufferLevelWarningEvent(ReportBufferLevelWarningEvent reportBufferLevelWarningEvent)

set reportBufferLevelWarningEvent of type ReportBufferLevelWarningEvent.

Parameters:

reportBufferLevelWarningEvent - to be set

setReportBufferOverflowErrorEvent

public void setReportBufferOverflowErrorEvent(ReportBufferOverflowErrorEvent reportBufferOverflowErrorEvent)

set reportBufferOverflowErrorEvent of type ReportBufferOverflowErrorEvent.

Parameters:

reportBufferOverflowErrorEvent - to be set

setReaderExceptionEvent

public void setReaderExceptionEvent(ReaderExceptionEvent readerExceptionEvent)

set readerExceptionEvent of type ReaderExceptionEvent.

Parameters:

readerExceptionEvent - to be set

setRFSurveyEvent

public void setRFSurveyEvent(RFSurveyEvent rFSurveyEvent)

set rFSurveyEvent of type RFSurveyEvent.

Parameters:

rFSurveyEvent - to be set

setAISpecEvent

public void setAISpecEvent(AISpecEvent aISpecEvent)

set aISpecEvent of type AISpecEvent.

Parameters:

aISpecEvent - to be set

setAntennaEvent

public void setAntennaEvent(AntennaEvent antennaEvent)

set antennaEvent of type AntennaEvent.

Parameters:

antennaEvent - to be set

setConnectionAttemptEvent

public void setConnectionAttemptEvent(ConnectionAttemptEvent connectionAttemptEvent)

set connectionAttemptEvent of type ConnectionAttemptEvent.

Parameters:

connectionAttemptEvent - to be set

setConnectionCloseEvent

public void setConnectionCloseEvent(ConnectionCloseEvent connectionCloseEvent)

set connectionCloseEvent of type ConnectionCloseEvent.

Parameters:

connectionCloseEvent - to be set

setCustomList

public void setCustomList(java.util.List<Custom> customList)

set customList of type List <Custom>.

Parameters:

customList - to be set

getTimestamp

public Timestamp getTimestamp()

get timestamp of type Timestamp .

Returns:

Timestamp

getHoppingEvent

public HoppingEvent getHoppingEvent()

get hoppingEvent of type HoppingEvent .

Returns:

HoppingEvent

getGPIEvent

public GPIEvent getGPIEvent()

get gPIEvent of type GPIEvent .

Returns:

GPIEvent

getROSpecEvent

public ROSpecEvent getROSpecEvent()

get rOSpecEvent of type ROSpecEvent .

Returns:

ROSpecEvent

getReportBufferLevelWarningEvent

public ReportBufferLevelWarningEvent getReportBufferLevelWarningEvent()

get reportBufferLevelWarningEvent of type ReportBufferLevelWarningEvent .

Returns:

ReportBufferLevelWarningEvent

getReportBufferOverflowErrorEvent

public ReportBufferOverflowErrorEvent getReportBufferOverflowErrorEvent()

get reportBufferOverflowErrorEvent of type ReportBufferOverflowErrorEvent .

Returns:

ReportBufferOverflowErrorEvent

getReaderExceptionEvent

public ReaderExceptionEvent getReaderExceptionEvent()

get readerExceptionEvent of type ReaderExceptionEvent .

Returns:

ReaderExceptionEvent

getRFSurveyEvent

public RFSurveyEvent getRFSurveyEvent()

get rFSurveyEvent of type RFSurveyEvent .

Returns:

RFSurveyEvent

getAISpecEvent

public AISpecEvent getAISpecEvent()

get aISpecEvent of type AISpecEvent .

Returns:

AISpecEvent

getAntennaEvent

public AntennaEvent getAntennaEvent()

get antennaEvent of type AntennaEvent .

Returns:

AntennaEvent

getConnectionAttemptEvent

public ConnectionAttemptEvent getConnectionAttemptEvent()

get connectionAttemptEvent of type ConnectionAttemptEvent .

Returns:

ConnectionAttemptEvent

getConnectionCloseEvent

public ConnectionCloseEvent getConnectionCloseEvent()

get connectionCloseEvent of type ConnectionCloseEvent .

Returns:

ConnectionCloseEvent

getCustomList

public java.util.List<Custom> getCustomList()

get customList of type List <Custom> .

Returns:

List <Custom>

addToCustomList

public void addToCustomList(Custom custom)

add element custom of type Custom .

Parameters:

custom - of type Custom

length

public static java.lang.Integer length()

For TLV Parameter length can not be determined at compile time. This method therefore always returns 0.

Returns:

Integer always zero

getTypeNum

public SignedShort getTypeNum()

type number uniquely identifies a parameter.

Specified by:

getTypeNum in class LLRPParameter

Returns:

typeNum

getName

public java.lang.String getName()

name of parameter (same as class name)

Specified by:

getName in class LLRPParameter

Returns:

String

toString

public java.lang.String toString()

return string representation. All field values but no parameters are included

Overrides:

toString in class java.lang.Object

Returns:

String