Robox Library for Cpp: BCC/31 module 1.0.0
RLibCpp BCC/31 protocol implementation
Classes | Public Member Functions | List of all members
AlarmStackItem Class Reference

The data for a generic alarm item. More...

#include <client.h>

Classes

class  Vector
 Class to handle with lists of AlarmStackItem. More...
 

Public Member Functions

uint32_t index () const
 Get the alarm index.
 
void setIndex (uint32_t value)
 Set the alarm index.
 
uint16_t code () const
 Get the alarm code.
 
void setCode (uint16_t value)
 Set the alarm code.
 
uint16_t axis () const
 Get the alarm axis ID.
 
void setAxis (uint16_t value)
 Set the alarm axis ID.
 
String & text ()
 Get the alarm text string.
 
void setText (const String &value)
 

Detailed Description

The data for a generic alarm item.

Member Function Documentation

◆ axis()

uint32_t axis ( ) const

Get the alarm axis ID.

Returns
The parameter value

◆ code()

uint32_t code ( ) const

Get the alarm code.

Returns
The parameter value

◆ index()

uint32_t index ( ) const

Get the alarm index.

Returns
The parameter value

◆ setAxis()

void setAxis ( uint16_t value)

Set the alarm axis ID.

Parameters
valueThe value to set

◆ setCode()

void setCode ( uint16_t value)

Set the alarm code.

Parameters
valueThe value to set

◆ setIndex()

void setIndex ( uint32_t value)

Set the alarm index.

Parameters
valueThe value to set

◆ setText()

void setText ( const String & value)

◆ text()

String & text ( )

Get the alarm text string.

Returns
The parameter value