ZCL library  4.3
ZCL library to manage a Zigbee network
ClusterSpecificCommandPayload Class Reference

This Class defines the cluster specific command payload. More...

#include <ClusterSpecificCommandPayload.h>

Inheritance diagram for ClusterSpecificCommandPayload:
ZCLPayload

List of all members.

Public Member Functions

 ClusterSpecificCommandPayload (ZCLFrame *frame)
 Constructor.
const byte * getData (int &size) const
 Get the data of this specific cluster payload.
void setData (const byte data[], int length)
 Set the data of this specific cluster payload.
void addClusterSpecCmdAttribute (const ClusterSpecCmdAttribute &attr)
 Set the data of this cluster specific command payload as a set of cluster specific attributes.
virtual const byte * toBytes (int &size)
 Return the ClusterSpecificCommand payload as array of bytes.
virtual bool fromBytes (const byte payload[], int length)
 Build a ClusterSpecificCommand payload from an array of bytes.

Detailed Description

This Class defines the cluster specific command payload.


Constructor & Destructor Documentation

ClusterSpecificCommandPayload::ClusterSpecificCommandPayload ( ZCLFrame frame)

Constructor.

Parameters:
framethe frame containing this payload.

Member Function Documentation

void ClusterSpecificCommandPayload::addClusterSpecCmdAttribute ( const ClusterSpecCmdAttribute attr)

Set the data of this cluster specific command payload as a set of cluster specific attributes.

Parameters:
attra Cluster specific attribute.
virtual bool ClusterSpecificCommandPayload::fromBytes ( const byte  payload[],
int  length 
) [virtual]

Build a ClusterSpecificCommand payload from an array of bytes.

Parameters:
payloadthe payload as bytes.
lengththe array size.
Returns:
true if success, otherwise false.

Implements ZCLPayload.

const byte* ClusterSpecificCommandPayload::getData ( int &  size) const

Get the data of this specific cluster payload.

Parameters:
[out]size: the returned data array size.
Returns:
the data as an array of bytes.
void ClusterSpecificCommandPayload::setData ( const byte  data[],
int  length 
)

Set the data of this specific cluster payload.

Parameters:
datathe data as an array of bytes.
lengththe data array length.
virtual const byte* ClusterSpecificCommandPayload::toBytes ( int &  size) [virtual]

Return the ClusterSpecificCommand payload as array of bytes.

Parameters:
[out]sizethe returned array size.
Returns:
the array of bytes.

Implements ZCLPayload.


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