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

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. This does not necessarily give the true type of the underlying object. 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... | |
![]() | |
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... | |
Static Public Member Functions | |
static HPS.DebuggingKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.DebuggingKit a, HPS.DebuggingKit b) |
static bool | operator== (HPS.DebuggingKit a, HPS.DebuggingKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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
|
inline |
Initializes an empty kit.
|
inline |
Copies the kit in_kit into this kit.
Member Function Documentation
|
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.
|
inline |
Check if the source DebuggingKit is equivalent to this object.
- Parameters
-
in_kit The source DebuggingKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
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.
|
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.
|
inline |
Copies the source DebuggingKit into this object.
- Parameters
-
in_kit The source object to copy.
|
inline |
Controls whether a small window will be drawn displaying a number of statistics about the last update.
- Parameters
-
in_display Whether a small window will be drawn displaying a number of statistics about the last update.
- Returns
- A reference to this object.
|
inline |
Copies this object into the given DebuggingKit.
- Parameters
-
out_kit The DebuggingKit to populate with the contents of this object.
|
inline |
Shows the resource monitor setting.
- Parameters
-
out_display Whether a small window will be drawn displaying a number of statistics about the last update.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
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