ReportingConfigurationAttribute Class Reference

This Class defines the Reporting Configuration attribute. More...

#include <ReportingConfigurationAttribute.h>

Inheritance diagram for ReportingConfigurationAttribute:

List of all members.

Public Member Functions
void	setIdentifier (dbyte attrId)
	Set the identifier of this attribute that is to be reported.
const DataType &	getDataType () const
	Get the data type of the attribute that is to be reported.
void	setDataType (const DataType &dataType)
	Set the data type of the attribute that is to be reported.
void	setDataType (DataTypeValue dataType)
	Set the data type of the attribute that is to be reported.
dbyte	getMinReportingInterval () const
	Get the minimum reporting interval in seconds.
void	setMinReportingInterval (dbyte min)
	Set the minimum reporting interval in seconds.
dbyte	getMaxReportingInterval () const
	Get the maximum reporting interval in seconds.
void	setMaxReportingInterval (dbyte max)
	Set the maximum reporting interval in seconds.
dbyte	getTimeoutPeriod () const
	Get the timeout period in seconds.
void	setTimeoutPeriod (dbyte period)
	Set the timeout period in seconds.
const byte *	getReportableChange (int &size) const
	Get the reportable change as an array of bytes.
long	getReportableChangeAsNumber () const
	Get the reportable change as a number.
long long	getReportableChangeAs64bitsNumber () const
	Get the reportable change as a 64 bits number.
float	getReportableChangeAsFloat () const
	Get the reportable change as a float.
double	getReportableChangeAsDouble () const
	Get the reportable change as a double.
void	setReportableChange (const byte value[], int length)
	Set the reportable change as an array of bytes.
void	setReportableChangeAsNumber (long value)
	Set the reportable change as a Number.
void	setReportableChangeAs64bitsNumber (long long value)
	Set the reportable change as a 64 bits Number.
void	setReportableChangeAsFloat (float value)
	Set the reportable change as a float.
void	setReportableChangeAsDouble (double value)
	Set the reportable change as a double.
virtual const byte *	toBytes (int &size)
	Return this attribute as array of bytes.

---

Detailed Description

This Class defines the Reporting Configuration attribute.

---

Member Function Documentation

const DataType& ReportingConfigurationAttribute::getDataType

(

)

const

Get the data type of the attribute that is to be reported.

Returns:

the attribute DataType.

dbyte ReportingConfigurationAttribute::getMaxReportingInterval

(

)

const

Get the maximum reporting interval in seconds.

That is the maximum interval, in seconds, between issuing reports. Only available if the direction is equals to VALUES_REPORTED.

Returns:

the maximum reporting interval in seconds.

dbyte ReportingConfigurationAttribute::getMinReportingInterval

(

)

const

Get the minimum reporting interval in seconds.

That is the minimum interval, in seconds, between issuing reports. Only available if the direction is equals to VALUES_REPORTED.

Returns:

the minimum reporting interval in seconds.

const byte* ReportingConfigurationAttribute::getReportableChange

(

int &

size

)

const

Get the reportable change as an array of bytes.

That is the minimum change for which this attribute is reported. This field is omitted for attributes of ’discrete’ data type. Only available if the direction is equals to VALUES_REPORTED.

Parameters:

[out]

size

the returned array size.

Returns:

the minimum change as an array of bytes

long long ReportingConfigurationAttribute::getReportableChangeAs64bitsNumber

(

)

const

Get the reportable change as a 64 bits number.

That is the minimum change for which this attribute is reported. This field is omitted for attributes of ’discrete’ data type. Only available if the direction is equals to VALUES_REPORTED. the DataType of this attribute must be equal to

• UNSIGNED_8BITS to UNSIGNED_64BITS
• SIGNED_8BITS to SIGNED_64BITS
• UTC_TIME

Returns:

the reportable change as a 64 bits number.

double ReportingConfigurationAttribute::getReportableChangeAsDouble

(

)

const

Get the reportable change as a double.

That is the minimum change for which this attribute is reported. This field is omitted for attributes of ’discrete’ data type. Only available if the direction is equals to VALUES_REPORTED. the DataType of this attribute must be equal to

• DataType.SEMI_PRECISION
• DataType.SINGLE_PRECISION
• DataType.DOUBLE_PRECISION

Returns:

the data as a double.

float ReportingConfigurationAttribute::getReportableChangeAsFloat

(

)

const

Get the reportable change as a float.

That is the minimum change for which this attribute is reported. This field is omitted for attributes of ’discrete’ data type. Only available if the direction is equals to VALUES_REPORTED. the DataType of this attribute must be equal to

• DataType.SEMI_PRECISION
• DataType.SINGLE_PRECISION

Returns:

the data as a float.

long ReportingConfigurationAttribute::getReportableChangeAsNumber

(

)

const

Get the reportable change as a number.

That is the minimum change for which this attribute is reported. This field is omitted for attributes of ’discrete’ data type. Only available if the direction is equals to VALUES_REPORTED. the DataType of this attribute must be equal to

• UNSIGNED_8BITS to UNSIGNED_32BITS
• SIGNED_8BITS to SIGNED_32BITS
• UTC_TIME

Returns:

the reportable change as a number.

dbyte ReportingConfigurationAttribute::getTimeoutPeriod

(

)

const

Get the timeout period in seconds.

That is the maximum expected time, in seconds, between received reports. Only available if the direction is equals to REPORTS_RECEIVED.

Returns:

the timeout period in seconds.

void ReportingConfigurationAttribute::setDataType

(

const DataType &

dataType

)

Set the data type of the attribute that is to be reported.

Parameters:

dataType

the attribute DataType.

void ReportingConfigurationAttribute::setDataType

(

DataTypeValue

dataType

)

Set the data type of the attribute that is to be reported.

Parameters:

dataType

the attribute DataType.

void ReportingConfigurationAttribute::setIdentifier

(

dbyte

attrId

)

Set the identifier of this attribute that is to be reported.

Parameters:

attrId

the attribute identifier.

Reimplemented from ReadReportingConfigAttribute.

void ReportingConfigurationAttribute::setMaxReportingInterval

(

dbyte

max

)

Set the maximum reporting interval in seconds.

That is the maximum interval, in seconds, between issuing reports. Only configurable if the direction is equals to VALUES_REPORTED.

Parameters:

max	the maximum reporting interval in seconds.

void ReportingConfigurationAttribute::setMinReportingInterval

(

dbyte

min

)

Set the minimum reporting interval in seconds.

That is the minimum interval, in seconds, between issuing reports. Only configurable if the direction is equals to VALUES_REPORTED.

Parameters:

min	the minimum reporting interval in seconds.

void ReportingConfigurationAttribute::setReportableChange	(	const byte	value[],
		int	length
	)

Set the reportable change as an array of bytes.

That is the minimum change for which this attribute is reported. This field is omitted for attributes of ’discrete’ data type. Only configurable if the direction is equals to VALUES_REPORTED.

Parameters:

value	the minimum change as an array of bytes.
length	the array length.

void ReportingConfigurationAttribute::setReportableChangeAs64bitsNumber

(

long long

value

)

Set the reportable change as a 64 bits Number.

That is the minimum change for which this attribute is reported. This field is omitted for attributes of ’discrete’ data type. Only configurable if the direction is equals to VALUES_REPORTED. the DataType of this attribute must be equal to

• UNSIGNED_8BITS to UNSIGNED_64BITS
• SIGNED_8BITS to SIGNED_64BITS
• UTC_TIME

Parameters:

value

the minimum change as a Number.

void ReportingConfigurationAttribute::setReportableChangeAsDouble

(

double

value

)

Set the reportable change as a double.

That is the minimum change for which this attribute is reported. This field is omitted for attributes of ’discrete’ data type. Only configurable if the direction is equals to VALUES_REPORTED. Warning: the DataType must be set before and must be equal to

• DataType.SEMI_PRECISION
• DataType.SINGLE_PRECISION
• DataType.DOUBLE_PRECISION

Parameters:

value

the minimum change as a double.

void ReportingConfigurationAttribute::setReportableChangeAsFloat

(

float

value

)

Set the reportable change as a float.

That is the minimum change for which this attribute is reported. This field is omitted for attributes of ’discrete’ data type. Only configurable if the direction is equals to VALUES_REPORTED. Warning: the DataType must be set before and must be equal to

• DataType.SEMI_PRECISION
• DataType.SINGLE_PRECISION

Parameters:

value

the minimum change as a float.

void ReportingConfigurationAttribute::setReportableChangeAsNumber

(

long

value

)

Set the reportable change as a Number.

That is the minimum change for which this attribute is reported. This field is omitted for attributes of ’discrete’ data type. Only configurable if the direction is equals to VALUES_REPORTED. the DataType of this attribute must be equal to

• UNSIGNED_8BITS to UNSIGNED_32BITS
• SIGNED_8BITS to SIGNED_32BITS
• UTC_TIME

Parameters:

value

the minimum change as a Number.

void ReportingConfigurationAttribute::setTimeoutPeriod

(

dbyte

period

)

Set the timeout period in seconds.

That is the maximum expected time, in seconds, between received reports. Only configurable if the direction is equals to REPORTS_RECEIVED.

Parameters:

period

the timeout period in seconds.

virtual const byte* ReportingConfigurationAttribute::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 ReadReportingConfigAttribute.

Reimplemented in ReadReportingConfigAttributeResponse.

---

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

• ReportingConfigurationAttribute.h