ZEndPoint Class Reference

This Class defines the EndPoint of a Zigbee node. More...

#include <ZEndPoint.h>

List of all members.

Public Member Functions
	ZEndPoint (byte number=0)
	Constructor.
	ZEndPoint (const ZEndPoint &rhs)
	Redefinition of the copy-Constructor.
virtual	~ZEndPoint ()
	Destructor.
ZEndPoint &	operator= (const ZEndPoint &rhs)
	Redefinition of the affectation Operator.
byte	getNumber () const
	Get the number of this End Point.
dbyte	getAppProfile () const
	Get the Application Profile identifier of this End Point.
void	setAppProfile (dbyte profileId)
	Set the Application Profile identifier of this End Point.
dbyte	getAppDevice () const
	Get the Application Device identifier of this End Point.
void	setAppDevice (dbyte deviceId)
	Set the Application Device identifier of this End Point.
void	addInCluster (dbyte inCluster)
	Add a In cluster (Server cluster) in this node.
void	addInClusters (dbyte inClusters[], int size)
	Add an array of In clusters (Server clusters) in this node.
void	addOutCluster (dbyte outCluster)
	Add an Out cluster (Client cluster) in this node.
void	addOutClusters (dbyte outClusters[], int size)
	Add an array of Out clusters (Client clusters) in this node.
bool	containsInClusters (dbyte clusterId) const
	Return true if the specified In cluster identifier (Server cluster) is contained in this node.
bool	containsOutClusters (dbyte clusterId) const
	Return true if the specified Out cluster identifier (Client cluster) is contained in this node.
const dbyte *	getInClusters (int &size) const
	Get the In cluster identifiers (Server clusters) of this node, or NULL if none.
const dbyte *	getOutClusters (int &size) const
	Get the Out clusters identifiers (Client clusters) of this node, or NULL if none.

---

Detailed Description

This Class defines the EndPoint of a Zigbee node.

---

Member Function Documentation

void ZEndPoint::addInCluster

(

dbyte

inCluster

)

Add a In cluster (Server cluster) in this node.

Parameters:

inCluster

the In cluster to be added.

void ZEndPoint::addInClusters	(	dbyte	inClusters[],
		int	size
	)

Add an array of In clusters (Server clusters) in this node.

Parameters:

inClusters	the In clusters to be added.
size	the clusters array size.

void ZEndPoint::addOutCluster

(

dbyte

outCluster

)

Add an Out cluster (Client cluster) in this node.

Parameters:

outCluster

the Out cluster to be added.

void ZEndPoint::addOutClusters	(	dbyte	outClusters[],
		int	size
	)

Add an array of Out clusters (Client clusters) in this node.

Parameters:

outClusters	the Out clusters to be added.
size	the clusters array size.

bool ZEndPoint::containsInClusters

(

dbyte

clusterId

)

const

Return true if the specified In cluster identifier (Server cluster) is contained in this node.

Parameters:

clusterId

the In clusters identifier.

Returns:

true if cluster is contained , otherwise false.

bool ZEndPoint::containsOutClusters

(

dbyte

clusterId

)

const

Return true if the specified Out cluster identifier (Client cluster) is contained in this node.

Parameters:

clusterId

the Out clusters identifier.

Returns:

true if cluster is contained , otherwise false.

dbyte ZEndPoint::getAppDevice

(

)

const

Get the Application Device identifier of this End Point.

Returns:

the Application Device identifier.

dbyte ZEndPoint::getAppProfile

(

)

const

Get the Application Profile identifier of this End Point.

Returns:

the Application Profile identifier.

const dbyte* ZEndPoint::getInClusters

(

int &

size

)

const

Get the In cluster identifiers (Server clusters) of this node, or NULL if none.

Parameters:

[out]

size

the returned array size.

Returns:

the In clusters identifiers as an array of dbytes, or NULL if none.

byte ZEndPoint::getNumber

(

)

const

Get the number of this End Point.

Returns:

the End Point number.

const dbyte* ZEndPoint::getOutClusters

(

int &

size

)

const

Get the Out clusters identifiers (Client clusters) of this node, or NULL if none.

Parameters:

[out]

size

the returned array size.

Returns:

the Out clusters identifiers as an array of dbytes, or NULL if none.

void ZEndPoint::setAppDevice

(

dbyte

deviceId

)

Set the Application Device identifier of this End Point.

Parameters:

deviceId

the Application Device identifier.

void ZEndPoint::setAppProfile

(

dbyte

profileId

)

Set the Application Profile identifier of this End Point.

Parameters:

profileId

the Application Profile identifier.

---

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

• ZEndPoint.h