Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

LLRP::CC1G2InventoryCommand Class Reference
[Core Parameter Classes]

Class Definition CC1G2InventoryCommand for LLRP parameter C1G2InventoryCommand. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CC1G2InventoryCommand:

LLRP::CParameter LLRP::CElement List of all members.

Internal Framework Functions

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.
CElements_construct (void)
void s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)
const CFieldDescriptor *const s_apFieldDescriptorTable []
const CTypeDescriptor s_typeDescriptor

Public Member Functions

llrp_u1_t getTagInventoryStateAware (void)
 Get accessor functions for the LLRP TagInventoryStateAware field.
void setTagInventoryStateAware (llrp_u1_t value)
 Set accessor functions for the LLRP TagInventoryStateAware field.
std::list< CC1G2Filter
* >::iterator 
beginC1G2Filter (void)
 Returns the first element of the C1G2Filter sub-parameter list.
std::list< CC1G2Filter
* >::iterator 
endC1G2Filter (void)
 Returns the last element of the C1G2Filter sub-parameter list.
void clearC1G2Filter (void)
 Clears the LLRP C1G2Filter sub-parameter list.
EResultCode addC1G2Filter (CC1G2Filter *pValue)
 Add a C1G2Filter to the LLRP sub-parameter list.
CC1G2RFControlgetC1G2RFControl (void)
 Get accessor functions for the LLRP C1G2RFControl sub-parameter.
EResultCode setC1G2RFControl (CC1G2RFControl *pValue)
 Set accessor functions for the LLRP C1G2RFControl sub-parameter.
CC1G2SingulationControlgetC1G2SingulationControl (void)
 Get accessor functions for the LLRP C1G2SingulationControl sub-parameter.
EResultCode setC1G2SingulationControl (CC1G2SingulationControl *pValue)
 Set accessor functions for the LLRP C1G2SingulationControl 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.
EResultCode addCustom (CParameter *pValue)
 Add a Custom to the LLRP sub-parameter list.

Static Public Attributes

Internal Framework Functions
const CFieldDescriptor s_fdTagInventoryStateAware

Protected Attributes

llrp_u1_t m_TagInventoryStateAware
std::list< CC1G2Filter * > m_listC1G2Filter
CC1G2RFControlm_pC1G2RFControl
CC1G2SingulationControlm_pC1G2SingulationControl
std::list< CParameter * > m_listCustom

Detailed Description

Class Definition CC1G2InventoryCommand for LLRP parameter C1G2InventoryCommand.

This parameter defines the C1G2 inventory-specific settings to be used during a particular C1G2 inventory operation. This comprises of C1G2Filter Parameter, C1G2RF Parameter and C1G2Singulation Parameter. It is not necessary that the Filter, RF Control and Singulation Control Parameters be specified in each and every inventory command. They are optional parameters. If not specified, the default values in the Reader are used during the inventory operation. If multiple C1G2Filter parameters are encapsulated by the Client in the C1G2InventoryCommand parameter, the ordering of the filter parameters determine the order of C1G2 air-protocol commands (e.g., Select command) generated by the Reader.

The TagInventoryStateAware flag is used to determine how to process all the C1G2Filter and C1G2Singulation parameters in this command. At a functional level, if the Client is managing the tag states during an inventory operation, it would set that flag to true and pass the appropriate fields in the C1G2 Filter and C1G2 Singulation parameters. If a reader set CanDoTagInventoryStateAwareSingulation to False in LLRPCapabilities (section 9.2.2), it SHALL ignore the TagInventoryStateAware flag.

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.


Definition at line 20687 of file ltkcpp.h.


Member Function Documentation

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

Encode fields and subparameters.

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

Implements LLRP::CElement.


The documentation for this class was generated from the following file:
Generated on Wed Nov 26 12:27:54 2008 for LTKCPP-- LLRP Toolkit C Plus Plus Library by  doxygen 1.3.9.1