#include <hps.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (SearchOptionsKit const &in_kit) const |
HPS::Type | ObjectType () const |
bool | operator!= (SearchOptionsKit const &in_kit) const |
SearchOptionsKit & | operator= (SearchOptionsKit &&in_that) |
SearchOptionsKit & | operator= (SearchOptionsKit const &in_kit) |
bool | operator== (SearchOptionsKit const &in_kit) const |
SearchOptionsKit () | |
SearchOptionsKit (SearchOptionsKit const &in_kit) | |
SearchOptionsKit (SearchOptionsKit &&in_that) | |
void | Set (SearchOptionsKit const &in_kit) |
SearchOptionsKit & | SetBehavior (Search::Behavior in_behavior) |
SearchOptionsKit & | SetCriteria (Search::Type in_request) |
SearchOptionsKit & | SetCriteria (SearchTypeArray const &in_requests) |
SearchOptionsKit & | SetCriteria (size_t in_count, Search::Type const in_requests[]) |
SearchOptionsKit & | SetSearchSpace (Search::Space in_search_space) |
void | Show (SearchOptionsKit &out_kit) const |
bool | ShowBehavior (Search::Behavior &out_behavior) const |
bool | ShowCriteria (SearchTypeArray &out_types) const |
bool | ShowSearchSpace (Search::Space &out_search_space) const |
SearchOptionsKit & | UnsetBehavior () |
SearchOptionsKit & | UnsetCriteria () |
SearchOptionsKit & | UnsetEverything () |
SearchOptionsKit & | UnsetSearchSpace () |
![]() | |
virtual HPS::Type | Type () const |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Static Public Member Functions | |
static SearchOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::SearchOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The SearchOptionsKit class is a user space object. It contains options used when performing a search.
Constructor & Destructor Documentation
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.
- Parameters
-
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.
- Parameters
-
in_that An rvalue reference to a SearchOptionsKit to take the impl from.
Member Function Documentation
|
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.
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.
|
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.
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.
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.
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.
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.
void HPS::SearchOptionsKit::Set | ( | SearchOptionsKit const & | in_kit | ) |
Copies the source SearchOptionsKit into this SearchOptionsKit.
- Parameters
-
in_kit The source SearchOptionsKit to copy.
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.
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.
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.
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.
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.
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.
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.
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.
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.
SearchOptionsKit& HPS::SearchOptionsKit::UnsetBehavior | ( | ) |
Removes the behavior to use when performing a search.
- Returns
- A reference to this SearchOptionsKit.
SearchOptionsKit& HPS::SearchOptionsKit::UnsetCriteria | ( | ) |
Removes the entity types to look for when performing a search.
- Returns
- A reference to this SearchOptionsKit.
SearchOptionsKit& HPS::SearchOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this SearchOptionsKit.
- Returns
- A reference to this SearchOptionsKit.
SearchOptionsKit& HPS::SearchOptionsKit::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:
- include/hps.h