UpdateOptionsControl

class HPS.UpdateOptionsControl : HPS.Control

The HPS.UpdateOptionsControl class is a smart pointer that is tied to a database object. It is used to set selection related options on a HPS.WindowKey. Options include the selection algorithm, granularity, internal limit, related limit, level, proximity, and sorting.

Default values for the various fields of HPS.UpdateOptionsControl can be found here.

Public Functions

override void Dispose ()

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return:The declared type of the object in question, which may differ from the true, underlying type.

HPS.UpdateOptionsControl SetTimeLimit (double in_time_limit)

Sets the time limit of this UpdateOptionsControl.

Param in_time_limit:  The time limit for this UpdateOptionsControl update. Return:A reference to this UpdateOptionsControl.

HPS.UpdateOptionsControl SetUpdateType (HPS.Window.UpdateType in_type)

Sets the type of update of this UpdateOptionsControl.

Param in_type:The type of update that this UpdateOptionsControl will perform. Return:A reference to this UpdateOptionsControl.

bool ShowTimeLimit (out double out_time_limit)

Shows the time limit from this UpdateOptionsControl.

Return:true if the time limit is valid, false otherwise.

bool ShowUpdateType (out HPS.Window.UpdateType out_type)

Shows the type of control from this UpdateOptionsControl.

Param out_type:The type of update. Return:true if the type is valid, false otherwise.

HPS.UpdateOptionsControl UnsetEverything ()

Removes all settings from this UpdateOptionsControl. If the control is attached to a WindowKey this function restores the default settings of this control as specified by UpdateOptionsKit.GetDefault().

Return:A reference to this UpdateOptionsControl.

HPS.UpdateOptionsControl UnsetTimeLimit ()

Removes the time limit of this UpdateOptionsControl. If the control is attached to a WindowKey this function restores the default value of this setting as specified by UpdateOptionsKit.GetDefault().

Return:A reference to this UpdateOptionsControl.

HPS.UpdateOptionsControl UnsetUpdateType ()

Removes the type of control for this update Control. If the control is attached to a WindowKey this function restores the default value of this setting as specified by UpdateOptionsKit.GetDefault().

Return:A reference to this UpdateOptionsControl.

UpdateOptionsControl (HPS.UpdateOptionsControl in_that)

The copy constructor creates a UpdateOptionsControl object that shares the underlying smart-pointer of the source UpdateOptionsControl.

Param in_that:The source UpdateOptionsControl to copy.

UpdateOptionsControl (HPS.WindowKey in_window)

This constructor creates a UpdateOptionsControl object which is tied to the specified window.

Param in_window:  The window which this UpdateOptionsControl should operate on.