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

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

Public Member Functions

 DebuggingControl (HPS.WindowKey in_window)
 Initializes a control tied to the window segment in_window. More...
 
 DebuggingControl (HPS.DebuggingControl in_that)
 Initializes a control tied to the same object as in_that. More...
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
HPS.DebuggingControl SetResourceMonitor (bool in_display)
 Controls whether a small window will be drawn displaying a number of statistics about the last update. More...
 
bool ShowResourceMonitor (out bool out_display)
 Shows the resource monitor setting. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 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. More...
 

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

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

Initializes a control tied to the window segment in_window.

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

Initializes a control tied to the same object as in_that.

Member Function Documentation

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

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.

Resource monitor default value.

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.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.DebuggingControl.cs