openDAQ
Open data acquisition platform
GenericUpdateParametersPtrPtr< InterfaceType > Class Template Reference

IUpdateParameters interface provides a set of methods to give user flexibility to load instance configuration. More...

+ Inheritance diagram for GenericUpdateParametersPtrPtr< InterfaceType >:
+ Collaboration diagram for GenericUpdateParametersPtrPtr< InterfaceType >:

Detailed Description

template<typename InterfaceType>
class GenericUpdateParametersPtrPtr< InterfaceType >

IUpdateParameters interface provides a set of methods to give user flexibility to load instance configuration.

Public Member Functions

daq::Bool getReAddDevicesEnabled () const
 Returns whether the re-add devices is enabled. If enabled, the devices will be re-added in update process. More...
 
GenericUpdateParametersPtrPtr setReAddDevicesEnabled (daq::Bool enabled) const
 Sets the re-add devices enabled flag. More...
 
- Public Member Functions inherited from GenericPropertyObjectPtr< InterfaceType >
daq::StringPtr getClassName () const
 Gets the name of the class the Property object was constructed with. More...
 
void setPropertyValue (const daq::StringPtr &propertyName, const daq::BaseObjectPtr &value) const
 Sets the value of the Property with the given name. More...
 
daq::BaseObjectPtr getPropertyValue (const daq::StringPtr &propertyName) const
 Gets the value of the Property with the given name. More...
 
daq::BaseObjectPtr getPropertySelectionValue (const daq::StringPtr &propertyName) const
 Gets the selected value of the Property, if the Property is a Selection property. More...
 
void clearPropertyValue (const daq::StringPtr &propertyName) const
 Clears the Property value from the Property object. More...
 
daq::Bool hasProperty (const daq::StringPtr &propertyName) const
 Checks if the Property object contains a property named propertyName. More...
 
daq::PropertyPtr getProperty (const daq::StringPtr &propertyName) const
 Gets the Property with the given propertyName. More...
 
void addProperty (const daq::PropertyPtr &property) const
 Adds the property to the Property object. More...
 
void removeProperty (const daq::StringPtr &propertyName) const
 Removes the Property named propertyName from the Property object. More...
 
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr > getOnPropertyValueWrite (const daq::StringPtr &propertyName) const
 Gets the Event that is triggered whenever a Property value is written to the Property named propertyName. More...
 
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr > getOnPropertyValueRead (const daq::StringPtr &propertyName) const
 Gets the Event that is triggered whenever a Property value of a Property named propertyName is read. More...
 
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr > getOnAnyPropertyValueWrite () const
 Gets the Event that is triggered whenever any Property value is written. The event is triggered after the specific Property event. More...
 
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr > getOnAnyPropertyValueRead () const
 Gets the Event that is triggered whenever any Property value is read.The event is triggered after the specific Property event. More...
 
daq::ListPtr< daq::IProperty > getVisibleProperties () const
 Returns a list of visible properties contained in the Property object. More...
 
daq::ListPtr< daq::IProperty > getAllProperties () const
 Returns a list of all properties contained in the Property object. More...
 
void setPropertyOrder (const daq::ListPtr< daq::IString > &orderedPropertyNames) const
 Sets a custom order of properties as defined in the list of property names. More...
 
void beginUpdate () const
 Begins batch configuration of the object. More...
 
void endUpdate () const
 Ends batch configuration of the object. More...
 
daq::Bool getUpdating () const
 Returns the state of batch configuration. More...
 
daq::Event< daq::PropertyObjectPtr, daq::EndUpdateEventArgsPtr > getOnEndUpdate () const
 Gets the Event that is triggered whenever the batch configuration is applied. More...
 
daq::PermissionManagerPtr getPermissionManager () const
 Gets the permission manager of property object. More...
 

Member Function Documentation

◆ getReAddDevicesEnabled()

daq::Bool getReAddDevicesEnabled ( ) const
inline

Returns whether the re-add devices is enabled. If enabled, the devices will be re-added in update process.

Returns
The flag indicating whether the re-add devices is enabled.

The configuration is set from the property ReAddDevices of configuration object.

◆ setReAddDevicesEnabled()

GenericUpdateParametersPtrPtr setReAddDevicesEnabled ( daq::Bool  enabled) const
inline

Sets the re-add devices enabled flag.

Parameters
enabledThe flag indicating whether the re-add devices is enabled.

The configuration is set to the property ReAddDevices of configuration object.