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

virtual bool Empty() const

Indicates whether this UpdateOptionsKit has any values set on it.

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

bool Equals(UpdateOptionsKit const &in_kit) const

Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.

Parameters: in_kit – The source UpdateOptionsKit to compare to this UpdateOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(UpdateOptionsKit const &in_kit) const

Check if the source UpdateOptionsKit is not equivalent to this UpdateOptionsKit.

Parameters: in_kit – The source UpdateOptionsKit to compare to this UpdateOptionsKit.
Returns: true if the objects are not equivalent, false otherwise.

UpdateOptionsKit &operator=(UpdateOptionsKit &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this UpdateOptionsKit thereby avoiding a copy.

Parameters: in_that – An rvalue reference to a UpdateOptionsKit to take the impl from.
Returns: A reference to this UpdateOptionsKit.

UpdateOptionsKit &operator=(UpdateOptionsKit const &in_kit)

Copies the source UpdateOptionsKit into this UpdateOptionsKit.

Parameters: in_kit – The source UpdateOptionsKit to copy.
Returns: A reference to this UpdateOptionsKit.

bool operator==(UpdateOptionsKit const &in_kit) const

Check if the source UpdateOptionsKit is equivalent to this UpdateOptionsKit.

Parameters: in_kit – The source UpdateOptionsKit to compare to this UpdateOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(UpdateOptionsKit const &in_kit)

Copies the source UpdateOptionsKit into this UpdateOptionsKit.

Parameters: in_kit – The source UpdateOptionsKit to copy.

UpdateOptionsKit &SetTimeLimit(HPS::Time in_time_limit)

Sets the time limit of this UpdateOptionsKit.

Parameters: in_time_limit – The time limit for this UpdateOptionsKit update.
Returns: A reference to this UpdateOptionsKit.

UpdateOptionsKit &SetUpdateType(HPS::Window::UpdateType in_type)

Sets the type of update of this UpdateOptionsKit.

Parameters: in_type – The type of update that this UpdateOptionsKit will perform.
Returns: A reference to this UpdateOptionsKit.

void Show(UpdateOptionsKit &out_kit) const

Copies this UpdateOptionsKit into the given UpdateOptionsKit.

Parameters: out_kit – The UpdateOptionsKit to populate with the contents of this UpdateOptionsKit.

bool ShowTimeLimit(HPS::Time &out_time_limit) const

Shows the time limit from this UpdateOptionsKit.

Parameters: out_proximity – The selection proximity.
Returns: true if the time limit is valid, false otherwise.

bool ShowUpdateType(HPS::Window::UpdateType &out_type) const

Shows the type of control from this UpdateOptionsKit.

Parameters: out_type – The type of update.
Returns: true if the type is valid, false otherwise.

UpdateOptionsKit &UnsetEverything()

Removes all settings from this UpdateOptionsKit.

Returns: A reference to this UpdateOptionsKit.

UpdateOptionsKit &UnsetTimeLimit()

Removes the time limit of this UpdateOptionsKit.

Returns: A reference to this UpdateOptionsKit.

UpdateOptionsKit &UnsetUpdateType()

Removes the type of control for this UpdateOptionsKit.

Returns: A reference to this UpdateOptionsKit.

UpdateOptionsKit(): The default constructor creates an empty UpdateOptionsKit object.

UpdateOptionsKit(UpdateOptionsKit &&in_that)

The move constructor creates a UpdateOptionsKit by transferring the underlying impl of the rvalue reference to this UpdateOptionsKit thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to a UpdateOptionsKit to take the impl from.

UpdateOptionsKit(UpdateOptionsKit const &in_kit)

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

Parameters: in_kit – The source UpdateOptionsKit to copy.

virtual ~UpdateOptionsKit()

Public Static Functions

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

Returns: A UpdateOptionsKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::UpdateOptionsKit