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

Class Definition CGET_READER_CONFIG for LLRP message GET_READER_CONFIG. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CGET_READER_CONFIG:
LLRP::CMessage LLRP::CElement

Public Member Functions

llrp_u16_t getAntennaID (void)
 Get accessor functions for the LLRP AntennaID field.
 
void setAntennaID (llrp_u16_t value)
 Set accessor functions for the LLRP AntennaID field.
 
EGetReaderConfigRequestedData getRequestedData (void)
 Get accessor functions for the LLRP RequestedData field.
 
void setRequestedData (EGetReaderConfigRequestedData value)
 Set accessor functions for the LLRP RequestedData field.
 
llrp_u16_t getGPIPortNum (void)
 Get accessor functions for the LLRP GPIPortNum field.
 
void setGPIPortNum (llrp_u16_t value)
 Set accessor functions for the LLRP GPIPortNum field.
 
llrp_u16_t getGPOPortNum (void)
 Get accessor functions for the LLRP GPOPortNum field.
 
void setGPOPortNum (llrp_u16_t value)
 Set accessor functions for the LLRP GPOPortNum field.
 
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_u16_t m_AntennaID
 
EGetReaderConfigRequestedData m_eRequestedData
 
llrp_u16_t m_GPIPortNum
 
llrp_u16_t m_GPOPortNum
 
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_fdAntennaID
 
static const CFieldDescriptor s_fdRequestedData
 
static const CFieldDescriptor s_fdGPIPortNum
 
static const CFieldDescriptor s_fdGPOPortNum
 
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 CGET_READER_CONFIG for LLRP message GET_READER_CONFIG.

Document Reference LLRP Specification Section 12.1.1

Document Reference LLRP Specification Section 16.1.36

<p>This command is issued by the Client to get the current configuration information of the Reader. The Requested Data passed in the command represents the parameter(s) of interest to the Client that has to be returned by the Reader.</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 4768 of file ltkcpp.h.

Member Function Documentation

void LLRP::CGET_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::CGET_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::CGET_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: