LLRP::CImpinjFixedFrequencyList Class Reference
[Impinj Parameter Classes]

Class Definition CImpinjFixedFrequencyList for LLRP parameter ImpinjFixedFrequencyList. More...

#include <impinj_ltkcpp.h>

Inheritance diagram for LLRP::CImpinjFixedFrequencyList:

LLRP::CParameter LLRP::CElement

List of all members.

Public Member Functions

EImpinjFixedFrequencyMode getFixedFrequencyMode (void)
 Get accessor functions for the LLRP FixedFrequencyMode field.
void setFixedFrequencyMode (EImpinjFixedFrequencyMode value)
 Set accessor functions for the LLRP FixedFrequencyMode field.
llrp_u16v_t getChannelList (void)
 Get accessor functions for the LLRP ChannelList field.
void setChannelList (llrp_u16v_t value)
 Set accessor functions for the LLRP ChannelList 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_fdFixedFrequencyMode
Internal Framework Functions


static const CFieldDescriptor s_fdChannelList

Protected Attributes

EImpinjFixedFrequencyMode m_eFixedFrequencyMode
llrp_u16v_t m_ChannelList
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 CImpinjFixedFrequencyList for LLRP parameter ImpinjFixedFrequencyList.

This custom parameter allows the Reader to make intelligent decisions about which channel to use in fixed frequency or intelligent hopping regulatory regions. The Mode field determines how the Reader will select the active channel. When set to zero (disabled), the Reader ignores this parameter and instead uses the frequency information in the LLRP RFTransmitter parameter. When set to one, the Reader chooses the active channel automatically based on the rules of the regulatory region. When set to two, the Reader chooses the active channel from a configurable list of channel indices based on the FixedFrequencyTable parameter advertised in the Reader's capabilities. The maximum number of channels allowed in the configurable list varies by regulatory region. A repeated channel index means the Reader will use the channel multiple times. When Mode is set to zero or one, the ChannelList array is ignored.

This parameter may only be added in an operational mode (i.e. not disabled) when the Reader is operating in a fixed frequency or intelligent hopping regulatory region. The parameter contents must be consistent across all enabled antennas in an AISpec.

Copyright 2007, 2008 Impinj Inc.


Definition at line 3309 of file impinj_ltkcpp.h.


Member Function Documentation

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

Encode fields and subparameters.

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

Implements LLRP::CElement.

llrp_bool_t LLRP::CImpinjFixedFrequencyList::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