openDAQ
Open data acquisition platform
PropertyMetadataReadArgsPtr Class Reference

Inherits EventArgsPtr< Interface >.

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

daq::PropertyPtr getProperty () const
 Gets the property that owns the metadata field. More...
 
daq::BaseObjectPtr getValue () const
 Gets the current value of the metadata field. More...
 
void setValue (const daq::BaseObjectPtr &value) const
 Sets the current value of the metadata field. More...
 

Member Function Documentation

◆ getProperty()

daq::PropertyPtr getProperty ( ) const
inline

Gets the property that owns the metadata field.

Returns
The property that owns the metadata field.

◆ getValue()

daq::BaseObjectPtr getValue ( ) const
inline

Gets the current value of the metadata field.

Returns
The value of the metadata field.

◆ setValue()

void setValue ( const daq::BaseObjectPtr &  value) const
inline

Sets the current value of the metadata field.

Parameters
valueThe value of the metadata field.