DebuggingKit

class HPS::DebuggingKit : public HPS::Kit 

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.

Public Functions

DebuggingKit(): Initializes an empty kit.

DebuggingKit(DebuggingKit &&in_that)

The move constructor creates a DebuggingKit by transferring the underlying impl of the rvalue reference to this DebuggingKit thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to a DebuggingKit to take the impl from.

DebuggingKit(DebuggingKit const &in_kit): Copies the kit in_kit into this kit.

virtual bool Empty() const

Indicates whether this object has any values set on it.

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

bool Equals(DebuggingKit const &in_kit) const

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.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(DebuggingKit const &in_kit) const

Check if the source DebuggingKit is not equivalent to this object.

Parameters: in_kit – The source DebuggingKit to compare to this object.
Returns: true if the objects are not equivalent, false otherwise.

DebuggingKit &operator=(DebuggingKit &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this DebuggingKit thereby avoiding a copy.

Parameters: in_that – An rvalue reference to a DebuggingKit to take the impl from.
Returns: A reference to this DebuggingKit.

DebuggingKit &operator=(DebuggingKit const &in_kit)

Copies the source DebuggingKit into this object.

Parameters: in_kit – The source DebuggingKit to copy.
Returns: A reference to this object.

bool operator==(DebuggingKit const &in_kit) const

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.

void Set(DebuggingKit const &in_kit)

Copies the source DebuggingKit into this object.

Parameters: in_kit – The source object to copy.

DebuggingKit &SetResourceMonitor(bool in_display)

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.

void Show(DebuggingKit &out_kit) const

Copies this object into the given DebuggingKit.

Parameters: out_kit – The DebuggingKit to populate with the contents of this object.

bool ShowResourceMonitor(bool &out_display) const

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.

DebuggingKit &UnsetEverything()

Removes all settings from this object.

Returns: A reference to this object.

DebuggingKit &UnsetResourceMonitor()

Removes a resource monitor setting.

Returns: A reference to this object.

virtual ~DebuggingKit(): Destroy this kit.

Public Static Functions

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

Returns: A DebuggingKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::DebuggingKit