The data for the alarmStackGet method.
More...
#include <client.h>
|
uint32_t | index () const |
| Get the alarm index. [IN/OUT].
|
|
void | setIndex (uint32_t value) |
| Set the alarm index. [IN/OUT].
|
|
uint16_t | code () const |
| Get the alarm code. [OUT].
|
|
void | setCode (uint16_t value) |
| Set the alarm code. [OUT].
|
|
uint16_t | axis () const |
| Get the alarm axis ID. [OUT].
|
|
void | setAxis (uint16_t value) |
| Set the alarm axis ID. [OUT].
|
|
String & | text () |
| Get the alarm text string [OUT].
|
|
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.
|
|
| 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.
|
|
The data for the alarmStackGet method.
- See also
- Client.alarmStackGet
◆ axis()
Get the alarm axis ID. [OUT].
- Returns
- The parameter value
◆ code()
Get the alarm code. [OUT].
- Returns
- The parameter value
◆ index()
Get the alarm index. [IN/OUT].
- Returns
- The parameter value
◆ setAxis()
void setAxis |
( |
uint16_t | value | ) |
|
Set the alarm axis ID. [OUT].
- Parameters
-
◆ setCode()
void setCode |
( |
uint16_t | value | ) |
|
Set the alarm code. [OUT].
- Parameters
-
◆ setIndex()
void setIndex |
( |
uint32_t | value | ) |
|
Set the alarm index. [IN/OUT].
- Parameters
-
◆ text()
Get the alarm text string [OUT].
- Returns
- The parameter value