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

Structure for the effective BCC message sent to the device. More...

#include <oscilloscope.h>

Public Member Functions

 DeviceItem ()
 Default class constructor.
 
virtual ~DeviceItem ()
 Class destructor.
 
void clear ()
 Clears data.
 
MessagecreateBccCmd ()
 Get the BCC message for create operations.
 
MessagewriteBccCmd ()
 Get the BCC message for write operations.
 
DeviceOscilloscopeItem::PtrVectordeviceOscilloscopeItemsList ()
 Get the list of DeviceOscilloscopeItem sent within the message.
 
uint32_t deviceOscilloscopeId () const
 Get the oscillosocpe id returned from the device.
 
void setDeviceOscilloscopeId (uint32_t value)
 Set the oscillosocpe id returned from the device.
 
bool wasReadFromDevice () const
 Get the flag to indicate that the item was read once from the connected device.
 
void setWasReadFromDevice (bool value)
 Set the flag to indicate that the item was read once from the connected device.
 

Detailed Description

Structure for the effective BCC message sent to the device.

If non coeherent operations are allowed, the user defined oscilloscope items will be generally reworked , splitted and merged into distinct BCC message with new oscilloscope items: foreach oscilloscope message, a structure this type is generated.

Constructor & Destructor Documentation

◆ DeviceItem()

Default class constructor.

◆ ~DeviceItem()

virtual ~DeviceItem ( )
virtual

Class destructor.

Member Function Documentation

◆ clear()

void clear ( )

Clears data.

◆ createBccCmd()

Message & createBccCmd ( )

Get the BCC message for create operations.

Returns
The parameter value

◆ deviceOscilloscopeId()

uint32_t deviceOscilloscopeId ( ) const

Get the oscillosocpe id returned from the device.

Returns
The parameter value

◆ deviceOscilloscopeItemsList()

QList< DeviceOscilloscopeItem * > & deviceOscilloscopeItemsList ( )

Get the list of DeviceOscilloscopeItem sent within the message.

Returns
The parameter value

◆ setDeviceOscilloscopeId()

void setDeviceOscilloscopeId ( uint32_t value)

Set the oscillosocpe id returned from the device.

Parameters
valueThe value to set

◆ setWasReadFromDevice()

void setWasReadFromDevice ( bool value)

Set the flag to indicate that the item was read once from the connected device.

Parameters
valueThe value to set

◆ wasReadFromDevice()

bool wasReadFromDevice ( ) const

Get the flag to indicate that the item was read once from the connected device.

Returns
The parameter value

◆ writeBccCmd()

Message & writeBccCmd ( )

Get the BCC message for write operations.

Returns
The parameter value