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

#include <hps.h>

Inheritance diagram for HPS::DebuggingKit:

Collaboration diagram for HPS::DebuggingKit:

Public Member Functions
	DebuggingKit ()
	Initializes an empty kit. More...

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

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

DebuggingKit &	operator= (DebuggingKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this DebuggingKit thereby avoiding a copy. More...

virtual	~DebuggingKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (DebuggingKit const &in_kit)
	Copies the source DebuggingKit into this object. More...

void	Show (DebuggingKit &out_kit) const
	Copies this object into the given DebuggingKit. More...

DebuggingKit &	operator= (DebuggingKit const &in_kit)
	Copies the source DebuggingKit into this object. More...

bool	Empty () const
	Indicates whether this object has any values set on it. More...

bool	Equals (DebuggingKit const &in_kit) const
	Check if the source DebuggingKit is equivalent to this object. More...

bool	operator== (DebuggingKit const &in_kit) const
	Check if the source DebuggingKit is equivalent to this object. More...

bool	operator!= (DebuggingKit const &in_kit) const
	Check if the source DebuggingKit is not equivalent to this object. More...

DebuggingKit &	SetResourceMonitor (bool in_display)
	Controls whether a small window will be drawn displaying a number of statistics about the last update. More...

DebuggingKit &	UnsetResourceMonitor ()
	Removes a resource monitor setting. More...

DebuggingKit &	UnsetEverything ()
	Removes all settings from this object. More...

bool	ShowResourceMonitor (bool &out_display) const
	Shows the resource monitor setting. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static DebuggingKit	GetDefault ()
	Creates a DebuggingKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::DebuggingKit

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/3]

HPS::DebuggingKit::DebuggingKit ( )

Initializes an empty kit.

◆ DebuggingKit() [2/3]

HPS::DebuggingKit::DebuggingKit ( DebuggingKit const & in_kit )

Copies the kit in_kit into this kit.

◆ DebuggingKit() [3/3]

HPS::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_that An rvalue reference to a DebuggingKit to take the impl from.

◆ ~DebuggingKit()

virtual HPS::DebuggingKit::~DebuggingKit ( )

virtual

Destroy this kit.

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Empty()

bool HPS::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 HPS::Object.

◆ Equals()

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

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetDefault()

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

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

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.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::DebuggingKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator==()

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

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

void HPS::DebuggingKit::Set ( DebuggingKit const & in_kit )

Copies the source DebuggingKit into this object.

Parameters

in_kit The source object to copy.

◆ SetResourceMonitor()

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_display Whether 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 ( DebuggingKit & out_kit ) const

Copies this object into the given DebuggingKit.

Parameters

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

◆ ShowResourceMonitor()

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

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

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.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

◆ UnsetEverything()

DebuggingKit& HPS::DebuggingKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetResourceMonitor()

DebuggingKit& HPS::DebuggingKit::UnsetResourceMonitor ( )

Removes a resource monitor setting.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::DebuggingKit::staticType = HPS::Type::DebuggingKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DebuggingKit() [1/3]

◆ DebuggingKit() [2/3]

◆ DebuggingKit() [3/3]

◆ ~DebuggingKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetResourceMonitor()

◆ Show()

◆ ShowResourceMonitor()

◆ Type()

◆ UnsetEverything()

◆ UnsetResourceMonitor()

Member Data Documentation

◆ staticType