LLRP::CReaderEventNotificationData Class Reference
[Core Parameter Classes]

Class Definition CReaderEventNotificationData for LLRP parameter ReaderEventNotificationData. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CReaderEventNotificationData:

List of all members.

Internal Framework Functions
void	decodeFields (CDecoderStream *pDecoderStream)
	Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter.
void	assimilateSubParameters (CErrorDetails *pError)
	Assimilates the decoded sub-parameters into m_listAllSubParameters.
void	encode (CEncoderStream *pEncoderStream) const
	Encode fields and subparameters.
CElement *	s_construct (void)
void	s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)
const CFieldDescriptor *const	s_apFieldDescriptorTable []
const CTypeDescriptor	s_typeDescriptor
Public Member Functions
CParameter *	getTimestamp (void)
	Get accessor functions for the LLRP Timestamp sub-parameter.
EResultCode	setTimestamp (CParameter *pValue)
	Set accessor functions for the LLRP Timestamp sub-parameter.
CHoppingEvent *	getHoppingEvent (void)
	Get accessor functions for the LLRP HoppingEvent sub-parameter.
EResultCode	setHoppingEvent (CHoppingEvent *pValue)
	Set accessor functions for the LLRP HoppingEvent sub-parameter.
CGPIEvent *	getGPIEvent (void)
	Get accessor functions for the LLRP GPIEvent sub-parameter.
EResultCode	setGPIEvent (CGPIEvent *pValue)
	Set accessor functions for the LLRP GPIEvent sub-parameter.
CROSpecEvent *	getROSpecEvent (void)
	Get accessor functions for the LLRP ROSpecEvent sub-parameter.
EResultCode	setROSpecEvent (CROSpecEvent *pValue)
	Set accessor functions for the LLRP ROSpecEvent sub-parameter.
CReportBufferLevelWarningEvent *	getReportBufferLevelWarningEvent (void)
	Get accessor functions for the LLRP ReportBufferLevelWarningEvent sub-parameter.
EResultCode	setReportBufferLevelWarningEvent (CReportBufferLevelWarningEvent *pValue)
	Set accessor functions for the LLRP ReportBufferLevelWarningEvent sub-parameter.
CReportBufferOverflowErrorEvent *	getReportBufferOverflowErrorEvent (void)
	Get accessor functions for the LLRP ReportBufferOverflowErrorEvent sub-parameter.
EResultCode	setReportBufferOverflowErrorEvent (CReportBufferOverflowErrorEvent *pValue)
	Set accessor functions for the LLRP ReportBufferOverflowErrorEvent sub-parameter.
CReaderExceptionEvent *	getReaderExceptionEvent (void)
	Get accessor functions for the LLRP ReaderExceptionEvent sub-parameter.
EResultCode	setReaderExceptionEvent (CReaderExceptionEvent *pValue)
	Set accessor functions for the LLRP ReaderExceptionEvent sub-parameter.
CRFSurveyEvent *	getRFSurveyEvent (void)
	Get accessor functions for the LLRP RFSurveyEvent sub-parameter.
EResultCode	setRFSurveyEvent (CRFSurveyEvent *pValue)
	Set accessor functions for the LLRP RFSurveyEvent sub-parameter.
CAISpecEvent *	getAISpecEvent (void)
	Get accessor functions for the LLRP AISpecEvent sub-parameter.
EResultCode	setAISpecEvent (CAISpecEvent *pValue)
	Set accessor functions for the LLRP AISpecEvent sub-parameter.
CAntennaEvent *	getAntennaEvent (void)
	Get accessor functions for the LLRP AntennaEvent sub-parameter.
EResultCode	setAntennaEvent (CAntennaEvent *pValue)
	Set accessor functions for the LLRP AntennaEvent sub-parameter.
CConnectionAttemptEvent *	getConnectionAttemptEvent (void)
	Get accessor functions for the LLRP ConnectionAttemptEvent sub-parameter.
EResultCode	setConnectionAttemptEvent (CConnectionAttemptEvent *pValue)
	Set accessor functions for the LLRP ConnectionAttemptEvent sub-parameter.
CConnectionCloseEvent *	getConnectionCloseEvent (void)
	Get accessor functions for the LLRP ConnectionCloseEvent sub-parameter.
EResultCode	setConnectionCloseEvent (CConnectionCloseEvent *pValue)
	Set accessor functions for the LLRP ConnectionCloseEvent sub-parameter.
std::list< CParameter * >::iterator	beginCustom (void)
	Returns the first element of the Custom sub-parameter list.
std::list< CParameter * >::iterator	endCustom (void)
	Returns the last element of the Custom sub-parameter list.
void	clearCustom (void)
	Clears the LLRP Custom sub-parameter list.
EResultCode	addCustom (CParameter *pValue)
	Add a Custom to the LLRP sub-parameter list.
Protected Attributes
CParameter *	m_pTimestamp
CHoppingEvent *	m_pHoppingEvent
CGPIEvent *	m_pGPIEvent
CROSpecEvent *	m_pROSpecEvent
CReportBufferLevelWarningEvent *	m_pReportBufferLevelWarningEvent
CReportBufferOverflowErrorEvent *	m_pReportBufferOverflowErrorEvent
CReaderExceptionEvent *	m_pReaderExceptionEvent
CRFSurveyEvent *	m_pRFSurveyEvent
CAISpecEvent *	m_pAISpecEvent
CAntennaEvent *	m_pAntennaEvent
CConnectionAttemptEvent *	m_pConnectionAttemptEvent
CConnectionCloseEvent *	m_pConnectionCloseEvent
std::list< CParameter * >	m_listCustom

---

Detailed Description

Class Definition CReaderEventNotificationData for LLRP parameter ReaderEventNotificationData.

• Document Reference LLRP Specification Section 13.2.6

• Document Reference LLRP Specification Section 16.2.7.6

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.

Copyright 2006, 2007, EPCglobal Inc. The proprietary text of EPCglobal Inc. included here is in not a Contribution to the LLRP toolkit, under Apache License, Version 2.0. The right to use the proprietary text is limited to reproduction and display thereof within the work.

---

Definition at line 17499 of file ltkcpp.h.

---

Member Function Documentation

void LLRP::CReaderEventNotificationData::assimilateSubParameters (  CErrorDetails *  pError  )  [virtual]

Assimilates the decoded sub-parameters into m_listAllSubParameters. After fields are decoded, the CDecoder itself takes care of gathering the subparameters into m_listAllSubParameters. Once the end of the enclosing TLV (or message) is reached this assimilateSubParameters() function is called to create parameter refrences from the primary member variables. Parameters: [out]  pError  Error details for encoded stream Implements LLRP::CElement.

void LLRP::CReaderEventNotificationData::decodeFields (  CDecoderStream *  pDecoderStream  )  [virtual]

Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter. Parameters: [in]  pDecoderStream  The stream from which to decode fields Returns: void Implements LLRP::CElement.

void LLRP::CReaderEventNotificationData::encode (  CEncoderStream *  pEncoderStream  )  const [virtual]

Encode fields and subparameters. Parameters: [in]  pEncoderStream  Stream to encode Returns: void Implements LLRP::CElement.

---

The documentation for this class was generated from the following file:

• ltkcpp.h

---