DeviceItem Class Reference

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

#include <basemonitor.h>

Classes
class	PtrVector
	Class to handle with lists of DeviceItem pointers. More...

Public Types
typedef DeviceItem *	pDeviceItem

Public Member Functions
	DeviceItem ()
	Default class constructor.
	~DeviceItem ()
	Class destructor.
void	clear ()
	Clears data.
Message &	createBccCmd ()
	Get the BCC message for create operations.
Message &	writeBccCmd ()
	Get the BCC message for write operations.
DeviceMonitorItem::PtrVector &	deviceMonitorItemsList ()
	Get the list of DeviceMonitorItem sent within the message.
uint64_t	tag () const
	Get the tag data for derived class usage.
void	setTag (uint64_t value)
	Set the tag data for derived class usage.
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 monitor items will be generally reworked , splitted and merged into distinct BCC message with new monitor items: foreach monitor message, a structure this type is generated.

Member Typedef Documentation

pDeviceItem

typedef DeviceItem* pDeviceItem

Constructor & Destructor Documentation

DeviceItem()

DeviceItem

(

)

Default class constructor.

~DeviceItem()

~DeviceItem

(

)

Class destructor.

Member Function Documentation

clear()

void clear

(

)

Clears data.

createBccCmd()

Message & createBccCmd

(

)

Get the BCC message for create operations.

Returns

The parameter value

deviceMonitorItemsList()

DeviceMonitorItem::PtrVector & deviceMonitorItemsList

(

)

Get the list of DeviceMonitorItem sent within the message.

Returns

The parameter value

setTag()

void setTag

(

uint64_t

value

)

Set the tag data for derived class usage.

Parameters

value

The value to set

setWasReadFromDevice()

void setWasReadFromDevice

(

bool

value

)

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

Parameters

value

The value to set

tag()

uint64_t tag

(

)

const

Get the tag data for derived class usage.

Returns

The parameter value

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