UpdateOptionsKit

class HPS.UpdateOptionsKit : public HPS.Kit

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.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this UpdateOptionsKit has any values set on it.

Return

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

bool Equals (HPS.UpdateOptionsKit in_kit)

Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.

Param in_kit

The source UpdateOptionsKit to compare to this UpdateOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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.

void Set (HPS.UpdateOptionsKit in_kit)

Copies the source UpdateOptionsKit into this UpdateOptionsKit.

Param in_kit

The source UpdateOptionsKit to copy.

HPS.UpdateOptionsKit SetTimeLimit (double in_time_limit)

Sets the time limit of this UpdateOptionsKit.

Param in_time_limit

The time limit for this UpdateOptionsKit update.

Return

A reference to this UpdateOptionsKit.

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

Sets the type of update of this UpdateOptionsKit.

Param in_type

The type of update that this UpdateOptionsKit will perform.

Return

A reference to this UpdateOptionsKit.

void Show (out HPS.UpdateOptionsKit out_kit)

Copies this UpdateOptionsKit into the given UpdateOptionsKit.

Param out_kit

The UpdateOptionsKit to populate with the contents of this UpdateOptionsKit.

bool ShowTimeLimit (out double out_time_limit)

Shows the time limit from this UpdateOptionsKit.

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

Param out_type

The type of update.

Return

true if the type is valid, false otherwise.

HPS.UpdateOptionsKit UnsetEverything ()

Removes all settings from this UpdateOptionsKit.

Return

A reference to this UpdateOptionsKit.

HPS.UpdateOptionsKit UnsetTimeLimit ()

Removes the time limit of this UpdateOptionsKit.

Return

A reference to this UpdateOptionsKit.

HPS.UpdateOptionsKit UnsetUpdateType ()

Removes the type of control for this UpdateOptionsKit.

Return

A reference to this UpdateOptionsKit.

UpdateOptionsKit ()

The default constructor creates an empty UpdateOptionsKit object.

UpdateOptionsKit (HPS.UpdateOptionsKit in_kit)

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

Param in_kit

The source UpdateOptionsKit to copy.

Public Static Functions

HPS.UpdateOptionsKit GetDefault ()

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.

Return

A UpdateOptionsKit with the default settings.

bool operator!= (HPS.UpdateOptionsKit a, HPS.UpdateOptionsKit b)

bool operator== (HPS.UpdateOptionsKit a, HPS.UpdateOptionsKit b)