PayloadRequest Class Reference

All TX packets that support payloads extend this class. More...

#include <XBee.h>

Inheritance diagram for PayloadRequest:

XBeeRequest Tx16Request Tx64Request ZBTxRequest

List of all members.

Public Member Functions

 PayloadRequest (uint8_t apiId, uint8_t frameId, uint8_t *payload, uint8_t payloadLength)
uint8_t * getPayload ()
 Returns the payload of the packet, if not null.
void setPayload (uint8_t *payloadPtr)
 Sets the payload array.
uint8_t getPayloadLength ()
 Returns the length of the payload array, as specified by the user.
void setPayloadLength (uint8_t payloadLength)
 Sets the length of the payload to include in the request.


Detailed Description

All TX packets that support payloads extend this class.

Member Function Documentation

void PayloadRequest::setPayloadLength ( uint8_t  payloadLength  ) 

Sets the length of the payload to include in the request.

For example if the payload array is 50 bytes and you only want the first 10 to be included in the packet, set the length to 10. Length must be <= to the array length.


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

Generated on Wed Dec 21 17:21:21 2011 for XBee-Arduino by  doxygen 1.5.8