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

This Class defines the Cluster Specific Command attribute. More...

#include <ClusterSpecCmdAttribute.h>

Inheritance diagram for ClusterSpecCmdAttribute:
ReportAttribute ReadAttribute DiscoveredAttribute Attribute

List of all members.

Public Member Functions

dbyte getIdentifier () const
 Get the identifier of this attribute (WARNING : not defined for ClusterSpecCmdAttribute).
void setIdentifier (dbyte attrId)
 Set the identifier of this attribute.
byte getCommand () const
 Get the command of the cluster specific command attribute.
void setCommand (byte cmd)
 Set the command of the Cluster Specific Command attribute.
int getPosition () const
 Get the position of this attribute in the command (1 to n).
void setPosition (int position)
 Set the position of this attribute in the command (1 to n).
void setDataAsNumber (long value)
 Set the data as a number of this attribute.
void setDataAs64bitsNumber (long long value)
 Set the data as a number of this attribute.
void setDataAsString (const char *value)
 Set the data as a String of this attribute.
void setDataAsBoolean (bool value)
 Set the data as a boolean of this attribute.
void setDataAsFloat (float value)
 Set the data as a float of this attribute.
void setDataAsDouble (double value)
 Set the data as a double of this attribute.
virtual const byte * toBytes (int &size)
 Return this attribute as array of bytes.

Detailed Description

This Class defines the Cluster Specific Command attribute.


Member Function Documentation

byte ClusterSpecCmdAttribute::getCommand ( ) const

Get the command of the cluster specific command attribute.

Returns:
the command.
dbyte ClusterSpecCmdAttribute::getIdentifier ( ) const

Get the identifier of this attribute (WARNING : not defined for ClusterSpecCmdAttribute).

Returns:
the attribute identifier.

Reimplemented from Attribute.

int ClusterSpecCmdAttribute::getPosition ( ) const

Get the position of this attribute in the command (1 to n).

Returns:
the position of this attribute in the command (1 to n).
void ClusterSpecCmdAttribute::setCommand ( byte  cmd)

Set the command of the Cluster Specific Command attribute.

Parameters:
cmdthe command.
void ClusterSpecCmdAttribute::setDataAs64bitsNumber ( long long  value)

Set the data as a number of this attribute.

Warning: the DataType must be set before and must be equal to

  • UNSIGNED_8BITS to UNSIGNED_64BITS
  • SIGNED_8BITS to SIGNED_64BITS
  • DATA_8BITS to DATA_64BITS
  • BITMAP_8BITS to BITMAP_64BITS
  • ENUMERATION_8BITS to ENUMERATION_16BITS
  • UTC_TIME
  • CLUSTER_ID
  • ATTRIBUTE_ID
  • BACNET_OID
  • BOOLEAN_8BITS
Parameters:
valuethe data as a number.
void ClusterSpecCmdAttribute::setDataAsBoolean ( bool  value)

Set the data as a boolean of this attribute.

Warning: the DataType must be set before and must be equal to

  • BOOLEAN_8BITS
Parameters:
valuethe data as a boolean.
void ClusterSpecCmdAttribute::setDataAsDouble ( double  value)

Set the data as a double of this attribute.

Warning: the DataType must be set before and must be equal to

  • DataType.SEMI_PRECISION
  • DataType.SINGLE_PRECISION
  • DataType.DOUBLE_PRECISION
Parameters:
valuethe data as a double.
void ClusterSpecCmdAttribute::setDataAsFloat ( float  value)

Set the data as a float of this attribute.

Warning: the DataType must be set before and must be equal to

  • DataType.SEMI_PRECISION
  • DataType.SINGLE_PRECISION
Parameters:
valuethe data as a float.
void ClusterSpecCmdAttribute::setDataAsNumber ( long  value)

Set the data as a number of this attribute.

Warning: the DataType must be set before and must be equal to

  • UNSIGNED_8BITS to UNSIGNED_32BITS
  • SIGNED_8BITS to SIGNED_32BITS
  • DATA_8BITS to DATA_32BITS
  • BITMAP_8BITS to BITMAP_32BITS
  • ENUMERATION_8BITS to ENUMERATION_16BITS
  • UTC_TIME
  • CLUSTER_ID
  • ATTRIBUTE_ID
  • BACNET_OID
  • BOOLEAN_8BITS
Parameters:
valuethe data as a number.
void ClusterSpecCmdAttribute::setDataAsString ( const char *  value)

Set the data as a String of this attribute.


Warning: the DataType must be set before and must be equal to

  • CHARACTER_STRING
  • LONG_CHAR_STRING
Parameters:
valuethe data as a string.
void ClusterSpecCmdAttribute::setIdentifier ( dbyte  attrId)

Set the identifier of this attribute.

(WARNING : not defined for ClusterSpecCmdAttribute).

Parameters:
attrIdthe attribute identifier.

Reimplemented from Attribute.

void ClusterSpecCmdAttribute::setPosition ( int  position)

Set the position of this attribute in the command (1 to n).

Parameters:
position
virtual const byte* ClusterSpecCmdAttribute::toBytes ( int &  size) [virtual]

Return this attribute as array of bytes.

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

Reimplemented from ReportAttribute.


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