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

#include <hps.h>

Inheritance diagram for HPS::UpdateOptionsControl:
HPS::Control HPS::Object

Public Member Functions

 UpdateOptionsControl (WindowKey const &in_window)
 
 UpdateOptionsControl (UpdateOptionsControl const &in_that)
 
 UpdateOptionsControl (UpdateOptionsControl &&in_that)
 
UpdateOptionsControloperator= (UpdateOptionsControl &&in_that)
 
HPS::Type ObjectType () const
 
UpdateOptionsControloperator= (UpdateOptionsControl const &in_that)
 
UpdateOptionsControlSetUpdateControl (HPS::Window::UpdateControl in_control)
 
UpdateOptionsControlSetTimeLimit (HPS::Time in_time_limit)
 
UpdateOptionsControlUnsetUpdateControl ()
 
UpdateOptionsControlUnsetTimeLimit ()
 
UpdateOptionsControlUnsetEverything ()
 
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 bool Empty () const
 
virtual void Reset ()
 
bool HasType (HPS::Type in_mask) const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

The HPS::UpdateOptionsControl class is a smart pointer that is tied to a database object. It is used to set selection related options on a HPS::WindowKey. Options include the selection algorithm, granularity, internal limit, related limit, level, proximity, and sorting.

Default values for the various fields of HPS::UpdateOptionsControl can be found here.

Constructor & Destructor Documentation

HPS::UpdateOptionsControl::UpdateOptionsControl ( WindowKey const &  in_window)
explicit

This constructor creates a UpdateOptionsControl object which is tied to the specified window.

Parameters
in_windowThe window which this UpdateOptionsControl should operate on.
HPS::UpdateOptionsControl::UpdateOptionsControl ( UpdateOptionsControl const &  in_that)

The copy constructor creates a UpdateOptionsControl object that shares the underlying smart-pointer of the source UpdateOptionsControl.

Parameters
in_thatThe source UpdateOptionsControl to copy.
HPS::UpdateOptionsControl::UpdateOptionsControl ( UpdateOptionsControl &&  in_that)

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

Parameters
in_thatAn rvalue reference to a UpdateOptionsControl to take the impl from.

Member Function Documentation

HPS::Type HPS::UpdateOptionsControl::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::Control.

UpdateOptionsControl& HPS::UpdateOptionsControl::operator= ( UpdateOptionsControl &&  in_that)

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

Parameters
in_thatAn rvalue reference to a UpdateOptionsControl to take the impl from.
Returns
A reference to this UpdateOptionsControl.
UpdateOptionsControl& HPS::UpdateOptionsControl::operator= ( UpdateOptionsControl const &  in_that)

Share the underlying smart-pointer of the UpdateOptionsControl source.

Parameters
in_thatThe UpdateOptionsControl source of the assignment.
Returns
A reference to this UpdateOptionsControl.
UpdateOptionsControl& HPS::UpdateOptionsControl::SetTimeLimit ( HPS::Time  in_time_limit)

Sets the time limit of this UpdateOptionsControl.

Parameters
in_time_limitThe time limit for this UpdateOptionsControl update.
Returns
A reference to this UpdateOptionsControl.
UpdateOptionsControl& HPS::UpdateOptionsControl::SetUpdateControl ( HPS::Window::UpdateControl  in_control)

Sets the type of update of this UpdateOptionsControl.

Parameters
in_controlThe type of update that this UpdateOptionsControl will perform.
Returns
A reference to this UpdateOptionsControl.
bool HPS::UpdateOptionsControl::ShowTimeLimit ( HPS::Time &  out_time_limit) const

Shows the time limit from this UpdateOptionsControl.

Parameters
out_proximityThe selection proximity.
Returns
true if the time limit is valid, false otherwise.
bool HPS::UpdateOptionsControl::ShowUpdateControl ( HPS::Window::UpdateControl out_control) const

Shows the type of control from this UpdateOptionsControl.

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

Removes all settings from this UpdateOptionsControl.

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

Removes the time limit of this UpdateOptionsControl.

Returns
A reference to this UpdateOptionsControl.
UpdateOptionsControl& HPS::UpdateOptionsControl::UnsetUpdateControl ( )

Removes the type of control for this update Control.

Returns
A reference to this UpdateOptionsControl.

The documentation for this class was generated from the following file: