REFERENCE MANUAL
The UpdateOptionsKit class is a user space object. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this UpdateOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.UpdateOptionsKit in_kit) |
Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.UpdateOptionsKit in_kit) |
Copies the source UpdateOptionsKit into this UpdateOptionsKit. More... | |
HPS.UpdateOptionsKit | SetTimeLimit (double in_time_limit) |
Sets the time limit of this UpdateOptionsKit. More... | |
HPS.UpdateOptionsKit | SetUpdateControl (HPS.Window.UpdateControl in_control) |
Sets the type of update of this UpdateOptionsKit. More... | |
void | Show (out HPS.UpdateOptionsKit out_kit) |
Copies this UpdateOptionsKit into the given UpdateOptionsKit. More... | |
bool | ShowTimeLimit (out double out_time_limit) |
Shows the time limit from this UpdateOptionsKit. More... | |
bool | ShowUpdateControl (out HPS.Window.UpdateControl out_control) |
Shows the type of control from this UpdateOptionsKit. More... | |
HPS.UpdateOptionsKit | UnsetEverything () |
Removes all settings from this UpdateOptionsKit. More... | |
HPS.UpdateOptionsKit | UnsetTimeLimit () |
Removes the time limit of this UpdateOptionsKit. More... | |
HPS.UpdateOptionsKit | UnsetUpdateControl () |
Removes the type of control for this UpdateOptionsKit. More... | |
UpdateOptionsKit () | |
The default constructor creates an empty UpdateOptionsKit object. More... | |
UpdateOptionsKit (HPS.UpdateOptionsKit in_kit) | |
The copy constructor creates a new UpdateOptionsKit object that contains the same settings as the source UpdateOptionsKit. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static HPS.UpdateOptionsKit | GetDefault () |
Creates a UpdateOptionsKit which contains the default settings. More... | |
static bool | operator!= (HPS.UpdateOptionsKit a, HPS.UpdateOptionsKit b) |
static bool | operator== (HPS.UpdateOptionsKit a, HPS.UpdateOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The UpdateOptionsKit class is a user space object.
It contains options related to selection. Calling UpdateOptionsKit::GetDefault() will return a kit with values found in this table.
HPS.UpdateOptionsKit.UpdateOptionsKit | ( | ) |
The default constructor creates an empty UpdateOptionsKit object.
HPS.UpdateOptionsKit.UpdateOptionsKit | ( | HPS.UpdateOptionsKit | in_kit | ) |
The copy constructor creates a new UpdateOptionsKit object that contains the same settings as the source UpdateOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_update_options_kit" kindref="compound">UpdateOptionsKit</ref> to copy. |
|
virtual |
Indicates whether this UpdateOptionsKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.UpdateOptionsKit.Equals | ( | HPS.UpdateOptionsKit | in_kit | ) |
Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_update_options_kit" kindref="compound">UpdateOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_update_options_kit" kindref="compound">UpdateOptionsKit</ref>. |
|
static |
Creates a UpdateOptionsKit which contains the default settings.
The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.UpdateOptionsKit.Set | ( | HPS.UpdateOptionsKit | in_kit | ) |
Copies the source UpdateOptionsKit into this UpdateOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_update_options_kit" kindref="compound">UpdateOptionsKit</ref> to copy. |
HPS.UpdateOptionsKit HPS.UpdateOptionsKit.SetTimeLimit | ( | double | in_time_limit | ) |
Sets the time limit of this UpdateOptionsKit.
in_time_limit | The time limit for this <ref refid="class_h_p_s_1_1_update_options_kit" kindref="compound">UpdateOptionsKit</ref> update. |
HPS.UpdateOptionsKit HPS.UpdateOptionsKit.SetUpdateControl | ( | HPS.Window.UpdateControl | in_control | ) |
Sets the type of update of this UpdateOptionsKit.
in_control | The type of update that this <ref refid="class_h_p_s_1_1_update_options_kit" kindref="compound">UpdateOptionsKit</ref> will perform. |
void HPS.UpdateOptionsKit.Show | ( | out HPS.UpdateOptionsKit | out_kit | ) |
Copies this UpdateOptionsKit into the given UpdateOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_update_options_kit" kindref="compound">UpdateOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_update_options_kit" kindref="compound">UpdateOptionsKit</ref>. |
bool HPS.UpdateOptionsKit.ShowTimeLimit | ( | out double | out_time_limit | ) |
Shows the time limit from this UpdateOptionsKit.
bool HPS.UpdateOptionsKit.ShowUpdateControl | ( | out HPS.Window.UpdateControl | out_control | ) |
Shows the type of control from this UpdateOptionsKit.
HPS.UpdateOptionsKit HPS.UpdateOptionsKit.UnsetEverything | ( | ) |
Removes all settings from this UpdateOptionsKit.
HPS.UpdateOptionsKit HPS.UpdateOptionsKit.UnsetTimeLimit | ( | ) |
Removes the time limit of this UpdateOptionsKit.
HPS.UpdateOptionsKit HPS.UpdateOptionsKit.UnsetUpdateControl | ( | ) |
Removes the type of control for this UpdateOptionsKit.