< Home

< Table of Contents

REFERENCE MANUAL

HPS.DebuggingKit Class Reference

The DebuggingKit class is a user space object, useful for carrying a group attribute settings. More...

Inheritance diagram for HPS.DebuggingKit:
HPS.Object

Public Member Functions

 DebuggingKit ()
 Initializes an empty kit. More...
 
 DebuggingKit (HPS.DebuggingKit in_kit)
 Copies the kit in_kit into this kit. More...
 
override void Dispose ()
 
override bool Empty ()
 Indicates whether this object has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.DebuggingKit in_kit)
 Check if the source DebuggingKit is equivalent to this object. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.DebuggingKit in_kit)
 Copies the source DebuggingKit into this object. More...
 
HPS.DebuggingKit SetResourceMonitor (bool in_display)
 Controls whether a small window will be drawn displaying a number of statistics about the last update. More...
 
void Show (out HPS.DebuggingKit out_kit)
 Copies this object into the given DebuggingKit. More...
 
bool ShowResourceMonitor (out bool out_display)
 Shows the resource monitor setting. More...
 
HPS.DebuggingKit UnsetEverything ()
 Removes all settings from this object. More...
 
HPS.DebuggingKit UnsetResourceMonitor ()
 Removes a resource monitor setting. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
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. More...
 

Static Public Member Functions

static HPS.DebuggingKit GetDefault ()
 Creates a DebuggingKit which contains the default settings. More...
 
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.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

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

Detailed Description

The DebuggingKit class is a user space object, useful for carrying a group attribute settings.

Calling DebuggingKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

HPS.DebuggingKit.DebuggingKit ( )

Initializes an empty kit.

HPS.DebuggingKit.DebuggingKit ( HPS.DebuggingKit  in_kit)

Copies the kit in_kit into this kit.

Member Function Documentation

override bool HPS.DebuggingKit.Empty ( )
virtual

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.

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

Check if the source DebuggingKit is equivalent to this object.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_debugging_kit" kindref="compound">DebuggingKit</ref> to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
static HPS.DebuggingKit HPS.DebuggingKit.GetDefault ( )
static

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

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.

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

Copies the source DebuggingKit into this object.

Parameters
in_kitThe source object to copy.
HPS.DebuggingKit HPS.DebuggingKit.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.
void HPS.DebuggingKit.Show ( out HPS.DebuggingKit  out_kit)

Copies this object into the given DebuggingKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_debugging_kit" kindref="compound">DebuggingKit</ref> to populate with the contents of this object.
bool HPS.DebuggingKit.ShowResourceMonitor ( out bool  out_display)

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.
HPS.DebuggingKit HPS.DebuggingKit.UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.
HPS.DebuggingKit HPS.DebuggingKit.UnsetResourceMonitor ( )

Removes a resource monitor setting.

Returns
A reference to this object.

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