#include <hps.h>

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

Public Member Functions

bool Empty () const
 
bool Equals (UpdateOptionsKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (UpdateOptionsKit const &in_kit) const
 
UpdateOptionsKitoperator= (UpdateOptionsKit &&in_that)
 
UpdateOptionsKitoperator= (UpdateOptionsKit const &in_kit)
 
bool operator== (UpdateOptionsKit const &in_kit) const
 
void Set (UpdateOptionsKit const &in_kit)
 
UpdateOptionsKitSetTimeLimit (HPS::Time in_time_limit)
 
UpdateOptionsKitSetUpdateType (HPS::Window::UpdateType in_type)
 
void Show (UpdateOptionsKit &out_kit) const
 
bool ShowTimeLimit (HPS::Time &out_time_limit) const
 
bool ShowUpdateType (HPS::Window::UpdateType &out_type) const
 
UpdateOptionsKitUnsetEverything ()
 
UpdateOptionsKitUnsetTimeLimit ()
 
UpdateOptionsKitUnsetUpdateType ()
 
 UpdateOptionsKit ()
 
 UpdateOptionsKit (UpdateOptionsKit const &in_kit)
 
 UpdateOptionsKit (UpdateOptionsKit &&in_that)
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static UpdateOptionsKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::UpdateOptionsKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

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/3]

HPS::UpdateOptionsKit::UpdateOptionsKit ( )

The default constructor creates an empty UpdateOptionsKit object.

◆ UpdateOptionsKit() [2/3]

HPS::UpdateOptionsKit::UpdateOptionsKit ( UpdateOptionsKit const &  in_kit)

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

Parameters
in_kitThe source UpdateOptionsKit to copy.

◆ UpdateOptionsKit() [3/3]

HPS::UpdateOptionsKit::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_thatAn rvalue reference to a UpdateOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::UpdateOptionsKit::Empty ( ) const
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.

◆ Equals()

bool HPS::UpdateOptionsKit::Equals ( UpdateOptionsKit const &  in_kit) const

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

◆ ObjectType()

HPS::Type HPS::UpdateOptionsKit::ObjectType ( ) const
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.

◆ operator!=()

bool HPS::UpdateOptionsKit::operator!= ( UpdateOptionsKit const &  in_kit) const

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

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

◆ operator=() [1/2]

UpdateOptionsKit& HPS::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_thatAn rvalue reference to a UpdateOptionsKit to take the impl from.
Returns
A reference to this UpdateOptionsKit.

◆ operator=() [2/2]

UpdateOptionsKit& HPS::UpdateOptionsKit::operator= ( UpdateOptionsKit const &  in_kit)

Copies the source UpdateOptionsKit into this UpdateOptionsKit.

Parameters
in_kitThe source UpdateOptionsKit to copy.
Returns
A reference to this UpdateOptionsKit.

◆ operator==()

bool HPS::UpdateOptionsKit::operator== ( UpdateOptionsKit const &  in_kit) const

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.

◆ Set()

void HPS::UpdateOptionsKit::Set ( UpdateOptionsKit const &  in_kit)

Copies the source UpdateOptionsKit into this UpdateOptionsKit.

Parameters
in_kitThe source UpdateOptionsKit to copy.

◆ SetTimeLimit()

UpdateOptionsKit& HPS::UpdateOptionsKit::SetTimeLimit ( HPS::Time  in_time_limit)

Sets the time limit of this UpdateOptionsKit.

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

◆ SetUpdateType()

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

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 ( UpdateOptionsKit out_kit) const

Copies this UpdateOptionsKit into the given UpdateOptionsKit.

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

◆ ShowTimeLimit()

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

Shows the time limit from this UpdateOptionsKit.

Parameters
out_proximityThe selection proximity.
Returns
true if the time limit is valid, false otherwise.

◆ ShowUpdateType()

bool HPS::UpdateOptionsKit::ShowUpdateType ( HPS::Window::UpdateType out_type) const

Shows the type of control from this UpdateOptionsKit.

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

◆ UnsetEverything()

UpdateOptionsKit& HPS::UpdateOptionsKit::UnsetEverything ( )

Removes all settings from this UpdateOptionsKit.

Returns
A reference to this UpdateOptionsKit.

◆ UnsetTimeLimit()

UpdateOptionsKit& HPS::UpdateOptionsKit::UnsetTimeLimit ( )

Removes the time limit of this UpdateOptionsKit.

Returns
A reference to this UpdateOptionsKit.

◆ UnsetUpdateType()

UpdateOptionsKit& HPS::UpdateOptionsKit::UnsetUpdateType ( )

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: