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

Class Definition CC1G2Filter for LLRP parameter C1G2Filter. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CC1G2Filter:
LLRP::CParameter LLRP::CElement

Public Member Functions

EC1G2TruncateAction getT (void)
 Get accessor functions for the LLRP T field.
 
void setT (EC1G2TruncateAction value)
 Set accessor functions for the LLRP T field.
 
CC1G2TagInventoryMaskgetC1G2TagInventoryMask (void)
 Get accessor functions for the LLRP C1G2TagInventoryMask sub-parameter.
 
EResultCode setC1G2TagInventoryMask (CC1G2TagInventoryMask *pValue)
 Set accessor functions for the LLRP C1G2TagInventoryMask sub-parameter.
 
CC1G2TagInventoryStateAwareFilterActiongetC1G2TagInventoryStateAwareFilterAction (void)
 Get accessor functions for the LLRP C1G2TagInventoryStateAwareFilterAction sub-parameter.
 
EResultCode setC1G2TagInventoryStateAwareFilterAction (CC1G2TagInventoryStateAwareFilterAction *pValue)
 Set accessor functions for the LLRP C1G2TagInventoryStateAwareFilterAction sub-parameter.
 
CC1G2TagInventoryStateUnawareFilterActiongetC1G2TagInventoryStateUnawareFilterAction (void)
 Get accessor functions for the LLRP C1G2TagInventoryStateUnawareFilterAction sub-parameter.
 
EResultCode setC1G2TagInventoryStateUnawareFilterAction (CC1G2TagInventoryStateUnawareFilterAction *pValue)
 Set accessor functions for the LLRP C1G2TagInventoryStateUnawareFilterAction sub-parameter.
 
- Public Member Functions inherited from LLRP::CParameter
virtual llrp_bool_t isAllowedIn (const CTypeDescriptor *pEnclosingTypeDescriptor) const
 Validate whether the element is allowed as a base type in the enclosing element. More...
 
llrp_bool_t isAllowedExtension (const CTypeDescriptor *pEnclosingTypeDescriptor)
 Validate whether the element is allowed as an extension in the enclosing element. More...
 
- 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

EC1G2TruncateAction m_eT
 
CC1G2TagInventoryMaskm_pC1G2TagInventoryMask
 
CC1G2TagInventoryStateAwareFilterActionm_pC1G2TagInventoryStateAwareFilterAction
 
CC1G2TagInventoryStateUnawareFilterActionm_pC1G2TagInventoryStateUnawareFilterAction
 

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
 
static const CTypeDescriptor s_typeDescriptor
 
static const CFieldDescriptor s_fdT
 
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 CC1G2Filter for LLRP parameter C1G2Filter.

Document Reference LLRP Specification Section 15.2.1.2.1.1

Document Reference LLRP Specification Section 16.3.1.2.1.1

<p>This parameter carries information specific to C1G2 filter (in particular, the parameters for the select command) operation, and are optionally sent with each inventory command from the Client to the Reader. This sets up the target tag population that gets inventoried. For an inventory operation with multiple filters, multiple instances of filter parameters are sent. A filter parameter contains the following fields:</p> 


<ul>

<li>
<p>Target tag mask: This contains the information for the tag memory data pattern used for the select operation.</p> 
<li>
<p>T:  This value is set if the Client is interested in only a truncated portion of the tag to be backscattered by the tag. The portion that gets backscattered includes the portion of the tag ID following the mask. This bit has to be set only in the last filter-spec.</p> 
<li>
<p>TagInventoryStateAwareFilterAction: This is used if the TagInventoryStateAware flag is set to true in the InventoryParameterSpec. </p> 
<li>
<p>TagInventoryStateUnawareFilterAction: This is used if the TagInventoryStateAware flag is set to false in the InventoryParameterSpec.</p> 
    </ul> 

 <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 20217 of file ltkcpp.h.

Member Function Documentation

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