Inheritance diagram for HPS.UpdateOptionsKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.UpdateOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.UpdateOptionsKit in_kit)
 
HPS.UpdateOptionsKit SetTimeLimit (double in_time_limit)
 
HPS.UpdateOptionsKit SetUpdateType (HPS.Window.UpdateType in_type)
 
void Show (out HPS.UpdateOptionsKit out_kit)
 
bool ShowTimeLimit (out double out_time_limit)
 
bool ShowUpdateType (out HPS.Window.UpdateType out_type)
 
HPS.UpdateOptionsKit UnsetEverything ()
 
HPS.UpdateOptionsKit UnsetTimeLimit ()
 
HPS.UpdateOptionsKit UnsetUpdateType ()
 
 UpdateOptionsKit ()
 
 UpdateOptionsKit (HPS.UpdateOptionsKit in_kit)
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.UpdateOptionsKit GetDefault ()
 
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
 

Detailed Description

The HPS.UpdateOptionsKit class is a user space object. It contains options related to selection. Calling HPS.UpdateOptionsKit.GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ UpdateOptionsKit() [1/2]

HPS.UpdateOptionsKit.UpdateOptionsKit ( )
inline

The default constructor creates an empty UpdateOptionsKit object.

◆ UpdateOptionsKit() [2/2]

HPS.UpdateOptionsKit.UpdateOptionsKit ( HPS.UpdateOptionsKit  in_kit)
inline

The copy constructor creates a new UpdateOptionsKit object that contains the same settings as the source UpdateOptionsKit.

Parameters
in_kitThe source UpdateOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.UpdateOptionsKit.Empty ( )
inlinevirtual

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.

◆ Equals()

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

Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.

Parameters
in_kitThe source UpdateOptionsKit to compare to this UpdateOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.UpdateOptionsKit HPS.UpdateOptionsKit.GetDefault ( )
inlinestatic

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.

◆ ObjectType()

override HPS.Type HPS.UpdateOptionsKit.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.Kit.

◆ Set()

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

Copies the source UpdateOptionsKit into this UpdateOptionsKit.

Parameters
in_kitThe source UpdateOptionsKit to copy.

◆ SetTimeLimit()

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

Sets the time limit of this UpdateOptionsKit.

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

◆ SetUpdateType()

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

Sets the type of update of this UpdateOptionsKit.

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

◆ Show()

void HPS.UpdateOptionsKit.Show ( out HPS.UpdateOptionsKit  out_kit)
inline

Copies this UpdateOptionsKit into the given UpdateOptionsKit.

Parameters
out_kitThe UpdateOptionsKit to populate with the contents of this UpdateOptionsKit.

◆ ShowTimeLimit()

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

Shows the time limit from this UpdateOptionsKit.

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

◆ ShowUpdateType()

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

Shows the type of control from this UpdateOptionsKit.

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

◆ UnsetEverything()

HPS.UpdateOptionsKit HPS.UpdateOptionsKit.UnsetEverything ( )
inline

Removes all settings from this UpdateOptionsKit.

Returns
A reference to this UpdateOptionsKit.

◆ UnsetTimeLimit()

HPS.UpdateOptionsKit HPS.UpdateOptionsKit.UnsetTimeLimit ( )
inline

Removes the time limit of this UpdateOptionsKit.

Returns
A reference to this UpdateOptionsKit.

◆ UnsetUpdateType()

HPS.UpdateOptionsKit HPS.UpdateOptionsKit.UnsetUpdateType ( )
inline

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:
  • internals/hps_core/source/cs/HPS.UpdateOptionsKit.cs