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

LLRP::CRegulatoryCapabilities Class Reference
[Core Parameter Classes]

Class Definition CRegulatoryCapabilities for LLRP parameter RegulatoryCapabilities. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CRegulatoryCapabilities:

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_u16_t getCountryCode (void)
 Get accessor functions for the LLRP CountryCode field.
void setCountryCode (llrp_u16_t value)
 Set accessor functions for the LLRP CountryCode field.
ECommunicationsStandard getCommunicationsStandard (void)
 Get accessor functions for the LLRP CommunicationsStandard field.
void setCommunicationsStandard (ECommunicationsStandard value)
 Set accessor functions for the LLRP CommunicationsStandard field.
CUHFBandCapabilitiesgetUHFBandCapabilities (void)
 Get accessor functions for the LLRP UHFBandCapabilities sub-parameter.
EResultCode setUHFBandCapabilities (CUHFBandCapabilities *pValue)
 Set accessor functions for the LLRP UHFBandCapabilities 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_fdCountryCode
Internal Framework Functions
const CFieldDescriptor s_fdCommunicationsStandard

Protected Attributes

llrp_u16_t m_CountryCode
ECommunicationsStandard m_eCommunicationsStandard
CUHFBandCapabilitiesm_pUHFBandCapabilities
std::list< CParameter * > m_listCustom

Detailed Description

Class Definition CRegulatoryCapabilities for LLRP parameter RegulatoryCapabilities.

This parameter carries the RF regulation specific attributes. They include regulatory standard, frequency band information, power levels supported, frequencies supported, and any air protocol specific values that are determined based on regulatory restriction.

The regulatory standard is encoded using two Integer fields, (Country Code, Communications standard) and it specifies the current operational regulatory mode of the device. This should not be used to reflect the ability to operate in regulatory environments which require configuration different from the current. This version of the LLRP protocol will have support for only the UHF band.

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


Member Function Documentation

void LLRP::CRegulatoryCapabilities::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::CRegulatoryCapabilities::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::CRegulatoryCapabilities::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:49 2008 for LTKCPP-- LLRP Toolkit C Plus Plus Library by  doxygen 1.3.9.1