LTKCPP-- LLRP Toolkit C Plus Plus Library
Public Member Functions | Protected Attributes | List of all members
LLRP::CSET_READER_CONFIG Class Reference

Class Definition CSET_READER_CONFIG for LLRP message SET_READER_CONFIG. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CSET_READER_CONFIG:
LLRP::CMessage LLRP::CElement

Public Member Functions

llrp_u1_t getResetToFactoryDefault (void)
 Get accessor functions for the LLRP ResetToFactoryDefault field.
 
void setResetToFactoryDefault (llrp_u1_t value)
 Set accessor functions for the LLRP ResetToFactoryDefault field.
 
CReaderEventNotificationSpecgetReaderEventNotificationSpec (void)
 Get accessor functions for the LLRP ReaderEventNotificationSpec sub-parameter.
 
EResultCode setReaderEventNotificationSpec (CReaderEventNotificationSpec *pValue)
 Set accessor functions for the LLRP ReaderEventNotificationSpec sub-parameter.
 
std::list< CAntennaProperties * >
::iterator 
beginAntennaProperties (void)
 Returns the first element of the AntennaProperties sub-parameter list.
 
std::list< CAntennaProperties * >
::iterator 
endAntennaProperties (void)
 Returns the last element of the AntennaProperties sub-parameter list.
 
void clearAntennaProperties (void)
 Clears the LLRP AntennaProperties sub-parameter list.
 
int countAntennaProperties (void)
 Count of the LLRP AntennaProperties sub-parameter list.
 
EResultCode addAntennaProperties (CAntennaProperties *pValue)
 Add a AntennaProperties to the LLRP sub-parameter list.
 
std::list
< CAntennaConfiguration * >
::iterator 
beginAntennaConfiguration (void)
 Returns the first element of the AntennaConfiguration sub-parameter list.
 
std::list
< CAntennaConfiguration * >
::iterator 
endAntennaConfiguration (void)
 Returns the last element of the AntennaConfiguration sub-parameter list.
 
void clearAntennaConfiguration (void)
 Clears the LLRP AntennaConfiguration sub-parameter list.
 
int countAntennaConfiguration (void)
 Count of the LLRP AntennaConfiguration sub-parameter list.
 
EResultCode addAntennaConfiguration (CAntennaConfiguration *pValue)
 Add a AntennaConfiguration to the LLRP sub-parameter list.
 
CROReportSpecgetROReportSpec (void)
 Get accessor functions for the LLRP ROReportSpec sub-parameter.
 
EResultCode setROReportSpec (CROReportSpec *pValue)
 Set accessor functions for the LLRP ROReportSpec sub-parameter.
 
CAccessReportSpecgetAccessReportSpec (void)
 Get accessor functions for the LLRP AccessReportSpec sub-parameter.
 
EResultCode setAccessReportSpec (CAccessReportSpec *pValue)
 Set accessor functions for the LLRP AccessReportSpec sub-parameter.
 
CKeepaliveSpecgetKeepaliveSpec (void)
 Get accessor functions for the LLRP KeepaliveSpec sub-parameter.
 
EResultCode setKeepaliveSpec (CKeepaliveSpec *pValue)
 Set accessor functions for the LLRP KeepaliveSpec sub-parameter.
 
std::list< CGPOWriteData * >
::iterator 
beginGPOWriteData (void)
 Returns the first element of the GPOWriteData sub-parameter list.
 
std::list< CGPOWriteData * >
::iterator 
endGPOWriteData (void)
 Returns the last element of the GPOWriteData sub-parameter list.
 
void clearGPOWriteData (void)
 Clears the LLRP GPOWriteData sub-parameter list.
 
int countGPOWriteData (void)
 Count of the LLRP GPOWriteData sub-parameter list.
 
EResultCode addGPOWriteData (CGPOWriteData *pValue)
 Add a GPOWriteData to the LLRP sub-parameter list.
 
std::list
< CGPIPortCurrentState * >
::iterator 
beginGPIPortCurrentState (void)
 Returns the first element of the GPIPortCurrentState sub-parameter list.
 
std::list
< CGPIPortCurrentState * >
::iterator 
endGPIPortCurrentState (void)
 Returns the last element of the GPIPortCurrentState sub-parameter list.
 
void clearGPIPortCurrentState (void)
 Clears the LLRP GPIPortCurrentState sub-parameter list.
 
int countGPIPortCurrentState (void)
 Count of the LLRP GPIPortCurrentState sub-parameter list.
 
EResultCode addGPIPortCurrentState (CGPIPortCurrentState *pValue)
 Add a GPIPortCurrentState to the LLRP sub-parameter list.
 
CEventsAndReportsgetEventsAndReports (void)
 Get accessor functions for the LLRP EventsAndReports sub-parameter.
 
EResultCode setEventsAndReports (CEventsAndReports *pValue)
 Set accessor functions for the LLRP EventsAndReports 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.
 
- Public Member Functions inherited from LLRP::CMessage
void setMessageID (llrp_u32_t MessageID)
 Sets the LLRP Message ID for the Message.
 
llrp_u32_t getMessageID (void) const
 Gets the current LLRP Message ID for the Message.
 
- Public Member Functions inherited from LLRP::CElement
void addSubParameterToAllList (CParameter *pParameter)
 Add a subparameter to m_listAllSubParameters. Called by the accessor functions setXXX and addXXX. More...
 
void removeSubParameterFromAllList (CParameter *pParameter)
 Delete a subparameter from m_listAllSubParameters. Called by the accessor functions setXXX (to remove prior reference) clearXXX(). More...
 
void clearSubParameterList (tListOfParameters *pParameterList)
 Clear a list of subparameters. For each entry apply removeSubParameter(). More...
 
int walk (int(*pFunc)(const CElement *pElement, void *pArg), void *pArg, int iDepth, int nMaxDepth) const
 Recursive tree walk. The callback is invoked for each element.
 
EResultCode toXMLString (char *pBuffer, int nBuffer)
 A wrapper around LLRP::toXMLString() More...
 

Protected Attributes

llrp_u1_t m_ResetToFactoryDefault
 
CReaderEventNotificationSpecm_pReaderEventNotificationSpec
 
std::list< CAntennaProperties * > m_listAntennaProperties
 
std::list
< CAntennaConfiguration * > 
m_listAntennaConfiguration
 
CROReportSpecm_pROReportSpec
 
CAccessReportSpecm_pAccessReportSpec
 
CKeepaliveSpecm_pKeepaliveSpec
 
std::list< CGPOWriteData * > m_listGPOWriteData
 
std::list< CGPIPortCurrentState * > m_listGPIPortCurrentState
 
CEventsAndReportsm_pEventsAndReports
 
std::list< CParameter * > m_listCustom
 
- Protected Attributes inherited from LLRP::CMessage
llrp_u32_t m_MessageID
 

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
 
static const CTypeDescriptor s_typeDescriptor
 
static const CFieldDescriptor s_fdResetToFactoryDefault
 
void decodeFields (CDecoderStream *pDecoderStream)
 Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter. More...
 
void assimilateSubParameters (CErrorDetails *pError)
 Assimilates the decoded sub-parameters into m_listAllSubParameters. More...
 
void encode (CEncoderStream *pEncoderStream) const
 Encode fields and subparameters. More...
 
static CElements_construct (void)
 
static void s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)
 

Additional Inherited Members

- Public Attributes inherited from LLRP::CElement
const CTypeDescriptorm_pType
 The type descriptor desribing this element.
 
CElementm_pParent
 Element that encloses this one, NULL if this is top-level element.
 
tListOfParameters m_listAllSubParameters
 List of all sub elements.
 

Detailed Description

Class Definition CSET_READER_CONFIG for LLRP message SET_READER_CONFIG.

Document Reference LLRP Specification Section 12.1.3

Document Reference LLRP Specification Section 16.1.38

<p>This command is issued by the Client to the Reader. This command sets the Reader configuration using the parameters specified in this command.  Values passed by the SET_READER_CONFIG 

SHALL apply for the duration of the LLRP connection, or until the values are changed by additional SET_READER_CONFIG messages.

<p>For example, ROReportSpec defines the reporting of ROReport format and trigger for a ROSpec. ROReportSpec sent as part of SET_READER_CONFIG becomes the default ROReportSpec for the Reader. A ROReportSpec sent as part of ROSpec in the ADD_ROSPEC command overrides the default value for that ROSpec. However, in cases where there is no ROReportSpec specified in a ROSpec sent as part of ADD_ROSPEC, that particular ROSpec inherits the default ROReportSpec.</p> 


<p>The data field ResetToFactoryDefault informs the Reader to set all configurable values to factory defaults before applying the remaining parameters.</p> 

  <SMALL><i>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.</i></SMALL> 

Definition at line 5429 of file ltkcpp.h.

Member Function Documentation

void LLRP::CSET_READER_CONFIG::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]pErrorError details for encoded stream

Implements LLRP::CElement.

void LLRP::CSET_READER_CONFIG::decodeFields ( CDecoderStream pDecoderStream)
virtual

Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter.

Parameters
[in]pDecoderStreamThe stream from which to decode fields
Returns
void

Implements LLRP::CElement.

void LLRP::CSET_READER_CONFIG::encode ( CEncoderStream pEncoderStream) const
virtual

Encode fields and subparameters.

Parameters
[in]pEncoderStreamStream to encode
Returns
void

Implements LLRP::CElement.


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