#include <hps.h>

Public Member Functions | |
DebuggingControl (WindowKey &in_window) | |
DebuggingControl (DebuggingControl const &in_that) | |
DebuggingControl (DebuggingControl &&in_that) | |
HPS::Type | ObjectType () const |
DebuggingControl & | operator= (DebuggingControl &&in_that) |
DebuggingControl & | operator= (DebuggingControl const &in_that) |
DebuggingControl & | SetResourceMonitor (bool in_display) |
bool | ShowResourceMonitor (bool &out_display) const |
virtual HPS::Type | Type () const |
DebuggingControl & | UnsetEverything () |
DebuggingControl & | UnsetResourceMonitor () |
~DebuggingControl () | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
Detailed Description
The HPS::DebuggingControl class is a smart pointer that is tied to a database object. Using this control, you are able to set and show the resource monitor. This control is only accessible from a HPS::WindowKey. This table lists default values for the various segment attributes accessible from HPS::DebuggingControl.
Constructor & Destructor Documentation
|
explicit |
Initializes a control tied to the window segment in_window.
HPS::DebuggingControl::DebuggingControl | ( | DebuggingControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::DebuggingControl::DebuggingControl | ( | DebuggingControl && | in_that | ) |
The move constructor creates a DebuggingControl by transferring the underlying impl of the rvalue reference to this DebuggingControl thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a DebuggingControl to take the impl from.
HPS::DebuggingControl::~DebuggingControl | ( | ) |
Releases a reference to the database object this control is tied to.
Member Function Documentation
|
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.
DebuggingControl& HPS::DebuggingControl::operator= | ( | DebuggingControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this DebuggingControl thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a DebuggingControl to take the impl from.
- Returns
- A reference to this DebuggingControl.
DebuggingControl& HPS::DebuggingControl::operator= | ( | DebuggingControl const & | in_that | ) |
Share the underlying smart-pointer of the DebuggingControl source.
- Parameters
-
in_that The DebuggingControl source of the assignment.
- Returns
- A reference to this DebuggingControl.
DebuggingControl& HPS::DebuggingControl::SetResourceMonitor | ( | bool | in_display | ) |
Controls whether a small window will be drawn displaying a number of statistics about the last update.
- Parameters
-
in_display Whether a small window will be drawn displaying a number of statistics about the last update.
- Returns
- A reference to this object.
- See also
- Resource monitor default value.
bool HPS::DebuggingControl::ShowResourceMonitor | ( | bool & | out_display | ) | const |
Shows the resource monitor setting.
- Parameters
-
out_display Whether a small window will be drawn displaying a number of statistics about the last update.
- Returns
- true if the setting is valid, false otherwise.
|
inlinevirtual |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
DebuggingControl& HPS::DebuggingControl::UnsetEverything | ( | ) |
Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by DebuggingKit::GetDefault().
- Returns
- A reference to this object.
DebuggingControl& HPS::DebuggingControl::UnsetResourceMonitor | ( | ) |
Unsets the Resource Monitor setting for this control. If the control is attached to a WindowKey this function restores the default setting as specified by DebuggingKit::GetDefault().
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h