LLRP::CLLRPConfigurationStateValue Class Reference
[Core Parameter Classes]

Class Definition CLLRPConfigurationStateValue for LLRP parameter LLRPConfigurationStateValue. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CLLRPConfigurationStateValue:

LLRP::CParameter LLRP::CElement

List of all members.

Public Member Functions

llrp_u32_t getLLRPConfigurationStateValue (void)
 Get accessor functions for the LLRP LLRPConfigurationStateValue field.
void setLLRPConfigurationStateValue (llrp_u32_t value)
 Set accessor functions for the LLRP LLRPConfigurationStateValue field.

Static Public Attributes

Internal Framework Functions


static const CFieldDescriptor s_fdLLRPConfigurationStateValue

Protected Attributes

llrp_u32_t m_LLRPConfigurationStateValue

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.
static CElements_construct (void)
static void s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)


Detailed Description

Class Definition CLLRPConfigurationStateValue for LLRP parameter LLRPConfigurationStateValue.

This parameter, LLRPConfigurationStateValue, is a 32-bit value which represents a Reader's entire LLRP configuration state including: LLRP configuration parameters, vendor extension configuration parameters, ROSpecs, and AccessSpecs. A Reader SHALL change this value only:

A Reader SHALL not change this value when the CurrentState of a ROSpec or AccessSpec changes.

The mechanism used to compute the LLRP configuration state value is implementation dependent. However, a good implementation will insure that there's a high probability that the value will change when the Reader's configuration state changes.

It is expected that a Client will configure the Reader and then request the Reader's configuration state value. The Client will then save this state value. If this value does not change between two requests for it, then a Client may assume that the above components of the LLRP configuration have also not changed.

When requested by a Client, the Reader SHALL compute a state value based upon the Reader's current configuration state. Upon each request, the Reader SHALL return the same state value provided a Client has not altered the Reader's configuration state between requests. Aside from this requirement, the computation of the state value is implementation dependent.

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


Member Function Documentation

void LLRP::CLLRPConfigurationStateValue::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::CLLRPConfigurationStateValue::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::CLLRPConfigurationStateValue::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 Jun 6 11:55:53 2012 for LTKCPP-- LLRP Toolkit C Plus Plus Library by  doxygen 1.5.9