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

This Class defines the Write attributes response payload. More...

#include <WriteAttributesResponsePayload.h>

Inheritance diagram for WriteAttributesResponsePayload:
ZCLPayload

List of all members.

Public Member Functions

 WriteAttributesResponsePayload (ZCLFrame *frame)
 Constructor.
bool isSuccessfulWriting () const
 Return true if that is a successful writing of all attributes.
void setSuccessfulWriting (bool success)
 Set to true if that is a successful writing of all attributes.
void addWriteAttributeResponse (const WriteAttributeResponse &attr)
 Add a Write attributes response in this payload.
const WriteAttributeResponsegetWriteAttributeResponses (int &size) const
 Get the array of Write attributes responses.
virtual const byte * toBytes (int &size)
 Return the WriteAttributesResponse payload as array of bytes.
virtual bool fromBytes (const byte payload[], int length)
 Build a WriteAttributesResponse payload from an array of bytes.

Detailed Description

This Class defines the Write attributes response payload.


Constructor & Destructor Documentation

WriteAttributesResponsePayload::WriteAttributesResponsePayload ( ZCLFrame frame)

Constructor.

Parameters:
framethe frame containing this payload.

Member Function Documentation

void WriteAttributesResponsePayload::addWriteAttributeResponse ( const WriteAttributeResponse attr)

Add a Write attributes response in this payload.

Parameters:
attrthe Write attributes response.
virtual bool WriteAttributesResponsePayload::fromBytes ( const byte  payload[],
int  length 
) [virtual]

Build a WriteAttributesResponse payload from an array of bytes.

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

Implements ZCLPayload.

const WriteAttributeResponse* WriteAttributesResponsePayload::getWriteAttributeResponses ( int &  size) const

Get the array of Write attributes responses.

Parameters:
[out]sizethe returned array size.
Returns:
the array of Write attributes responses.
bool WriteAttributesResponsePayload::isSuccessfulWriting ( ) const

Return true if that is a successful writing of all attributes.

Returns:
true if that is a successful writing of all attributes.
void WriteAttributesResponsePayload::setSuccessfulWriting ( bool  success)

Set to true if that is a successful writing of all attributes.

Parameters:
successtrue if that is a successful writing of all attributes.
virtual const byte* WriteAttributesResponsePayload::toBytes ( int &  size) [virtual]

Return the WriteAttributesResponse 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: