#include <hps.h>
Static Public Member Functions | |
static SearchOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The SearchOptionsKit class is a user space object. It contains options used when performing a search.
HPS::SearchOptionsKit::SearchOptionsKit | ( | ) |
The default constructor creates an empty SearchOptionsKit object.
HPS::SearchOptionsKit::SearchOptionsKit | ( | SearchOptionsKit const & | in_kit | ) |
The copy constructor creates a new SearchOptionsKit object that contains the same settings as the source SearchOptionsKit.
in_kit | The source SearchOptionsKit to copy. |
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.
in_that | An rvalue reference to a SearchOptionsKit to take the impl from. |
|
virtual |
Indicates whether this SearchOptionsKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::SearchOptionsKit::Equals | ( | SearchOptionsKit const & | in_kit | ) | const |
Check if the source SearchOptionsKit is equivalent to this SearchOptionsKit.
in_kit | The source SearchOptionsKit to compare to this SearchOptionsKit. |
|
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
bool HPS::SearchOptionsKit::operator!= | ( | SearchOptionsKit const & | in_kit | ) | const |
Check if the source SearchOptionsKit is not equivalent to this SearchOptionsKit.
in_kit | The source SearchOptionsKit to compare to this SearchOptionsKit. |
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.
in_that | An rvalue reference to a SearchOptionsKit to take the impl from. |
SearchOptionsKit& HPS::SearchOptionsKit::operator= | ( | SearchOptionsKit const & | in_kit | ) |
Copies the source SearchOptionsKit into this SearchOptionsKit.
in_kit | The source SearchOptionsKit to copy. |
bool HPS::SearchOptionsKit::operator== | ( | SearchOptionsKit const & | in_kit | ) | const |
Check if the source SearchOptionsKit is equivalent to this SearchOptionsKit.
in_kit | The source SearchOptionsKit to compare to this SearchOptionsKit. |
void HPS::SearchOptionsKit::Set | ( | SearchOptionsKit const & | in_kit | ) |
Copies the source SearchOptionsKit into this SearchOptionsKit.
in_kit | The source SearchOptionsKit to copy. |
SearchOptionsKit& HPS::SearchOptionsKit::SetBehavior | ( | Search::Behavior | in_behavior | ) |
Sets the behavior to use when performing a search.
in_behavior | The behavior to use when performing a search. |
SearchOptionsKit& HPS::SearchOptionsKit::SetCriteria | ( | Search::Type | in_request | ) |
Sets the type of entity to look for when performing a search.
in_request | The type of entity to look for. |
SearchOptionsKit& HPS::SearchOptionsKit::SetCriteria | ( | SearchTypeArray const & | in_requests | ) |
Sets the type of entities to look for when performing a search.
in_requests | Array of the entity types to look for. |
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.
in_count | Size of the next array. |
in_requests | Array of the entity types to look for. |
SearchOptionsKit& HPS::SearchOptionsKit::SetSearchSpace | ( | Search::Space | in_search_space | ) |
Sets which segments to look in when performing a search.
in_search_space | Which segments to look in when performing a search. |
void HPS::SearchOptionsKit::Show | ( | SearchOptionsKit & | out_kit | ) | const |
Copies this SearchOptionsKit into the given SearchOptionsKit.
out_kit | The SearchOptionsKit to populate with the contents of this SearchOptionsKit. |
bool HPS::SearchOptionsKit::ShowBehavior | ( | Search::Behavior & | out_behavior | ) | const |
Shows the behavior to use when performing a search.
out_behavior | The behavior to use when performing a search. |
bool HPS::SearchOptionsKit::ShowCriteria | ( | SearchTypeArray & | out_types | ) | const |
Shows the entity types to look for when performing a search.
out_types | Array of the entity types to look for. |
bool HPS::SearchOptionsKit::ShowSearchSpace | ( | Search::Space & | out_search_space | ) | const |
Shows which segments to look in when performing a search.
out_search_space | Which segments to look in when performing a search. |
SearchOptionsKit& HPS::SearchOptionsKit::UnsetBehavior | ( | ) |
Removes the behavior to use when performing a search.
SearchOptionsKit& HPS::SearchOptionsKit::UnsetCriteria | ( | ) |
Removes the entity types to look for when performing a search.
SearchOptionsKit& HPS::SearchOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this SearchOptionsKit.
SearchOptionsKit& HPS::SearchOptionsKit::UnsetSearchSpace | ( | ) |
Removes which segments to look in when performing a search.