< Home

< Table of Contents

REFERENCE MANUAL

DebuggingKit Class Reference

#include <hps.h>

Inheritance diagram for DebuggingKit:
Object

Public Member Functions

 DebuggingKit ()
 
 DebuggingKit (DebuggingKit const &in_kit)
 
 DebuggingKit (DebuggingKit &&in_that)
 
bool Empty () const
 
bool Equals (DebuggingKit const &in_kit) const
 
Type ObjectType () const
 
bool operator!= (DebuggingKit const &in_kit) const
 
DebuggingKitoperator= (DebuggingKit &&in_that)
 
DebuggingKitoperator= (DebuggingKit const &in_kit)
 
bool operator== (DebuggingKit const &in_kit) const
 
void Set (DebuggingKit const &in_kit)
 
DebuggingKitSetResourceMonitor (bool in_display)
 
void Show (DebuggingKit &out_kit) const
 
bool ShowResourceMonitor (bool &out_display) const
 
DebuggingKitUnsetEverything ()
 
DebuggingKitUnsetResourceMonitor ()
 
virtual ~DebuggingKit ()
 
- Public Member Functions inherited from Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Static Public Member Functions

static DebuggingKit GetDefault ()
 
- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 

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

DebuggingKit::DebuggingKit ( )

Initializes an empty kit.

DebuggingKit::DebuggingKit ( DebuggingKit const &  in_kit)

Copies the kit in_kit into this kit.

DebuggingKit::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_thatAn rvalue reference to a DebuggingKit to take the impl from.
virtual DebuggingKit::~DebuggingKit ( )
virtual

Destroy this kit.

Member Function Documentation

bool DebuggingKit::Empty ( ) const
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 Object.

bool DebuggingKit::Equals ( DebuggingKit const &  in_kit) const

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.
static DebuggingKit 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.
Type DebuggingKit::ObjectType ( ) const
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 Object.

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

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

Parameters
in_kitThe source DebuggingKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.
DebuggingKit& 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_thatAn rvalue reference to a DebuggingKit to take the impl from.
Returns
A reference to this DebuggingKit.
DebuggingKit& DebuggingKit::operator= ( DebuggingKit const &  in_kit)

Copies the source DebuggingKit into this object.

Parameters
in_kitThe source DebuggingKit to copy.
Returns
A reference to this object.
bool DebuggingKit::operator== ( DebuggingKit const &  in_kit) const

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.
void DebuggingKit::Set ( DebuggingKit const &  in_kit)

Copies the source DebuggingKit into this object.

Parameters
in_kitThe source object to copy.
DebuggingKit& 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 DebuggingKit::Show ( DebuggingKit out_kit) const

Copies this object into the given DebuggingKit.

Parameters
out_kitThe DebuggingKit to populate with the contents of this object.
bool DebuggingKit::ShowResourceMonitor ( bool &  out_display) const

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

Removes all settings from this object.

Returns
A reference to this object.
DebuggingKit& DebuggingKit::UnsetResourceMonitor ( )

Removes a resource monitor setting.

Returns
A reference to this object.

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