#include <hps.h>

Inheritance diagram for HPS::SearchOptionsKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (SearchOptionsKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (SearchOptionsKit const &in_kit) const
 
SearchOptionsKitoperator= (SearchOptionsKit &&in_that)
 
SearchOptionsKitoperator= (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)
 
SearchOptionsKitSetBehavior (Search::Behavior in_behavior)
 
SearchOptionsKitSetCriteria (Search::Type in_request)
 
SearchOptionsKitSetCriteria (SearchTypeArray const &in_requests)
 
SearchOptionsKitSetCriteria (size_t in_count, Search::Type const in_requests [])
 
SearchOptionsKitSetSearchSpace (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
 
SearchOptionsKitUnsetBehavior ()
 
SearchOptionsKitUnsetCriteria ()
 
SearchOptionsKitUnsetEverything ()
 
SearchOptionsKitUnsetSearchSpace ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static SearchOptionsKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::SearchOptionsKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

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_kitThe 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_thatAn rvalue reference to a SearchOptionsKit to take the impl from.

Member Function Documentation

◆ 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_kitThe source SearchOptionsKit to compare to this SearchOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

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

◆ 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!=()

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

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

Parameters
in_kitThe 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_thatAn 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_kitThe 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_kitThe source SearchOptionsKit to compare to this SearchOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

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

Copies the source SearchOptionsKit into this SearchOptionsKit.

Parameters
in_kitThe source SearchOptionsKit to copy.

◆ SetBehavior()

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

Sets the behavior to use when performing a search.

Parameters
in_behaviorThe 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_requestThe 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_requestsArray 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_countSize of the next array.
in_requestsArray 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_spaceWhich 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_kitThe 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_behaviorThe 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_typesArray 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_spaceWhich segments to look in when performing a search.
Returns
true if the search space is valid, false otherwise.

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

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