#include <hps.h>
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. 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.
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::ShowLastUpdateInfo |
( |
UpdateInfo & |
out_info | ) |
|
Shows information pertaining to the last performed update.
- Parameters
-
out_info | The information pertaining to the last performed update. |
- Returns
- false if called before the initial update, true otherwise.
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.
The documentation for this class was generated from the following file: