DebuggingControl

class DebuggingControl : public HPS::Control

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.

Public Functions

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.
DebuggingControl(DebuggingControl const &in_that)

Initializes a control tied to the same object as in_that.

explicit DebuggingControl(WindowKey &in_window)

Initializes a control tied to the window segment in_window.

inline virtual HPS::Type ObjectType() const

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.
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 &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 &SetResourceMonitor(bool in_display)

Controls whether a small window will be drawn displaying a number of statistics about the last update.

See also

Resource monitor default value.

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.
bool 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.
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 &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.
~DebuggingControl()

Releases a reference to the database object this control is tied to.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::DebuggingControl