LTKCPP-- LLRP Toolkit C Plus Plus Library
Public Member Functions | Protected Attributes | List of all members
LLRP::CCUSTOM_MESSAGE Class Reference

Class Definition CCUSTOM_MESSAGE for LLRP message CUSTOM_MESSAGE. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CCUSTOM_MESSAGE:
LLRP::CMessage LLRP::CElement

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_u8_t getMessageSubtype (void)
 Get accessor functions for the LLRP MessageSubtype field.
 
void setMessageSubtype (llrp_u8_t value)
 Set accessor functions for the LLRP MessageSubtype 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.
 
- Public Member Functions inherited from LLRP::CMessage
void setMessageID (llrp_u32_t MessageID)
 Sets the LLRP Message ID for the Message.
 
llrp_u32_t getMessageID (void) const
 Gets the current LLRP Message ID for the Message.
 
- Public Member Functions inherited from LLRP::CElement
void addSubParameterToAllList (CParameter *pParameter)
 Add a subparameter to m_listAllSubParameters. Called by the accessor functions setXXX and addXXX. More...
 
void removeSubParameterFromAllList (CParameter *pParameter)
 Delete a subparameter from m_listAllSubParameters. Called by the accessor functions setXXX (to remove prior reference) clearXXX(). More...
 
void clearSubParameterList (tListOfParameters *pParameterList)
 Clear a list of subparameters. For each entry apply removeSubParameter(). More...
 
int walk (int(*pFunc)(const CElement *pElement, void *pArg), void *pArg, int iDepth, int nMaxDepth) const
 Recursive tree walk. The callback is invoked for each element.
 
EResultCode toXMLString (char *pBuffer, int nBuffer)
 A wrapper around LLRP::toXMLString() More...
 

Protected Attributes

llrp_u32_t m_VendorIdentifier
 
llrp_u8_t m_MessageSubtype
 
llrp_bytesToEnd_t m_Data
 
- Protected Attributes inherited from LLRP::CMessage
llrp_u32_t m_MessageID
 

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
 
static const CTypeDescriptor s_typeDescriptor
 
static const CFieldDescriptor s_fdVendorIdentifier
 
static const CFieldDescriptor s_fdMessageSubtype
 
static const CFieldDescriptor s_fdData
 
void decodeFields (CDecoderStream *pDecoderStream)
 Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter. More...
 
void assimilateSubParameters (CErrorDetails *pError)
 Assimilates the decoded sub-parameters into m_listAllSubParameters. More...
 
void encode (CEncoderStream *pEncoderStream) const
 Encode fields and subparameters. More...
 
static CElements_construct (void)
 
static void s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)
 

Additional Inherited Members

- Public Attributes inherited from LLRP::CElement
const CTypeDescriptorm_pType
 The type descriptor desribing this element.
 
CElementm_pParent
 Element that encloses this one, NULL if this is top-level element.
 
tListOfParameters m_listAllSubParameters
 List of all sub elements.
 

Detailed Description

Class Definition CCUSTOM_MESSAGE for LLRP message CUSTOM_MESSAGE.

Document Reference LLRP Specification Section 8.1

Document Reference LLRP Specification Section 16.1.42

<p>This message carries a vendor defined format from Reader to Client or Client to Reader. </p> 


<p>No requirements are made as to the content or parameters contained within the Data portion of these messages. Clients 

MAY ignore CUSTOM_MESSAGEs. Readers SHALL accept CUSTOM_MESSAGE and return an ERROR_MESSAGE if CUSTOM_MESSAGE is unsupported by the Reader or the CUSTOM_MESSAGE contains fields and/or parameters that are unsupported by the Reader.

<SMALL><i>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.</i></SMALL> 

Definition at line 1807 of file ltkcpp.h.

Member Function Documentation

void LLRP::CCUSTOM_MESSAGE::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]pErrorError details for encoded stream

Implements LLRP::CElement.

void LLRP::CCUSTOM_MESSAGE::decodeFields ( CDecoderStream pDecoderStream)
virtual

Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter.

Parameters
[in]pDecoderStreamThe stream from which to decode fields
Returns
void

Implements LLRP::CElement.

void LLRP::CCUSTOM_MESSAGE::encode ( CEncoderStream pEncoderStream) const
virtual

Encode fields and subparameters.

Parameters
[in]pEncoderStreamStream to encode
Returns
void

Implements LLRP::CElement.


The documentation for this class was generated from the following file: