FrameControl Class Reference

This Class defines the Frame Control of the ZCL frame. More...

#include <FrameControl.h>

List of all members.

Public Member Functions
FrameType::Value	getFrameType () const
	Get the frame type (entire profile or specific cluster).
void	setFrameType (const FrameType::Value type)
	Set the frame type (entire profile or specific cluster).
Direction::Value	getDirection () const
	Get the direction (server to client or client to server).
void	setDirection (const Direction::Value direction)
	Set the direction (server to client or client to server).
bool	isManufacturerCodePresent () const
	Check if the manufacturer code is present.
ManufacturerCode::Value	getManufacturerCode () const
	Get the manufacturer code.
void	setManufacturerCode (const ManufacturerCode::Value manufurerCode)
	Set the manufacturer code.
ResponseStatus::Value	getResponseStatus () const
	Get the status of the default response.
void	setResponseStatus (const ResponseStatus::Value status)
	Set the status of the default response.
byte	toByte () const
	Return the Frame control as a byte.
void	fromByte (const byte frameControl)
	Build a Frame control field from a byte.

---

Detailed Description

This Class defines the Frame Control of the ZCL frame.

---

Member Function Documentation

void FrameControl::fromByte

(

const byte

frameControl

)

Build a Frame control field from a byte.

Parameters:

frameControl

the frame control as a byte.

Direction::Value FrameControl::getDirection

(

)

const

Get the direction (server to client or client to server).

Returns:

the direction.

FrameType::Value FrameControl::getFrameType

(

)

const

Get the frame type (entire profile or specific cluster).

Returns:

the frame type.

ManufacturerCode::Value FrameControl::getManufacturerCode

(

)

const

Get the manufacturer code.

Returns:

the manufacturer code.

ResponseStatus::Value FrameControl::getResponseStatus

(

)

const

Get the status of the default response.

Returns:

the default response status.

bool FrameControl::isManufacturerCodePresent

(

)

const

Check if the manufacturer code is present.

Returns:

true if the manufacturer code is present.

void FrameControl::setDirection

(

const Direction::Value

direction

)

Set the direction (server to client or client to server).

Parameters:

direction

the direction.

void FrameControl::setFrameType

(

const FrameType::Value

type

)

Set the frame type (entire profile or specific cluster).

Parameters:

type	the frame type.

void FrameControl::setManufacturerCode

(

const ManufacturerCode::Value

manufurerCode

)

Set the manufacturer code.

Parameters:

manufurerCode

the manufacturer code.

void FrameControl::setResponseStatus

(

const ResponseStatus::Value

status

)

Set the status of the default response.

Parameters:

status

the default response status.

byte FrameControl::toByte

(

)

const

Return the Frame control as a byte.

Returns:

the byte.

---

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

• FrameControl.h