LLRP::CPeriodicTriggerValue Class Reference
[Core Parameter Classes]

Class Definition CPeriodicTriggerValue for LLRP parameter PeriodicTriggerValue. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CPeriodicTriggerValue:

LLRP::CParameter LLRP::CElement

List of all members.

Public Member Functions

llrp_u32_t getOffset (void)
 Get accessor functions for the LLRP Offset field.
void setOffset (llrp_u32_t value)
 Set accessor functions for the LLRP Offset field.
llrp_u32_t getPeriod (void)
 Get accessor functions for the LLRP Period field.
void setPeriod (llrp_u32_t value)
 Set accessor functions for the LLRP Period field.
CUTCTimestampgetUTCTimestamp (void)
 Get accessor functions for the LLRP UTCTimestamp sub-parameter.
EResultCode setUTCTimestamp (CUTCTimestamp *pValue)
 Set accessor functions for the LLRP UTCTimestamp sub-parameter.

Static Public Attributes

Internal Framework Functions


static const CFieldDescriptor s_fdOffset
Internal Framework Functions


static const CFieldDescriptor s_fdPeriod

Protected Attributes

llrp_u32_t m_Offset
llrp_u32_t m_Period
CUTCTimestampm_pUTCTimestamp

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 CPeriodicTriggerValue for LLRP parameter PeriodicTriggerValue.

Periodic trigger is specified using UTC time, offset and period.

For one-shot inventory, period is set to 0, and for periodic inventory operation period > 0.

If UTC time is not specified, the first start time is determined as (time of message receipt + offset), else, the first start time is determined as (UTC time + offset). Subsequent start times = first start time + k * period (where, k > 0).

If the Reader does not support UTC clock (as indicated by HasUTCClockCapability), and it receives the UTC time as part of the PeriodicTriggerValue parameter from the Client, the Reader SHALL return an error.

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


Member Function Documentation

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