The SearchOptionsKit class is a user space object. More...

#include <hps.h>

Inheritance diagram for HPS::SearchOptionsKit:

Collaboration diagram for HPS::SearchOptionsKit:

Public Member Functions
	SearchOptionsKit ()
	The default constructor creates an empty SearchOptionsKit object. More...

	SearchOptionsKit (SearchOptionsKit const &in_kit)
	The copy constructor creates a new SearchOptionsKit object that contains the same settings as the source SearchOptionsKit. More...

	SearchOptionsKit (SearchOptionsKit &&in_that)
	The move constructor creates a SearchOptionsKit by transferring the underlying impl of the rvalue reference to this SearchOptionsKit thereby avoiding a copy and allocation. More...

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

virtual	~SearchOptionsKit ()

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

SearchOptionsKit &	SetCriteria (Search::Type in_request)
	Sets the type of entity to look for when performing a search. More...

SearchOptionsKit &	SetBehavior (Search::Behavior in_behavior)
	Sets the behavior to use when performing a search. More...

SearchOptionsKit &	SetCriteria (SearchTypeArray const &in_requests)
	Sets the type of entities to look for when performing a search. More...

SearchOptionsKit &	SetCriteria (size_t in_count, Search::Type const in_requests [])
	Sets the type of entities to look for when performing a search. More...

SearchOptionsKit &	SetSearchSpace (Search::Space in_search_space)
	Sets which segments to look in when performing a search. More...

SearchOptionsKit &	UnsetBehavior ()
	Removes the behavior to use when performing a search. More...

SearchOptionsKit &	UnsetCriteria ()
	Removes the entity types to look for when performing a search. More...

SearchOptionsKit &	UnsetSearchSpace ()
	Removes which segments to look in when performing a search. More...

SearchOptionsKit &	UnsetEverything ()
	Removes all settings from this SearchOptionsKit. More...

bool	ShowBehavior (Search::Behavior &out_behavior) const
	Shows the behavior to use when performing a search. More...

bool	ShowCriteria (SearchTypeArray &out_types) const
	Shows the entity types to look for when performing a search. More...

bool	ShowSearchSpace (Search::Space &out_search_space) const
	Shows which segments to look in when performing a search. 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 SearchOptionsKit	GetDefault ()
	Creates a SearchOptionsKit 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::SearchOptionsKit

Detailed Description

The SearchOptionsKit class is a user space object.

It contains options used when performing a search.

Constructor & Destructor Documentation

◆ SearchOptionsKit() [1/3]

HPS::SearchOptionsKit::SearchOptionsKit ( )

The default constructor creates an empty SearchOptionsKit object.

◆ SearchOptionsKit() [2/3]

HPS::SearchOptionsKit::SearchOptionsKit ( SearchOptionsKit const & in_kit )

The copy constructor creates a new SearchOptionsKit object that contains the same settings as the source SearchOptionsKit.

Parameters

in_kit The source SearchOptionsKit to copy.

◆ SearchOptionsKit() [3/3]

HPS::SearchOptionsKit::SearchOptionsKit ( SearchOptionsKit && in_that )

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

Parameters

in_that An rvalue reference to a SearchOptionsKit to take the impl from.

◆ ~SearchOptionsKit()

virtual HPS::SearchOptionsKit::~SearchOptionsKit ( )

virtual

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::SearchOptionsKit::Empty ( ) const

virtual

Indicates whether this SearchOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::SearchOptionsKit::Equals ( SearchOptionsKit const & in_kit ) const

Check if the source SearchOptionsKit is equivalent to this SearchOptionsKit.

Parameters

in_kit The source SearchOptionsKit to compare to this SearchOptionsKit.

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 SearchOptionsKit HPS::SearchOptionsKit::GetDefault ( )

static

Creates a SearchOptionsKit 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 SearchOptionsKit 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::SearchOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::SearchOptionsKit::operator!= ( SearchOptionsKit const & in_kit ) const

Check if the source SearchOptionsKit is not equivalent to this SearchOptionsKit.

Parameters

in_kit The source SearchOptionsKit to compare to this SearchOptionsKit.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

SearchOptionsKit& HPS::SearchOptionsKit::operator= ( SearchOptionsKit && in_that )

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

Parameters

in_that An rvalue reference to a SearchOptionsKit to take the impl from.

Returns: A reference to this SearchOptionsKit.

◆ operator=() [2/2]

SearchOptionsKit& HPS::SearchOptionsKit::operator= ( SearchOptionsKit const & in_kit )

Copies the source SearchOptionsKit into this SearchOptionsKit.

Parameters

in_kit The source SearchOptionsKit to copy.

Returns: A reference to this SearchOptionsKit.

◆ operator==()

bool HPS::SearchOptionsKit::operator== ( SearchOptionsKit const & in_kit ) const

Check if the source SearchOptionsKit is equivalent to this SearchOptionsKit.

Parameters

in_kit The source SearchOptionsKit to compare to this SearchOptionsKit.

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::SearchOptionsKit::Set ( SearchOptionsKit const & in_kit )

Copies the source SearchOptionsKit into this SearchOptionsKit.

Parameters

in_kit The source SearchOptionsKit to copy.

◆ SetBehavior()

SearchOptionsKit& HPS::SearchOptionsKit::SetBehavior ( Search::Behavior in_behavior )

Sets the behavior to use when performing a search.

Parameters

in_behavior The behavior to use when performing a search.

Returns: A reference to this SearchOptionsKit.

◆ SetCriteria() [1/3]

SearchOptionsKit& HPS::SearchOptionsKit::SetCriteria ( Search::Type in_request )

Sets the type of entity to look for when performing a search.

Parameters

in_request The type of entity to look for.

Returns: A reference to this SearchOptionsKit.

◆ SetCriteria() [2/3]

SearchOptionsKit& HPS::SearchOptionsKit::SetCriteria ( SearchTypeArray const & in_requests )

Sets the type of entities to look for when performing a search.

Parameters

in_requests Array of the entity types to look for.

Returns: A reference to this SearchOptionsKit.

◆ SetCriteria() [3/3]

SearchOptionsKit& HPS::SearchOptionsKit::SetCriteria	(	size_t	in_count,
		Search::Type const	in_requests[]
	)

Sets the type of entities to look for when performing a search.

Parameters

in_count	Size of the next array.
in_requests	Array of the entity types to look for.

Returns: A reference to this SearchOptionsKit.

◆ SetSearchSpace()

SearchOptionsKit& HPS::SearchOptionsKit::SetSearchSpace ( Search::Space in_search_space )

Sets which segments to look in when performing a search.

Parameters

in_search_space Which segments to look in when performing a search.

Returns: A reference to this SearchOptionsKit.

◆ Show()

void HPS::SearchOptionsKit::Show ( SearchOptionsKit & out_kit ) const

Copies this SearchOptionsKit into the given SearchOptionsKit.

Parameters

out_kit The SearchOptionsKit to populate with the contents of this SearchOptionsKit.

◆ ShowBehavior()

bool HPS::SearchOptionsKit::ShowBehavior ( Search::Behavior & out_behavior ) const

Shows the behavior to use when performing a search.

Parameters

out_behavior The behavior to use when performing a search.

Returns: true if a behavior was set, false otherwise.

◆ ShowCriteria()

bool HPS::SearchOptionsKit::ShowCriteria ( SearchTypeArray & out_types ) const

Shows the entity types to look for when performing a search.

Parameters

out_types Array of the entity types to look for.

Returns: true if the array is valid, false otherwise.

◆ ShowSearchSpace()

bool HPS::SearchOptionsKit::ShowSearchSpace ( Search::Space & out_search_space ) const

Shows which segments to look in when performing a search.

Parameters

out_search_space Which segments to look in when performing a search.

Returns: true if the search space 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.

◆ UnsetBehavior()

SearchOptionsKit& HPS::SearchOptionsKit::UnsetBehavior ( )

Removes the behavior to use when performing a search.

Returns: A reference to this SearchOptionsKit.

◆ UnsetCriteria()

SearchOptionsKit& HPS::SearchOptionsKit::UnsetCriteria ( )

Removes the entity types to look for when performing a search.

Returns: A reference to this SearchOptionsKit.

◆ UnsetEverything()

SearchOptionsKit& HPS::SearchOptionsKit::UnsetEverything ( )

Removes all settings from this SearchOptionsKit.

Returns: A reference to this SearchOptionsKit.

◆ UnsetSearchSpace()

SearchOptionsKit& HPS::SearchOptionsKit::UnsetSearchSpace ( )

Removes which segments to look in when performing a search.

Returns: A reference to this SearchOptionsKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::SearchOptionsKit::staticType = HPS::Type::SearchOptionsKit

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

◆ SearchOptionsKit() [1/3]

◆ SearchOptionsKit() [2/3]

◆ SearchOptionsKit() [3/3]

◆ ~SearchOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetBehavior()

◆ SetCriteria() [1/3]

◆ SetCriteria() [2/3]

◆ SetCriteria() [3/3]

◆ SetSearchSpace()

◆ Show()

◆ ShowBehavior()

◆ ShowCriteria()

◆ ShowSearchSpace()

◆ Type()

◆ UnsetBehavior()

◆ UnsetCriteria()

◆ UnsetEverything()

◆ UnsetSearchSpace()

Member Data Documentation

◆ staticType