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::DeviceUpdateOptionsPtr	getDeviceUpdateOptions () const
	Gets the device update options object that allows for specifying how a device and its subdevices are to be updated. More...
void	setDeviceUpdateOptions (const daq::DeviceUpdateOptionsPtr &options) const
	Sets the device update options object that allows for specifying how a device and its subdevices are to be updated. 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...
daq::ListPtr< daq::IProperty >	findProperties (const daq::SearchFilterPtr &propertyFilter, const daq::SearchFilterPtr &componentFilter=nullptr) const
	Retrieves a list of properties from the Property object that match the given property filter. More...
void	setPropertySelectionValue (const daq::StringPtr &propertyName, const daq::BaseObjectPtr &value) const
	Sets the value of a Selection property by the selection item value (e.g. string, float, or list/dict value). More...
void	clearPropertyValues () const
	Clears values of all properties contained in the Property object, including nested child properties. More...

Member Function Documentation

getDeviceUpdateOptions()

daq::DeviceUpdateOptionsPtr getDeviceUpdateOptions ( ) const

inline

Gets the device update options object that allows for specifying how a device and its subdevices are to be updated.

Returns

The device update options object.

setDeviceUpdateOptions()

void setDeviceUpdateOptions ( const daq::DeviceUpdateOptionsPtr &  options ) const

inline

Sets the device update options object that allows for specifying how a device and its subdevices are to be updated.

Parameters

options

The device update options object.