LLRP::CRFSurveySpec Class Reference
[Core Parameter Classes]

Class Definition CRFSurveySpec for LLRP parameter RFSurveySpec. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CRFSurveySpec:

LLRP::CParameter LLRP::CElement

List of all members.

Public Member Functions

llrp_u16_t getAntennaID (void)
 Get accessor functions for the LLRP AntennaID field.
void setAntennaID (llrp_u16_t value)
 Set accessor functions for the LLRP AntennaID field.
llrp_u32_t getStartFrequency (void)
 Get accessor functions for the LLRP StartFrequency field.
void setStartFrequency (llrp_u32_t value)
 Set accessor functions for the LLRP StartFrequency field.
llrp_u32_t getEndFrequency (void)
 Get accessor functions for the LLRP EndFrequency field.
void setEndFrequency (llrp_u32_t value)
 Set accessor functions for the LLRP EndFrequency field.
CRFSurveySpecStopTriggergetRFSurveySpecStopTrigger (void)
 Get accessor functions for the LLRP RFSurveySpecStopTrigger sub-parameter.
EResultCode setRFSurveySpecStopTrigger (CRFSurveySpecStopTrigger *pValue)
 Set accessor functions for the LLRP RFSurveySpecStopTrigger 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.
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_fdAntennaID
Internal Framework Functions


static const CFieldDescriptor s_fdStartFrequency
Internal Framework Functions


static const CFieldDescriptor s_fdEndFrequency

Protected Attributes

llrp_u16_t m_AntennaID
llrp_u32_t m_StartFrequency
llrp_u32_t m_EndFrequency
CRFSurveySpecStopTriggerm_pRFSurveySpecStopTrigger
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.
static CElements_construct (void)
static void s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)


Detailed Description

Class Definition CRFSurveySpec for LLRP parameter RFSurveySpec.

This parameter defines RF Survey operations. RF Survey is an operation during which the Reader performs a scan and measures the power levels across a set of frequencies at an antenna. This parameter defines the identifier of the antenna where this survey is to be performed, the duration of the survey operation (specified via stop trigger), and the range of frequencies to measure power levels of.

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


Member Function Documentation

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