Public Member Functions | Static Public Member Functions | List of all members
HPS::UpdateOptionsKit Class Reference

#include <hps.h>

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

Public Member Functions

 UpdateOptionsKit ()
 
 UpdateOptionsKit (UpdateOptionsKit const &in_kit)
 
 UpdateOptionsKit (UpdateOptionsKit &&in_that)
 
UpdateOptionsKitoperator= (UpdateOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
void Set (UpdateOptionsKit const &in_kit)
 
void Show (UpdateOptionsKit &out_kit) const
 
UpdateOptionsKitoperator= (UpdateOptionsKit const &in_kit)
 
bool Empty () const
 
bool Equals (UpdateOptionsKit const &in_kit) const
 
bool operator== (UpdateOptionsKit const &in_kit) const
 
bool operator!= (UpdateOptionsKit const &in_kit) const
 
UpdateOptionsKitSetUpdateControl (HPS::Window::UpdateControl in_control)
 
UpdateOptionsKitSetTimeLimit (HPS::Time in_time_limit)
 
UpdateOptionsKitUnsetUpdateControl ()
 
UpdateOptionsKitUnsetTimeLimit ()
 
UpdateOptionsKitUnsetEverything ()
 
bool ShowUpdateControl (HPS::Window::UpdateControl &out_control) const
 
bool ShowTimeLimit (HPS::Time &out_time_limit) const
 
- Public Member Functions inherited from HPS::Object
Objectoperator= (Object const &other_object)
 
 Object (Object &&in_that)
 
Objectoperator= (Object &&in_that)
 
HPS::Type Type () const
 
virtual void Reset ()
 
bool HasType (HPS::Type in_mask) const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 

Static Public Member Functions

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

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

HPS::UpdateOptionsKit::UpdateOptionsKit ( )

The default constructor creates an empty UpdateOptionsKit object.

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

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.

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

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.

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.
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.
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.
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.
void HPS::UpdateOptionsKit::Set ( UpdateOptionsKit const &  in_kit)

Copies the source UpdateOptionsKit into this UpdateOptionsKit.

Parameters
in_kitThe source UpdateOptionsKit to copy.
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.
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 UpdateOptionsKit will perform.
Returns
A reference to this UpdateOptionsKit.
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.
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.
bool HPS::UpdateOptionsKit::ShowUpdateControl ( HPS::Window::UpdateControl out_control) const

Shows the type of control from this UpdateOptionsKit.

Parameters
out_proximityThe selection proximity.
Returns
true if the control is valid, false otherwise.
UpdateOptionsKit& HPS::UpdateOptionsKit::UnsetEverything ( )

Removes all settings from this UpdateOptionsKit.

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

Removes the time limit of this UpdateOptionsKit.

Returns
A reference to this UpdateOptionsKit.
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: