openDAQ
Open data acquisition platform
Public Member Functions | List of all members
IPropertyMetadataReadArgs Struct Referenceabstract
Core Objects » Property » PropertyMetadataReadArgs

Inherits IEventArgs.

Detailed Description

Event arguments used in property metadata onRead events. Currently part of the "Suggested values" and "Selection values" read events. They allow listeners to override the read value of the metadata field.

Listeners of such events are expected to always override the current value via the setValue method.

Public Member Functions

virtual ErrCode INTERFACE_FUNC getProperty (IProperty **property)=0
 Gets the property that owns the metadata field. More...
 
virtual ErrCode INTERFACE_FUNC getValue (IBaseObject **value)=0
 Gets the current value of the metadata field. More...
 
virtual ErrCode INTERFACE_FUNC setValue (IBaseObject *value)=0
 Sets the current value of the metadata field. More...
 

Member Function Documentation

◆ getProperty()

virtual ErrCode INTERFACE_FUNC getProperty ( IProperty **  property)
pure virtual

Gets the property that owns the metadata field.

Parameters
propertyThe property that owns the metadata field.

◆ getValue()

virtual ErrCode INTERFACE_FUNC getValue ( IBaseObject **  value)
pure virtual

Gets the current value of the metadata field.

Parameters
valueThe value of the metadata field.

◆ setValue()

virtual ErrCode INTERFACE_FUNC setValue ( IBaseObject *  value)
pure virtual

Sets the current value of the metadata field.

Parameters
valueThe value of the metadata field.