#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::DebuggingControl |
|
static const HPS::Type | staticType = HPS::Type::Control |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
HPS::DebuggingControl::DebuggingControl |
( |
WindowKey & |
in_window | ) |
|
|
explicit |
Initializes a control tied to the window segment in_window.
Initializes a control tied to the same object as 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
-
HPS::DebuggingControl::~DebuggingControl |
( |
| ) |
|
Releases a reference to the database object this control is tied to.
HPS::Type HPS::DebuggingControl::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::Control.
The move assignment operator transfers the underlying impl of the rvalue reference to this DebuggingControl thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this DebuggingControl.
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.
virtual HPS::Type HPS::DebuggingControl::Type |
( |
| ) |
const |
|
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.
- Warning
- This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
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.
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: