Robox Library for Cpp: BCC/31 module 1.0.0
RLibCpp BCC/31 protocol implementation
|
Monitor items class: these are the monitors added by the user. More...
#include <basemonitor.h>
Classes | |
class | PtrVector |
Class to handle with lists of UserMonitorItem pointers. More... | |
Public Types | |
enum | DataTypes { dataTypeInvalid = 0 , dataTypeI8 = 1 , dataTypeU8 = 2 , dataTypeI16 = 3 , dataTypeU16 = 4 , dataTypeI32 = 5 , dataTypeU32 = 6 , dataTypeI64 = 7 , dataTypeU64 = 8 , dataTypeDouble = 9 , dataTypeFloat = 10 , dataTypeStringZ = 11 , dataTypeBool = 12 , dataTypeBit = 13 } |
Data types list. More... | |
typedef UserMonitorItem * | pUserMonitorItem |
Public Member Functions | |
UserMonitorItem () | |
Default class constructor. | |
virtual | ~UserMonitorItem () |
Destructor. | |
Message::VarTypes | type () const |
Get the message type Message::VarTypes | |
void | setType (Message::VarTypes value) |
Set the message type Message::VarTypes | |
uint32_t | index () const |
Get the item index. | |
void | setIndex (uint32_t value) |
Set the item index. | |
uint32_t | aIndex () const |
Get the axis index. | |
void | setAIndex (uint32_t value) |
Set the axis index. | |
uint32_t | bit () const |
Get the bit index. | |
void | setBit (uint32_t value) |
Set the bit index. | |
uint32_t | repeat () const |
Get the repetitions number. | |
void | setRepeat (uint32_t value) |
Set the repetitions number. | |
uint32_t | size () const |
Get the size of single item (bytes) | |
void | setSize (uint32_t value) |
Set ths size of single item (bytes) | |
DataTypes | dataType () const |
Get the data type (DataTypes) | |
void | setDataType (DataTypes value) |
Set the data type (DataTypes) | |
String & | name () |
Get the variable name : meaningful only if Type is Message::varNamed | |
void | setName (const String &value) |
Set the variable name : meaningful only if Type is Message::varNamed | |
Static Public Member Functions | |
static UserMonitorItem * | fromVariable (const Variable &variable, Globals::Results &result) |
Factory helper method to create a UserMonitorItem from a Variable | |
static DataTypes | getDataTypeFromBase (int baseType) |
Get the DataTypes from base types. | |
Monitor items class: these are the monitors added by the user.
typedef UserMonitorItem* pUserMonitorItem |
enum DataTypes |
Data types list.
UserMonitorItem | ( | ) |
Default class constructor.
|
virtual |
Destructor.
uint32_t aIndex | ( | ) | const |
Get the axis index.
uint32_t bit | ( | ) | const |
Get the bit index.
|
static |
Factory helper method to create a UserMonitorItem from a Variable
variable | The Variable from which the UserMonitorItem will be initialized |
result | The operation result: if the value is different from Globals::resSuccess some error occurred and the returned item value will be null |
|
static |
Get the DataTypes from base types.
baseType | The base types to convert |
uint32_t index | ( | ) | const |
Get the item index.
String & name | ( | ) |
Get the variable name : meaningful only if Type is Message::varNamed
uint32_t repeat | ( | ) | const |
Get the repetitions number.
void setAIndex | ( | uint32_t | value | ) |
Set the axis index.
value | The value to set |
void setBit | ( | uint32_t | value | ) |
Set the bit index.
value | The value to set |
void setIndex | ( | uint32_t | value | ) |
Set the item index.
value | The value to set |
void setName | ( | const String & | value | ) |
Set the variable name : meaningful only if Type is Message::varNamed
value | The value to set |
void setRepeat | ( | uint32_t | value | ) |
Set the repetitions number.
value | The value to set |
void setSize | ( | uint32_t | value | ) |
Set ths size of single item (bytes)
value | The value to set |
void setType | ( | Message::VarTypes | value | ) |
Set the message type Message::VarTypes
value | The value to set |
uint32_t size | ( | ) | const |
Get the size of single item (bytes)
Message::VarTypes type | ( | ) | const |
Get the message type Message::VarTypes