HPS.UpdateOptionsControl Class Reference
Inheritance diagram for HPS.UpdateOptionsControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.UpdateOptionsControl SetTimeLimit (double in_time_limit)
 
HPS.UpdateOptionsControl SetUpdateType (HPS.Window.UpdateType in_type)
 
bool ShowTimeLimit (out double out_time_limit)
 
bool ShowUpdateType (out HPS.Window.UpdateType out_type)
 
override HPS.Type Type ()
 
HPS.UpdateOptionsControl UnsetEverything ()
 
HPS.UpdateOptionsControl UnsetTimeLimit ()
 
HPS.UpdateOptionsControl UnsetUpdateType ()
 
 UpdateOptionsControl (HPS.WindowKey in_window)
 
 UpdateOptionsControl (HPS.UpdateOptionsControl in_that)
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ UpdateOptionsControl() [1/2]

HPS.UpdateOptionsControl.UpdateOptionsControl ( HPS.WindowKey  in_window)
inline

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

Parameters
in_windowThe window which this UpdateOptionsControl should operate on.

◆ UpdateOptionsControl() [2/2]

HPS.UpdateOptionsControl.UpdateOptionsControl ( HPS.UpdateOptionsControl  in_that)
inline

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

Parameters
in_thatThe source UpdateOptionsControl to copy.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.UpdateOptionsControl.ObjectType ( )
inlinevirtual

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

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

Reimplemented from HPS.Control.

◆ SetTimeLimit()

HPS.UpdateOptionsControl HPS.UpdateOptionsControl.SetTimeLimit ( double  in_time_limit)
inline

Sets the time limit of this UpdateOptionsControl.

Parameters
in_time_limitThe time limit for this UpdateOptionsControl update.
Returns
A reference to this UpdateOptionsControl.

◆ SetUpdateType()

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

Sets the type of update of this UpdateOptionsControl.

Parameters
in_typeThe type of update that this UpdateOptionsControl will perform.
Returns
A reference to this UpdateOptionsControl.

◆ ShowTimeLimit()

bool HPS.UpdateOptionsControl.ShowTimeLimit ( out double  out_time_limit)
inline

Shows the time limit from this UpdateOptionsControl.

Returns
true if the time limit is valid, false otherwise.

◆ ShowUpdateType()

bool HPS.UpdateOptionsControl.ShowUpdateType ( out HPS.Window.UpdateType  out_type)
inline

Shows the type of control from this UpdateOptionsControl.

Parameters
out_typeThe type of update.
Returns
true if the type is valid, false otherwise.

◆ Type()

override HPS.Type HPS.UpdateOptionsControl.Type ( )
inlinevirtual

This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetEverything()

HPS.UpdateOptionsControl HPS.UpdateOptionsControl.UnsetEverything ( )
inline

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().

Returns
A reference to this UpdateOptionsControl.

◆ UnsetTimeLimit()

HPS.UpdateOptionsControl HPS.UpdateOptionsControl.UnsetTimeLimit ( )
inline

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().

Returns
A reference to this UpdateOptionsControl.

◆ UnsetUpdateType()

HPS.UpdateOptionsControl HPS.UpdateOptionsControl.UnsetUpdateType ( )
inline

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().

Returns
A reference to this UpdateOptionsControl.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.UpdateOptionsControl.cs