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

Inheritance diagram for IUpdateParameters:

Collaboration diagram for IUpdateParameters:

Detailed Description

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

Public Member Functions
virtual ErrCode INTERFACE_FUNC	getDeviceUpdateOptions (IDeviceUpdateOptions **options)=0
	Gets the device update options object that allows for specifying how a device and its subdevices are to be updated. More...

virtual ErrCode INTERFACE_FUNC	setDeviceUpdateOptions (IDeviceUpdateOptions *options)=0
	Sets the device update options object that allows for specifying how a device and its subdevices are to be updated. More...

virtual ErrCode INTERFACE_FUNC	getRemoveUnusedDevices (Bool *remove)=0
	Gets the removeUnusedDevices flag. When true, connected devices not mentioned in the loading config will be removed. More...

virtual ErrCode INTERFACE_FUNC	setRemoveUnusedDevices (Bool remove)=0
	Sets the removeUnusedDevices flag. When set to true, connected devices not mentioned in the loading config will be removed. More...

Public Member Functions inherited from IPropertyObject
virtual ErrCode INTERFACE_FUNC	getClassName (IString **className)=0
	Gets the name of the class the Property object was constructed with. More...

virtual ErrCode INTERFACE_FUNC	setPropertyValue (IString propertyName, IBaseObject value)=0
	Sets the value of the Property with the given name. More...

virtual ErrCode INTERFACE_FUNC	getPropertyValue (IString propertyName, IBaseObject *value)=0
	Gets the value of the Property with the given name. More...

virtual ErrCode INTERFACE_FUNC	getPropertySelectionValue (IString propertyName, IBaseObject *value)=0
	Gets the selected value of the Property, if the Property is a Selection property. More...

virtual ErrCode INTERFACE_FUNC	clearPropertyValue (IString *propertyName)=0
	Clears the Property value from the Property object. More...

virtual ErrCode INTERFACE_FUNC	hasProperty (IString propertyName, Bool hasProperty)=0
	Checks if the Property object contains a property named `propertyName`. More...

virtual ErrCode INTERFACE_FUNC	getProperty (IString propertyName, IProperty *property)=0
	Gets the Property with the given `propertyName`. More...

virtual ErrCode INTERFACE_FUNC	addProperty (IProperty *property)=0
	Adds the property to the Property object. More...

virtual ErrCode INTERFACE_FUNC	removeProperty (IString *propertyName)=0
	Removes the Property named `propertyName` from the Property object. More...

virtual ErrCode INTERFACE_FUNC	getOnPropertyValueWrite (IString propertyName, IEvent *event)=0
	Gets the Event that is triggered whenever a Property value is written to the Property named `propertyName`. More...

virtual ErrCode INTERFACE_FUNC	getOnPropertyValueRead (IString propertyName, IEvent *event)=0
	Gets the Event that is triggered whenever a Property value of a Property named `propertyName` is read. More...

virtual ErrCode INTERFACE_FUNC	getOnAnyPropertyValueWrite (IEvent **event)=0
	Gets the Event that is triggered whenever any Property value is written. The event is triggered after the specific Property event. More...

virtual ErrCode INTERFACE_FUNC	getOnAnyPropertyValueRead (IEvent **event)=0
	Gets the Event that is triggered whenever any Property value is read.The event is triggered after the specific Property event. More...

virtual ErrCode INTERFACE_FUNC	getVisibleProperties (IList **properties)=0
	Returns a list of visible properties contained in the Property object. More...

virtual ErrCode INTERFACE_FUNC	getAllProperties (IList **properties)=0
	Returns a list of all properties contained in the Property object. More...

virtual ErrCode INTERFACE_FUNC	setPropertyOrder (IList *orderedPropertyNames)=0
	Sets a custom order of properties as defined in the list of property names. More...

virtual ErrCode INTERFACE_FUNC	beginUpdate ()=0
	Begins batch configuration of the object. More...

virtual ErrCode INTERFACE_FUNC	endUpdate ()=0
	Ends batch configuration of the object. More...

virtual ErrCode INTERFACE_FUNC	getUpdating (Bool *updating)=0
	Returns the state of batch configuration. More...

virtual ErrCode INTERFACE_FUNC	getOnEndUpdate (IEvent **event)=0
	Gets the Event that is triggered whenever the batch configuration is applied. More...

virtual ErrCode INTERFACE_FUNC	getPermissionManager (IPermissionManager **permissionManager)=0
	Gets the permission manager of property object. More...

virtual ErrCode INTERFACE_FUNC	findProperties (IList *properties, ISearchFilter propertyFilter, ISearchFilter *componentFilter=nullptr)=0
	Retrieves a list of properties from the Property object that match the given property filter. More...

virtual ErrCode INTERFACE_FUNC	setPropertySelectionValue (IString propertyName, IBaseObject value)=0
	Sets the value of a Selection property by the selection item value (e.g. string, float, or list/dict value). More...

virtual ErrCode INTERFACE_FUNC	clearPropertyValues ()=0
	Clears values of all properties contained in the Property object, including nested child properties. More...

Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...

virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...

virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...

virtual ErrCode INTERFACE_FUNC	equals (IBaseObject other, Bool equal) const =0
	Compares object to another object for equality. More...

virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...

Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...

virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...

virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

◆ getDeviceUpdateOptions()

virtual ErrCode INTERFACE_FUNC getDeviceUpdateOptions ( IDeviceUpdateOptions ** options )

pure virtual

Gets 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.

◆ getRemoveUnusedDevices()

virtual ErrCode INTERFACE_FUNC getRemoveUnusedDevices ( Bool * remove )

pure virtual

Gets the removeUnusedDevices flag. When true, connected devices not mentioned in the loading config will be removed.

Parameters

remove The current value of the removeUnusedDevices flag.

◆ setDeviceUpdateOptions()

virtual ErrCode INTERFACE_FUNC setDeviceUpdateOptions ( IDeviceUpdateOptions * options )

pure virtual

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.

◆ setRemoveUnusedDevices()

virtual ErrCode INTERFACE_FUNC setRemoveUnusedDevices ( Bool remove )

pure virtual

Sets the removeUnusedDevices flag. When set to true, connected devices not mentioned in the loading config will be removed.

Parameters

mode	The new value for the removeUnusedDevices flag.

Detailed Description

Public Member Functions

Member Function Documentation

◆ getDeviceUpdateOptions()

◆ getRemoveUnusedDevices()

◆ setDeviceUpdateOptions()

◆ setRemoveUnusedDevices()