Inheritance diagram for HPS.DebuggingKit:
HPS.Kit HPS.Object

Public Member Functions

 DebuggingKit ()
 
 DebuggingKit (HPS.DebuggingKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.DebuggingKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.DebuggingKit in_kit)
 
HPS.DebuggingKit SetResourceMonitor (bool in_display)
 
void Show (out HPS.DebuggingKit out_kit)
 
bool ShowResourceMonitor (out bool out_display)
 
HPS.DebuggingKit UnsetEverything ()
 
HPS.DebuggingKit UnsetResourceMonitor ()
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.DebuggingKit GetDefault ()
 
static bool operator!= (HPS.DebuggingKit a, HPS.DebuggingKit b)
 
static bool operator== (HPS.DebuggingKit a, HPS.DebuggingKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The HPS.DebuggingKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.DebuggingKit.GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ DebuggingKit() [1/2]

HPS.DebuggingKit.DebuggingKit ( )
inline

Initializes an empty kit.

◆ DebuggingKit() [2/2]

HPS.DebuggingKit.DebuggingKit ( HPS.DebuggingKit  in_kit)
inline

Copies the kit in_kit into this kit.

Member Function Documentation

◆ Empty()

override bool HPS.DebuggingKit.Empty ( )
inlinevirtual

Indicates whether this object has any values set on it.

Returns
true if no values are set on this object, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.DebuggingKit.Equals ( HPS.DebuggingKit  in_kit)
inline

Check if the source DebuggingKit is equivalent to this object.

Parameters
in_kitThe source DebuggingKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.DebuggingKit HPS.DebuggingKit.GetDefault ( )
inlinestatic

Creates a DebuggingKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns
A DebuggingKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.DebuggingKit.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.Object.

◆ Set()

void HPS.DebuggingKit.Set ( HPS.DebuggingKit  in_kit)
inline

Copies the source DebuggingKit into this object.

Parameters
in_kitThe source object to copy.

◆ SetResourceMonitor()

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

◆ Show()

void HPS.DebuggingKit.Show ( out HPS.DebuggingKit  out_kit)
inline

Copies this object into the given DebuggingKit.

Parameters
out_kitThe DebuggingKit to populate with the contents of this object.

◆ ShowResourceMonitor()

bool HPS.DebuggingKit.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.

◆ UnsetEverything()

HPS.DebuggingKit HPS.DebuggingKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetResourceMonitor()

HPS.DebuggingKit HPS.DebuggingKit.UnsetResourceMonitor ( )
inline

Removes a resource monitor setting.

Returns
A reference to this object.

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