Public Member Functions | List of all members
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)
 
DebuggingControloperator= (DebuggingControl &&in_that)
 
 ~DebuggingControl ()
 
HPS::Type ObjectType () const
 
DebuggingControloperator= (DebuggingControl const &in_that)
 
DebuggingControlSetResourceMonitor (bool in_display)
 
bool ShowResourceMonitor (bool &out_display) const
 
- Public Member Functions inherited from HPS::Control
 Control (Control const &in_that)=default
 
- Public Member Functions inherited from HPS::Object
 Object (Object const &that)
 
Objectoperator= (Object const &other_object)
 
 Object (Object &&in_that)
 
Objectoperator= (Object &&in_that)
 
HPS::Type Type () const
 
virtual bool Empty () const
 
virtual void Reset ()
 
bool HasType (HPS::Type in_mask) const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 

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

HPS::DebuggingControl::DebuggingControl ( WindowKey in_window)
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_thatAn 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

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.

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

The documentation for this class was generated from the following file: