DefaultResponsePayload Class Reference

This Class defines the Default response payload. More...

#include <DefaultResponsePayload.h>

Inheritance diagram for DefaultResponsePayload:

List of all members.

Public Member Functions
	DefaultResponsePayload (ZCLFrame *frame)
	Constructor.
CmdId::Value	getCmdIdentifier () const
	Get the command identifier of this Default response.
void	setCmdIdentifier (CmdId::Value cmdId)
	Set the command identifier of this Default response.
byte	getCmdIdentifierAsValue () const
	Get the command identifier as a specific cluster value of this Default response.
void	setCmdIdentifierAsValue (byte value)
	Set the command identifier as a specific cluster value of this Default response.
Status::Value	getStatus () const
	Return the status of this Default response.
void	setStatus (Status::Value status)
	Set the status for this Default response.
virtual const byte *	toBytes (int &size)
	Return the DefaultResponse payload as array of bytes.
virtual bool	fromBytes (const byte payload[], int length)
	Build a DefaultResponse payload from an array of bytes.

---

Detailed Description

This Class defines the Default response payload.

---

Constructor & Destructor Documentation

DefaultResponsePayload::DefaultResponsePayload

(

ZCLFrame *

frame

)

Constructor.

Parameters:

frame

the frame containing this payload.

---

Member Function Documentation

virtual bool DefaultResponsePayload::fromBytes	(	const byte	payload[],
		int	length
	)		[virtual]

Build a DefaultResponse payload from an array of bytes.

Parameters:

payload	the payload as array of bytes.
length	the array length.

Returns:

true if success, otherwise false.

Implements ZCLPayload.

CmdId::Value DefaultResponsePayload::getCmdIdentifier

(

)

const

Get the command identifier of this Default response.

Returns:

the command identifier of this Default response.

byte DefaultResponsePayload::getCmdIdentifierAsValue

(

)

const

Get the command identifier as a specific cluster value of this Default response.

Returns:

he command identifier as a specific cluster value.

Status::Value DefaultResponsePayload::getStatus

(

)

const

Return the status of this Default response.

Returns:

the status of this Default response.

void DefaultResponsePayload::setCmdIdentifier

(

CmdId::Value

cmdId

)

Set the command identifier of this Default response.

Parameters:

cmdId

the Default response command identifier.

void DefaultResponsePayload::setCmdIdentifierAsValue

(

byte

value

)

Set the command identifier as a specific cluster value of this Default response.

Parameters:

value

the command identifier as a specific cluster value.

void DefaultResponsePayload::setStatus

(

Status::Value

status

)

Set the status for this Default response.

Parameters:

status

the Default response status.

virtual const byte* DefaultResponsePayload::toBytes

(

int &

size

)

[virtual]

Return the DefaultResponse payload as array of bytes.

Parameters:

size	the returned array size.

Returns:

the array of bytes.

Implements ZCLPayload.

---

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

• DefaultResponsePayload.h