LTKCPP-- LLRP Toolkit C Plus Plus Library
Public Member Functions | Protected Attributes
CReaderEventNotificationData Class Reference

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

#include <out_ltkcpp.h>

List of all members.

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.
CHoppingEventgetHoppingEvent (void)
 Get accessor functions for the LLRP HoppingEvent sub-parameter.
EResultCode setHoppingEvent (CHoppingEvent *pValue)
 Set accessor functions for the LLRP HoppingEvent sub-parameter.
CGPIEventgetGPIEvent (void)
 Get accessor functions for the LLRP GPIEvent sub-parameter.
EResultCode setGPIEvent (CGPIEvent *pValue)
 Set accessor functions for the LLRP GPIEvent sub-parameter.
CROSpecEventgetROSpecEvent (void)
 Get accessor functions for the LLRP ROSpecEvent sub-parameter.
EResultCode setROSpecEvent (CROSpecEvent *pValue)
 Set accessor functions for the LLRP ROSpecEvent sub-parameter.
CReportBufferLevelWarningEventgetReportBufferLevelWarningEvent (void)
 Get accessor functions for the LLRP ReportBufferLevelWarningEvent sub-parameter.
EResultCode setReportBufferLevelWarningEvent (CReportBufferLevelWarningEvent *pValue)
 Set accessor functions for the LLRP ReportBufferLevelWarningEvent sub-parameter.
CReportBufferOverflowErrorEventgetReportBufferOverflowErrorEvent (void)
 Get accessor functions for the LLRP ReportBufferOverflowErrorEvent sub-parameter.
EResultCode setReportBufferOverflowErrorEvent (CReportBufferOverflowErrorEvent *pValue)
 Set accessor functions for the LLRP ReportBufferOverflowErrorEvent sub-parameter.
CReaderExceptionEventgetReaderExceptionEvent (void)
 Get accessor functions for the LLRP ReaderExceptionEvent sub-parameter.
EResultCode setReaderExceptionEvent (CReaderExceptionEvent *pValue)
 Set accessor functions for the LLRP ReaderExceptionEvent sub-parameter.
CRFSurveyEventgetRFSurveyEvent (void)
 Get accessor functions for the LLRP RFSurveyEvent sub-parameter.
EResultCode setRFSurveyEvent (CRFSurveyEvent *pValue)
 Set accessor functions for the LLRP RFSurveyEvent sub-parameter.
CAISpecEventgetAISpecEvent (void)
 Get accessor functions for the LLRP AISpecEvent sub-parameter.
EResultCode setAISpecEvent (CAISpecEvent *pValue)
 Set accessor functions for the LLRP AISpecEvent sub-parameter.
CAntennaEventgetAntennaEvent (void)
 Get accessor functions for the LLRP AntennaEvent sub-parameter.
EResultCode setAntennaEvent (CAntennaEvent *pValue)
 Set accessor functions for the LLRP AntennaEvent sub-parameter.
CConnectionAttemptEventgetConnectionAttemptEvent (void)
 Get accessor functions for the LLRP ConnectionAttemptEvent sub-parameter.
EResultCode setConnectionAttemptEvent (CConnectionAttemptEvent *pValue)
 Set accessor functions for the LLRP ConnectionAttemptEvent sub-parameter.
CConnectionCloseEventgetConnectionCloseEvent (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.
int countCustom (void)
 Count of the LLRP Custom sub-parameter list.
EResultCode addCustom (CParameter *pValue)
 Add a Custom to the LLRP sub-parameter list.
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.
CHoppingEventgetHoppingEvent (void)
 Get accessor functions for the LLRP HoppingEvent sub-parameter.
EResultCode setHoppingEvent (CHoppingEvent *pValue)
 Set accessor functions for the LLRP HoppingEvent sub-parameter.
CGPIEventgetGPIEvent (void)
 Get accessor functions for the LLRP GPIEvent sub-parameter.
EResultCode setGPIEvent (CGPIEvent *pValue)
 Set accessor functions for the LLRP GPIEvent sub-parameter.
CROSpecEventgetROSpecEvent (void)
 Get accessor functions for the LLRP ROSpecEvent sub-parameter.
EResultCode setROSpecEvent (CROSpecEvent *pValue)
 Set accessor functions for the LLRP ROSpecEvent sub-parameter.
CReportBufferLevelWarningEventgetReportBufferLevelWarningEvent (void)
 Get accessor functions for the LLRP ReportBufferLevelWarningEvent sub-parameter.
EResultCode setReportBufferLevelWarningEvent (CReportBufferLevelWarningEvent *pValue)
 Set accessor functions for the LLRP ReportBufferLevelWarningEvent sub-parameter.
CReportBufferOverflowErrorEventgetReportBufferOverflowErrorEvent (void)
 Get accessor functions for the LLRP ReportBufferOverflowErrorEvent sub-parameter.
EResultCode setReportBufferOverflowErrorEvent (CReportBufferOverflowErrorEvent *pValue)
 Set accessor functions for the LLRP ReportBufferOverflowErrorEvent sub-parameter.
CReaderExceptionEventgetReaderExceptionEvent (void)
 Get accessor functions for the LLRP ReaderExceptionEvent sub-parameter.
EResultCode setReaderExceptionEvent (CReaderExceptionEvent *pValue)
 Set accessor functions for the LLRP ReaderExceptionEvent sub-parameter.
CRFSurveyEventgetRFSurveyEvent (void)
 Get accessor functions for the LLRP RFSurveyEvent sub-parameter.
EResultCode setRFSurveyEvent (CRFSurveyEvent *pValue)
 Set accessor functions for the LLRP RFSurveyEvent sub-parameter.
CAISpecEventgetAISpecEvent (void)
 Get accessor functions for the LLRP AISpecEvent sub-parameter.
EResultCode setAISpecEvent (CAISpecEvent *pValue)
 Set accessor functions for the LLRP AISpecEvent sub-parameter.
CAntennaEventgetAntennaEvent (void)
 Get accessor functions for the LLRP AntennaEvent sub-parameter.
EResultCode setAntennaEvent (CAntennaEvent *pValue)
 Set accessor functions for the LLRP AntennaEvent sub-parameter.
CConnectionAttemptEventgetConnectionAttemptEvent (void)
 Get accessor functions for the LLRP ConnectionAttemptEvent sub-parameter.
EResultCode setConnectionAttemptEvent (CConnectionAttemptEvent *pValue)
 Set accessor functions for the LLRP ConnectionAttemptEvent sub-parameter.
CConnectionCloseEventgetConnectionCloseEvent (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.
int countCustom (void)
 Count of the LLRP Custom sub-parameter list.
EResultCode addCustom (CParameter *pValue)
 Add a Custom to the LLRP sub-parameter list.

Protected Attributes

CParameter * m_pTimestamp
CHoppingEventm_pHoppingEvent
CGPIEventm_pGPIEvent
CROSpecEventm_pROSpecEvent
CReportBufferLevelWarningEventm_pReportBufferLevelWarningEvent
CReportBufferOverflowErrorEventm_pReportBufferOverflowErrorEvent
CReaderExceptionEventm_pReaderExceptionEvent
CRFSurveyEventm_pRFSurveyEvent
CAISpecEventm_pAISpecEvent
CAntennaEventm_pAntennaEvent
CConnectionAttemptEventm_pConnectionAttemptEvent
CConnectionCloseEventm_pConnectionCloseEvent
std::list< CParameter * > m_listCustom

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
static const CTypeDescriptor s_typeDescriptor
void decodeFields (CDecoderStream *pDecoderStream)
void assimilateSubParameters (CErrorDetails *pError)
void encode (CEncoderStream *pEncoderStream) const
void decodeFields (CDecoderStream *pDecoderStream)
void assimilateSubParameters (CErrorDetails *pError)
void encode (CEncoderStream *pEncoderStream) const
static CElement * s_construct (void)
static void s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)
static CElement * s_construct (void)
static void s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)

Detailed Description

Class Definition CReaderEventNotificationData for LLRP parameter ReaderEventNotificationData.

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.

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 17320 of file Library/out_ltkcpp.h.


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