LLRP::CCustom Class Reference
[Core Parameter Classes]

Class Definition CCustom for LLRP parameter Custom. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CCustom:

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.
CElement *	s_construct (void)
void	s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)
const CFieldDescriptor *const	s_apFieldDescriptorTable []
const CTypeDescriptor	s_typeDescriptor
Public Member Functions
llrp_u32_t	getVendorIdentifier (void)
	Get accessor functions for the LLRP VendorIdentifier field.
void	setVendorIdentifier (llrp_u32_t value)
	Set accessor functions for the LLRP VendorIdentifier field.
llrp_u32_t	getParameterSubtype (void)
	Get accessor functions for the LLRP ParameterSubtype field.
void	setParameterSubtype (llrp_u32_t value)
	Set accessor functions for the LLRP ParameterSubtype field.
llrp_bytesToEnd_t	getData (void)
	Get accessor functions for the LLRP Data field.
void	setData (llrp_bytesToEnd_t value)
	Set accessor functions for the LLRP Data field.
Static Public Attributes
Internal Framework Functions
const CFieldDescriptor	s_fdVendorIdentifier
Internal Framework Functions
const CFieldDescriptor	s_fdParameterSubtype
Internal Framework Functions
const CFieldDescriptor	s_fdData
Protected Attributes
llrp_u32_t	m_VendorIdentifier
llrp_u32_t	m_ParameterSubtype
llrp_bytesToEnd_t	m_Data

---

Detailed Description

Class Definition CCustom for LLRP parameter Custom.

• Document Reference LLRP Specification Section 8.2

• Document Reference LLRP Specification Section 16.2.9

Certain Messages and Parameter Sets within LLRP allow for the insertion of vendor defined parameters

Clients SHALL accept messages (except for CUSTOM_MESSAGE) that contain custom parameters but MAY ignore all custom parameters within these messages. Readers SHALL accept messages (except for CUSTOM_MESSAGE) that contain custom parameters and SHALL return an error when such parameters are unsupported.

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

---

Member Function Documentation

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

• ltkcpp.h

---