HPS::DebuggingControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::DebuggingControl:
HPS::Control HPS::Object

Public Member Functions

 DebuggingControl (WindowKey &in_window)
 
 DebuggingControl (DebuggingControl const &in_that)
 
 DebuggingControl (DebuggingControl &&in_that)
 
HPS::Type ObjectType () const
 
DebuggingControloperator= (DebuggingControl &&in_that)
 
DebuggingControloperator= (DebuggingControl const &in_that)
 
DebuggingControlSetResourceMonitor (bool in_display)
 
bool ShowResourceMonitor (bool &out_display) const
 
virtual HPS::Type Type () const
 
DebuggingControlUnsetEverything ()
 
DebuggingControlUnsetResourceMonitor ()
 
 ~DebuggingControl ()
 
- Public Member Functions inherited from HPS::Object
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)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::DebuggingControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

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::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

◆ DebuggingControl() [1/3]

HPS::DebuggingControl::DebuggingControl ( WindowKey in_window)
explicit

Initializes a control tied to the window segment in_window.

◆ DebuggingControl() [2/3]

HPS::DebuggingControl::DebuggingControl ( DebuggingControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ DebuggingControl() [3/3]

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_thatAn rvalue reference to a DebuggingControl to take the impl from.

◆ ~DebuggingControl()

HPS::DebuggingControl::~DebuggingControl ( )

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

Member Function Documentation

◆ ObjectType()

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.

◆ operator=() [1/2]

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_thatAn rvalue reference to a DebuggingControl to take the impl from.
Returns
A reference to this DebuggingControl.

◆ operator=() [2/2]

DebuggingControl& HPS::DebuggingControl::operator= ( DebuggingControl const &  in_that)

Share the underlying smart-pointer of the DebuggingControl source.

Parameters
in_thatThe DebuggingControl source of the assignment.
Returns
A reference to this DebuggingControl.

◆ SetResourceMonitor()

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_displayWhether 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.

◆ ShowResourceMonitor()

bool HPS::DebuggingControl::ShowResourceMonitor ( bool &  out_display) const

Shows the resource monitor setting.

Parameters
out_displayWhether a small window will be drawn displaying a number of statistics about the last update.
Returns
true if the setting is valid, false otherwise.

◆ Type()

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.

◆ UnsetEverything()

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.

◆ UnsetResourceMonitor()

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: