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

This Class defines the Data Type of the attribute. More...

#include <DataType.h>

List of all members.

Public Member Functions

bool operator== (const DataType &rhs) const
 Redefinition of operators == .
bool operator!= (const DataType &rhs) const
 Redefinition of operators != .
bool operator< (const DataType &rhs) const
 Redefinition of operators < .
bool operator<= (const DataType &rhs) const
 Redefinition of operators <= .
bool operator> (const DataType &rhs) const
 Redefinition of operators > .
bool operator>= (const DataType &rhs) const
 Redefinition of operators >= .
byte toByte () const
 Return the length in bytes of this data type.
bool isAnalog () const
 Return true if this data type is Analog.
bool isDiscret () const
 Return true if this data type is Discret.
bool isBoolean () const
 Return true if this data type is Boolean.
bool isNumber () const
 Return true if this data type is Number.
bool isString () const
 Return true if this data type is Character String or Octet String.
bool isLongString () const
 Return true if this data type is Long Character String or Long Octet String.
bool isSigned () const
 Return true if this data type is Signed.
int length () const
 Return the length in bytes of this data type.
const char * name () const
 Return the name of this data type.

Static Public Member Functions

static const DataTypefromByte (byte value)
 Return the DataType corresponding to the ordinal value.
static const DataType *const * values (int &size)
 Return an array of DataType pointers.

Static Public Attributes

static DataType NoData
 Null : No Data.
static DataType Data8bits
 General data : 8 bits.
static DataType Data16bits
 General data : 16 bits.
static DataType Data24bits
 General data : 24 bits.
static DataType Data32bits
 General data : 32 bits.
static DataType Data40bits
 General data : 40 bits.
static DataType Data48bits
 General data : 48 bits.
static DataType Data56bits
 General data : 56 bits.
static DataType Data64bits
 General data : 64 bits.
static DataType Boolean
 Logical : Boolean.
static DataType Bitmap8bits
 Bitmap : 8 bits.
static DataType Bitmap16bits
 Bitmap : 16 bits.
static DataType Bitmap24bits
 Bitmap : 24 bits.
static DataType Bitmap32bits
 Bitmap : 32 bits.
static DataType Bitmap40bits
 Bitmap : 40 bits.
static DataType Bitmap48bits
 Bitmap : 48 bits.
static DataType Bitmap56bits
 Bitmap : 56 bits.
static DataType Bitmap64bits
 Bitmap : 64 bits.
static DataType Unsigned8bits
 Unsigned integer : 8 bits.
static DataType Unsigned16bits
 Unsigned integer : 16 bits.
static DataType Unsigned24bits
 Unsigned integer : 24 bits.
static DataType Unsigned32bits
 Unsigned integer : 32 bits.
static DataType Unsigned40bits
 Unsigned integer : 40 bits.
static DataType Unsigned48bits
 Unsigned integer : 48 bits.
static DataType Unsigned56bits
 Unsigned integer : 56 bits.
static DataType Unsigned64bits
 Unsigned integer : 64 bits.
static DataType Signed8bits
 Signed integer : 8 bits.
static DataType Signed16bits
 Signed integer : 16 bits.
static DataType Signed24bits
 Signed integer : 24 bits.
static DataType Signed32bits
 Signed integer : 32 bits.
static DataType Signed40bits
 Signed integer : 40 bits.
static DataType Signed48bits
 Signed integer : 48 bits.
static DataType Signed56bits
 Signed integer : 56 bits.
static DataType Signed64bits
 Signed integer : 64 bits.
static DataType Enumeration8bits
 Enumeration : 8 bits.
static DataType Enumeration16bits
 Enumeration : 16 bits.
static DataType SemiPrecision
 Floating point : semi-precision.
static DataType SinglePrecision
 Floating point : single precision.
static DataType DoublePrecision
 Floating point : double precision.
static DataType OctetString
 String : Octet String (length defined in first byte)
static DataType CharacterString
 String : Character String (length defined in first byte)
static DataType LongOctetString
 string : Long Octet String (length defined in first two bytes)
static DataType LongCharString
 string : Long Character String (length defined in first two bytes)
static DataType ArrayOrdered
 Ordered sequence : Array.
static DataType StructureOrdered
 Ordered sequence : Structure.
static DataType SetCollection
 Collection : Set.
static DataType BagCollection
 Collection : Bag.
static DataType TimeOfDay
 Time : time of day.
static DataType DateOfDay
 Time : date of day.
static DataType UtcTime
 Time : UTC time.
static DataType ClusterId
 Identifier : Cluster ID.
static DataType AttributeId
 Identifier : Attribute ID.
static DataType BacNetOid
 Identifier : BACnet OID.
static DataType IeeeAddress
 Miscellaneous : IEEE Address.
static DataType SecurityKey128bits
 Miscellaneous : Security Key 128 bits.
static DataType Unknown
 Unknown.

Friends

ZCL_EXPORT friend bool operator== (DataTypeValue lvalue, const DataType &rhs)
 Redefinition of operators == .
ZCL_EXPORT friend bool operator== (const DataType &lhs, DataTypeValue rvalue)
 Redefinition of operators == .
ZCL_EXPORT friend bool operator!= (DataTypeValue lvalue, const DataType &rhs)
 Redefinition of operators != .
ZCL_EXPORT friend bool operator!= (const DataType &lhs, DataTypeValue rvalue)
 Redefinition of operators != .
ZCL_EXPORT friend bool operator< (DataTypeValue lvalue, const DataType &rhs)
 Redefinition of operators < .
ZCL_EXPORT friend bool operator< (const DataType &lhs, DataTypeValue rvalue)
 Redefinition of operators < .
ZCL_EXPORT friend bool operator> (DataTypeValue lvalue, const DataType &rhs)
 Redefinition of operators > .
ZCL_EXPORT friend bool operator> (const DataType &lhs, DataTypeValue rvalue)
 Redefinition of operators > .
ZCL_EXPORT friend bool operator<= (DataTypeValue lvalue, const DataType &rhs)
 Redefinition of operators <= .
ZCL_EXPORT friend bool operator<= (const DataType &lhs, DataTypeValue rvalue)
 Redefinition of operators <= .
ZCL_EXPORT friend bool operator>= (DataTypeValue lvalue, const DataType &rhs)
 Redefinition of operators >= .
ZCL_EXPORT friend bool operator>= (const DataType &lhs, DataTypeValue rvalue)
 Redefinition of operators >= .

Detailed Description

This Class defines the Data Type of the attribute.


Member Function Documentation

static const DataType& DataType::fromByte ( byte  value) [static]

Return the DataType corresponding to the ordinal value.

Parameters:
valuethe ordinal value of the searched DataType.
Returns:
the DataType or DataType::unknown if not found.
bool DataType::isAnalog ( ) const

Return true if this data type is Analog.

Returns:
true if this data type is Analog.
bool DataType::isBoolean ( ) const

Return true if this data type is Boolean.

Returns:
true if this data type is Boolean.
bool DataType::isDiscret ( ) const

Return true if this data type is Discret.

Returns:
true if this data type is Discret.
bool DataType::isLongString ( ) const

Return true if this data type is Long Character String or Long Octet String.

Returns:
true if this data type is Long Character String or Long Octet String.
bool DataType::isNumber ( ) const

Return true if this data type is Number.

  • DATA_8BITS to DATA_64BITS
  • BITMAP_8BITS to BITMAP_64BITS
  • UNSIGNED_8BITS to UNSIGNED_64BITS
  • SIGNED_8BITS to SIGNED_64BITS
  • ENUMERATION_8BITS to ENUMERATION_16BITS
  • UTC_TIME
  • CLUSTER_ID
  • ATTRIBUTE_ID
  • BACNET_OID
Returns:
true if this data type is Number.
bool DataType::isSigned ( ) const

Return true if this data type is Signed.

Returns:
true if this data type is Signed.
bool DataType::isString ( ) const

Return true if this data type is Character String or Octet String.

Returns:
true if this data type is Character String or Octet String.
int DataType::length ( ) const

Return the length in bytes of this data type.

Returns:
the length in bytes of this data type.
const char* DataType::name ( ) const

Return the name of this data type.

Returns:
the data type name.
byte DataType::toByte ( ) const

Return the length in bytes of this data type.

Returns:
the length in bytes of this data type.
static const DataType* const* DataType::values ( int &  size) [static]

Return an array of DataType pointers.

Parameters:
[out]sizethe returned array size.
Returns:
an array of of DataType pointers.

Member Data Documentation

Ordered sequence : Array.

See also:
ARRAY_ORDERED

Identifier : Attribute ID.

See also:
ATTRIBUTE_ID

Identifier : BACnet OID.

A Data Communication Protocol for Building Automation and Control Networks.

See also:
BACNET_OID

Collection : Bag.

See also:
BAG_COLLECTION

Bitmap : 16 bits.

See also:
BITMAP_8BITS

Bitmap : 24 bits.

See also:
BITMAP_8BITS

Bitmap : 32 bits.

See also:
BITMAP_8BITS

Bitmap : 40 bits.

See also:
BITMAP_8BITS

Bitmap : 48 bits.

See also:
BITMAP_48BITS

Bitmap : 56 bits.

See also:
BITMAP_56BITS

Bitmap : 64 bits.

See also:
BITMAP_64BITS

Bitmap : 8 bits.

See also:
BITMAP_8BITS

Logical : Boolean.

See also:
BOOLEAN_8BITS

String : Character String (length defined in first byte)

See also:
CHARACTER_STRING

Identifier : Cluster ID.

See also:
CLUSTER_ID

General data : 16 bits.

See also:
DATA_16BITS

General data : 24 bits.

See also:
DATA_24BITS

General data : 32 bits.

See also:
DATA_32BITS

General data : 40 bits.

See also:
DATA_40BITS

General data : 48 bits.

See also:
DATA_48BITS

General data : 56 bits.

See also:
DATA_56BITS

General data : 64 bits.

See also:
DATA_64BITS

General data : 8 bits.

See also:
DATA_8BITS

Time : date of day.

See also:
DATE_OF_DAY

Floating point : double precision.

See also:
DOUBLE_PRECISION

Enumeration : 16 bits.

See also:
ENUMERATION_16BITS

Enumeration : 8 bits.

See also:
ENUMERATION_8BITS

Miscellaneous : IEEE Address.

See also:
IEEE_ADDRESS

string : Long Character String (length defined in first two bytes)

See also:
LONG_CHAR_STRING

string : Long Octet String (length defined in first two bytes)

See also:
LONG_OCTET_STRING

Null : No Data.

See also:
NO_DATA_TYPE

String : Octet String (length defined in first byte)

See also:
OCTET_STRING

Miscellaneous : Security Key 128 bits.

See also:
SECURITY_KEY_128BITS

Floating point : semi-precision.

See also:
SEMI_PRECISION

Collection : Set.

See also:
SET_COLLECTION

Signed integer : 16 bits.

See also:
SIGNED_16BITS

Signed integer : 24 bits.

See also:
SIGNED_24BITS

Signed integer : 32 bits.

See also:
SIGNED_32BITS

Signed integer : 40 bits.

See also:
SIGNED_40BITS

Signed integer : 48 bits.

See also:
SIGNED_48BITS

Signed integer : 56 bits.

See also:
SIGNED_56BITS

Signed integer : 64 bits.

See also:
SIGNED_64BITS

Signed integer : 8 bits.

See also:
SIGNED_8BITS

Floating point : single precision.

See also:
SINGLE_PRECISION

Ordered sequence : Structure.

See also:
STRUCTURE_ORDERED

Time : time of day.

See also:
TIME_OF_DAY

Unknown.

See also:
UNKNOWN

Unsigned integer : 16 bits.

See also:
UNSIGNED_16BITS

Unsigned integer : 24 bits.

See also:
UNSIGNED_24BITS

Unsigned integer : 32 bits.

See also:
UNSIGNED_32BITS

Unsigned integer : 40 bits.

See also:
UNSIGNED_40BITS

Unsigned integer : 48 bits.

See also:
UNSIGNED_48BITS

Unsigned integer : 56 bits.

See also:
UNSIGNED_56BITS

Unsigned integer : 64 bits.

See also:
UNSIGNED_64BITS

Unsigned integer : 8 bits.

See also:
UNSIGNED_8BITS

Time : UTC time.

See also:
UTC_TIME

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