LLRP::CCUSTOM_MESSAGE Class Reference
[Core Message Classes]

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

#include <ltkcpp.h>

Inheritance diagram for LLRP::CCUSTOM_MESSAGE:

LLRP::CMessage LLRP::CElement

List of all members.

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.

Static Public Attributes

Internal Framework Functions


static const CFieldDescriptor s_fdVendorIdentifier
Internal Framework Functions


static const CFieldDescriptor s_fdMessageSubtype
Internal Framework Functions


static const CFieldDescriptor s_fdData

Protected Attributes

llrp_u32_t m_VendorIdentifier
llrp_u8_t m_MessageSubtype
llrp_bytesToEnd_t m_Data

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 CCUSTOM_MESSAGE for LLRP message CUSTOM_MESSAGE.

This message carries a vendor defined format from Reader to Client or Client to Reader.

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.

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 2043 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] pError Error 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] pDecoderStream The 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] 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:52 2012 for LTKCPP-- LLRP Toolkit C Plus Plus Library by  doxygen 1.5.9