DeviceMonitorItem Class Reference

Structure for the effective monitor item stored into each BCC message. More...

#include <basemonitor.h>

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

Public Types
typedef DeviceMonitorItem *	pDeviceMonitorItem

Public Member Functions
	DeviceMonitorItem ()
	Public constructor.
virtual	~DeviceMonitorItem ()
	Public constructor.
UserMonitorItem *	srcMonItem () const
	Get the source (orginal user defined) UserMonitorItem
void	setSrcMonItem (UserMonitorItem *value)
	Set the message type Message::VarTypes
uint32_t	repeat () const
	Get the number of repetitions into the read message.
void	setRepeat (uint32_t value)
	Set the number of repetitions into the read message.
Variable::Data::PtrVector *	readSrcValues () const
	Get the user list values (related to the BaseData to which save the data read.
void	setReadSrcValues (Variable::Data::PtrVector *value)
	Set the user list values (related to the BaseData to which save the data read.
uint32_t	readSrcValuesOffset () const
	Get the starting offset of the readSrcValues to which save the data read.
void	setReadSrcValuesOffset (uint32_t value)
	Set the starting offset of the readSrcValues to which save the data read.
Variable::Data::PtrVector *	writeSrcValues () const
	Get the user list values (related to BaseData from which retrive the data to write.
void	setWriteSrcValues (Variable::Data::PtrVector *value)
	Set the user list values (related to BaseData from which retrive the data to write.
uint32_t	writeSrcValuesOffset () const
	Get the starting offset of the writeSrcValues from which retrive the data to write.
void	setWriteSrcValuesOffset (uint32_t value)
	Set the starting offset of the writeSrcValues from which retrive the data to write.

Detailed Description

Structure for the effective monitor item stored into each BCC message.

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 new monitor items, a structure this type is generated.

Member Typedef Documentation

pDeviceMonitorItem

typedef DeviceMonitorItem* pDeviceMonitorItem

Constructor & Destructor Documentation

DeviceMonitorItem()

DeviceMonitorItem

(

)

Public constructor.

~DeviceMonitorItem()

virtual ~DeviceMonitorItem ( )

virtual

Public constructor.

Member Function Documentation

readSrcValues()

Variable::Data::PtrVector * readSrcValues

(

)

const

Get the user list values (related to the BaseData to which save the data read.

Returns

The parameter value

readSrcValuesOffset()

uint32_t readSrcValuesOffset

(

)

const

Get the starting offset of the readSrcValues to which save the data read.

Returns

The parameter value

repeat()

uint32_t repeat

(

)

const

Get the number of repetitions into the read message.

Returns

The parameter value

Remarks

This value differs from SrcMonItem.Repeat when the monitor item is splitted into more messages

setReadSrcValues()

void setReadSrcValues

(

Variable::Data::PtrVector *

value

)

Set the user list values (related to the BaseData to which save the data read.

Parameters

value

The value to set

setReadSrcValuesOffset()

void setReadSrcValuesOffset

(

uint32_t

value

)

Set the starting offset of the readSrcValues to which save the data read.

Parameters

value

The value to set

setRepeat()

void setRepeat

(

uint32_t

value

)

Set the number of repetitions into the read message.

Parameters

value

The value to set

Remarks

This value differs from SrcMonItem.Repeat when the monitor item is splitted into more messages

setSrcMonItem()

void setSrcMonItem

(

UserMonitorItem *

value

)

Set the message type Message::VarTypes

Parameters

value

The value to set

Remarks

This field is useful to properly assign the read data

setWriteSrcValues()

void setWriteSrcValues

(

Variable::Data::PtrVector *

value

)

Set the user list values (related to BaseData from which retrive the data to write.

Parameters

value

The value to set

setWriteSrcValuesOffset()

void setWriteSrcValuesOffset

(

uint32_t

value

)

Set the starting offset of the writeSrcValues from which retrive the data to write.

Parameters

value

The value to set

srcMonItem()

UserMonitorItem * srcMonItem

(

)

const

Get the source (orginal user defined) UserMonitorItem

Returns

The parameter value

Remarks

This field is useful to properly assign the read data

writeSrcValues()

Variable::Data::PtrVector * writeSrcValues

(

)

const

Get the user list values (related to BaseData from which retrive the data to write.

Returns

The parameter value

writeSrcValuesOffset()

uint32_t writeSrcValuesOffset

(

)

const

Get the starting offset of the writeSrcValues from which retrive the data to write.

Returns

The parameter value