LLRP::CImpinjSubRegulatoryRegion Class Reference
[Impinj Parameter Classes]

Class Definition CImpinjSubRegulatoryRegion for LLRP parameter ImpinjSubRegulatoryRegion. More...

#include <impinj_ltkcpp.h>

Inheritance diagram for LLRP::CImpinjSubRegulatoryRegion:

LLRP::CParameter LLRP::CElement

List of all members.

Public Member Functions

EImpinjRegulatoryRegion getRegulatoryRegion (void)
 Get accessor functions for the LLRP RegulatoryRegion field.
void setRegulatoryRegion (EImpinjRegulatoryRegion value)
 Set accessor functions for the LLRP RegulatoryRegion 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.

Static Public Attributes

Internal Framework Functions


static const CFieldDescriptor s_fdRegulatoryRegion

Protected Attributes

EImpinjRegulatoryRegion m_eRegulatoryRegion
std::list< CParameter * > m_listCustom

Internal Framework Functions



static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
static const CTypeDescriptor s_typeDescriptor
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.
llrp_bool_t isAllowedIn (const CTypeDescriptor *pEnclosingElementType) const
 Validate whether the element is allowed as a base type in the enclosing element.
static CElements_construct (void)
static void s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)


Detailed Description

Class Definition CImpinjSubRegulatoryRegion for LLRP parameter ImpinjSubRegulatoryRegion.

This custom parameter is used when a particular regulatory region supports multiple operational modes. The Reader validates the RegulatoryRegion field against the regulatory region advertised in the reader's capabilities and only allows compatible regions to be set. Note that when setting the sub-regulatory region using the SET_READER_CONFIG message, the ResetToFactoryDefault field must be set to true. This will delete any configured ROSpecs and AccessSpecs. Failure to set the ResetToFactoryDefault field will result in an error. The Client should subsequently issue a GET_READER_CAPABILITIES command after updating the regulatory region as the change may have affected the advertised tables.

After the reader accepts this parameter, it will begin to reload its regulatory settings; this can take several seconds. Applications should plan for an additional delay of several seconds for the SET_READER_CONFIG_RESPONSE. Note: An LLRP ResetToFactoryDefault that changes the RegulatoryRegion will have the same behavior.

Copyright 2007, 2008 Impinj Inc.


Definition at line 2675 of file impinj_ltkcpp.h.


Member Function Documentation

void LLRP::CImpinjSubRegulatoryRegion::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::CImpinjSubRegulatoryRegion::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::CImpinjSubRegulatoryRegion::encode ( CEncoderStream pEncoderStream  )  const [virtual]

Encode fields and subparameters.

Parameters:
[in] pEncoderStream Stream to encode
Returns:
void

Implements LLRP::CElement.

llrp_bool_t LLRP::CImpinjSubRegulatoryRegion::isAllowedIn ( const CTypeDescriptor pEnclosingTypeDescriptor  )  const [virtual]

Validate whether the element is allowed as a base type in the enclosing element.

Parameters:
[in] pEnclosingTypeDescriptor A pointer to the enclosing type
Returns:
TRUE if the element is allowed to be encoded within the EnclosingElement

FALSE if the element is not allowed to be encoded within the EnclosingElement

Reimplemented from LLRP::CParameter.


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

Generated on Wed Jun 6 11:55:50 2012 for LTKCPP-- LLRP Toolkit C Plus Plus Library by  doxygen 1.5.9