#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::SearchOptionsKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The SearchOptionsKit class is a user space object. It contains options used when performing a search.
◆ SearchOptionsKit() [1/3]
HPS::SearchOptionsKit::SearchOptionsKit |
( |
| ) |
|
◆ SearchOptionsKit() [2/3]
◆ SearchOptionsKit() [3/3]
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
-
◆ Empty()
bool HPS::SearchOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
◆ Equals()
◆ GetDefault()
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.
◆ ObjectType()
HPS::Type HPS::SearchOptionsKit::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
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.
Reimplemented from HPS::Kit.
◆ operator!=()
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this SearchOptionsKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this SearchOptionsKit.
◆ operator=() [2/2]
◆ operator==()
◆ Set()
◆ SetBehavior()
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]
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]
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]
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()
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()
◆ 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.
◆ UnsetBehavior()
Removes the behavior to use when performing a search.
- Returns
- A reference to this SearchOptionsKit.
◆ UnsetCriteria()
Removes the entity types to look for when performing a search.
- Returns
- A reference to this SearchOptionsKit.
◆ UnsetEverything()
◆ UnsetSearchSpace()
Removes which segments to look in when performing a search.
- Returns
- A reference to this SearchOptionsKit.
The documentation for this class was generated from the following file: