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

Public Member Functions

 DebuggingControl (HPS.WindowKey in_window)
 
 DebuggingControl (HPS.DebuggingControl in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.DebuggingControl SetResourceMonitor (bool in_display)
 
bool ShowResourceMonitor (out bool out_display)
 
override HPS.Type Type ()
 
HPS.DebuggingControl UnsetEverything ()
 
HPS.DebuggingControl UnsetResourceMonitor ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/2]

HPS.DebuggingControl.DebuggingControl ( HPS.WindowKey  in_window)
inline

Initializes a control tied to the window segment in_window.

◆ DebuggingControl() [2/2]

HPS.DebuggingControl.DebuggingControl ( HPS.DebuggingControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.DebuggingControl.ObjectType ( )
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.

◆ SetResourceMonitor()

HPS.DebuggingControl HPS.DebuggingControl.SetResourceMonitor ( bool  in_display)
inline

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 ( out bool  out_display)
inline

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()

override HPS.Type HPS.DebuggingControl.Type ( )
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()

HPS.DebuggingControl HPS.DebuggingControl.UnsetEverything ( )
inline

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()

HPS.DebuggingControl HPS.DebuggingControl.UnsetResourceMonitor ( )
inline

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:
  • internals/hps_core/source/cs/HPS.DebuggingControl.cs