< Home

< Table of Contents

REFERENCE MANUAL

HPS.UpdateOptionsKit Class Reference

The UpdateOptionsKit class is a user space object. More...

Inheritance diagram for HPS.UpdateOptionsKit:
HPS.Object

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...
 
- Public Member Functions inherited from HPS.Object
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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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.

Constructor & Destructor Documentation

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.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_update_options_kit" kindref="compound">UpdateOptionsKit</ref> to copy.

Member Function Documentation

override bool HPS.UpdateOptionsKit.Empty ( )
virtual

Indicates whether this UpdateOptionsKit has any values set on it.

Returns
true if no values are set on this UpdateOptionsKit, false otherwise.

Reimplemented from HPS.Object.

bool HPS.UpdateOptionsKit.Equals ( HPS.UpdateOptionsKit  in_kit)

Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.

Parameters
in_kitThe 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>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.UpdateOptionsKit HPS.UpdateOptionsKit.GetDefault ( )
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.

Returns
A UpdateOptionsKit with the default settings.
override HPS.Type HPS.UpdateOptionsKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

void HPS.UpdateOptionsKit.Set ( HPS.UpdateOptionsKit  in_kit)

Copies the source UpdateOptionsKit into this UpdateOptionsKit.

Parameters
in_kitThe 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.

Parameters
in_time_limitThe time limit for this <ref refid="class_h_p_s_1_1_update_options_kit" kindref="compound">UpdateOptionsKit</ref> update.
Returns
A reference to this UpdateOptionsKit.
HPS.UpdateOptionsKit HPS.UpdateOptionsKit.SetUpdateControl ( HPS.Window.UpdateControl  in_control)

Sets the type of update of this UpdateOptionsKit.

Parameters
in_controlThe type of update that this <ref refid="class_h_p_s_1_1_update_options_kit" kindref="compound">UpdateOptionsKit</ref> will perform.
Returns
A reference to this UpdateOptionsKit.
void HPS.UpdateOptionsKit.Show ( out HPS.UpdateOptionsKit  out_kit)

Copies this UpdateOptionsKit into the given UpdateOptionsKit.

Parameters
out_kitThe <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.

Returns
true if the time limit is valid, false otherwise.
bool HPS.UpdateOptionsKit.ShowUpdateControl ( out HPS.Window.UpdateControl  out_control)

Shows the type of control from this UpdateOptionsKit.

Returns
true if the control is valid, false otherwise.
HPS.UpdateOptionsKit HPS.UpdateOptionsKit.UnsetEverything ( )

Removes all settings from this UpdateOptionsKit.

Returns
A reference to this UpdateOptionsKit.
HPS.UpdateOptionsKit HPS.UpdateOptionsKit.UnsetTimeLimit ( )

Removes the time limit of this UpdateOptionsKit.

Returns
A reference to this UpdateOptionsKit.
HPS.UpdateOptionsKit HPS.UpdateOptionsKit.UnsetUpdateControl ( )

Removes the type of control for this UpdateOptionsKit.

Returns
A reference to this UpdateOptionsKit.

The documentation for this class was generated from the following file: