AlarmHistoryInfoData Class Reference

The data for the alarmHistoryInfo method. More...

#include <client.h>

Inheritance diagram for AlarmHistoryInfoData:

Public Member Functions
int32_t	oldID () const
	Get the ID of the oldest alarm [OUT].
void	setOldID (int32_t value)
	Set the ID of the oldest alarm [OUT].
int32_t	newID () const
	Get the ID of the newest alarm [OUT].
void	setNewID (int32_t value)
	Set the ID of the newest alarm [OUT].
uint32_t	historyCount () const
	Get the number of alarm history between oldID and newID (included) [OUT].
void	setHistoryCount (uint32_t value)
	Set the number of alarm history between oldID and newID (included) [OUT].
uint32_t	historySize () const
	Get the history size (number of storable alarms) [OUT].
void	setHistorySize (uint32_t value)
	Set the history size (number of storable alarms) [OUT].
Public Member Functions inherited from OperationData
void	setState (uint64_t senderId, ActivityStates state, uint64_t data=0)
	Set the activity state.
void	setProgress (uint64_t senderId, int32_t min, int32_t max, int32_t cur)
	Set the activity progress.
Public Member Functions inherited from ErrorData
	ErrorData ()
	Class contructor.
void	setErrorFromMessage (Message *src)
	Set error information from a source message.
void	clearError ()
	Clear the error information.
void	setError (Message::ErrCodes errCode)
	Set the error information.
void	setError (Message::ErrCodes errCode, uint16_t errExtra)
	Set the error information.
Message::ErrCodes	nackErrCode () const
	Get the received NACK error code : if the value equals Message::errCodesNoError then no NACK message was received.
uint16_t	nackErrExtra () const
	Get the optional error extra data of the last NACK message received from the remote device.

Additional Inherited Members
Public Attributes inherited from OperationData
Signal3< uint64_t, ActivityStates, uint64_t >	stateChanged
	Signal emitted when the state of the operation changes.
Signal4< uint64_t, int32_t, int32_t, int32_t >	progressChanged
	Signal emitted when the progress of the operation changes.
Protected Member Functions inherited from ErrorData
void	setNackErrCode (Message::ErrCodes value)
	Set the received NACK error code : if the value equals Message::errCodesNoError then no NACK message was received.
void	setNackErrExtra (uint16_t value)
	Set the optional error extra data of the last NACK message received from the remote device.
uint16_t	nackErrFlags () const
	Get the error information validity flags.
void	setNackErrFlags (uint16_t value)
	Set the error information validity flags.

Detailed Description

The data for the alarmHistoryInfo method.

See also

Client.alarmHistoryInfo

Member Function Documentation

historyCount()

uint32_t historyCount

(

)

const

Get the number of alarm history between oldID and newID (included) [OUT].

Returns

The parameter value

historySize()

uint32_t historySize

(

)

const

Get the history size (number of storable alarms) [OUT].

Returns

The parameter value

newID()

int32_t newID

(

)

const

Get the ID of the newest alarm [OUT].

Returns

The parameter value

oldID()

int32_t oldID

(

)

const

Get the ID of the oldest alarm [OUT].

Returns

The parameter value

setHistoryCount()

void setHistoryCount

(

uint32_t

value

)

Set the number of alarm history between oldID and newID (included) [OUT].

Parameters

value

The value to set

setHistorySize()

void setHistorySize

(

uint32_t

value

)

Set the history size (number of storable alarms) [OUT].

Parameters

value

The value to set

setNewID()

void setNewID

(

int32_t

value

)

Set the ID of the newest alarm [OUT].

Parameters

value

The value to set

setOldID()

void setOldID

(

int32_t

value

)

Set the ID of the oldest alarm [OUT].

Parameters

value

The value to set