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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.SearchOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
 SearchOptionsKit ()
 
 SearchOptionsKit (HPS.SearchOptionsKit in_kit)
 
void Set (HPS.SearchOptionsKit in_kit)
 
HPS.SearchOptionsKit SetBehavior (HPS.Search.Behavior in_behavior)
 
HPS.SearchOptionsKit SetCriteria (HPS.Search.Type in_request)
 
HPS.SearchOptionsKit SetCriteria (HPS.Search.Type[] in_requests)
 
HPS.SearchOptionsKit SetSearchSpace (HPS.Search.Space in_search_space)
 
void Show (out HPS.SearchOptionsKit out_kit)
 
bool ShowBehavior (out HPS.Search.Behavior out_behavior)
 
bool ShowCriteria (out HPS.Search.Type[] out_types)
 
bool ShowSearchSpace (out HPS.Search.Space out_search_space)
 
HPS.SearchOptionsKit UnsetBehavior ()
 
HPS.SearchOptionsKit UnsetCriteria ()
 
HPS.SearchOptionsKit UnsetEverything ()
 
HPS.SearchOptionsKit UnsetSearchSpace ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.SearchOptionsKit GetDefault ()
 
static bool operator!= (HPS.SearchOptionsKit a, HPS.SearchOptionsKit b)
 
static bool operator== (HPS.SearchOptionsKit a, HPS.SearchOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The SearchOptionsKit class is a user space object. It contains options used when performing a search.

Constructor & Destructor Documentation

◆ SearchOptionsKit() [1/2]

HPS.SearchOptionsKit.SearchOptionsKit ( )
inline

The default constructor creates an empty SearchOptionsKit object.

◆ SearchOptionsKit() [2/2]

HPS.SearchOptionsKit.SearchOptionsKit ( HPS.SearchOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source SearchOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.SearchOptionsKit.Empty ( )
inlinevirtual

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 ( HPS.SearchOptionsKit  in_kit)
inline

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

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()

override HPS.Type HPS.SearchOptionsKit.ObjectType ( )
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.

◆ Set()

void HPS.SearchOptionsKit.Set ( HPS.SearchOptionsKit  in_kit)
inline

Copies the source SearchOptionsKit into this SearchOptionsKit.

Parameters
in_kitThe source SearchOptionsKit to copy.

◆ SetBehavior()

HPS.SearchOptionsKit HPS.SearchOptionsKit.SetBehavior ( HPS.Search.Behavior  in_behavior)
inline

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/2]

HPS.SearchOptionsKit HPS.SearchOptionsKit.SetCriteria ( HPS.Search.Type  in_request)
inline

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/2]

HPS.SearchOptionsKit HPS.SearchOptionsKit.SetCriteria ( HPS.Search.Type []  in_requests)
inline

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.

◆ SetSearchSpace()

HPS.SearchOptionsKit HPS.SearchOptionsKit.SetSearchSpace ( HPS.Search.Space  in_search_space)
inline

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 ( out HPS.SearchOptionsKit  out_kit)
inline

Copies this SearchOptionsKit into the given SearchOptionsKit.

Parameters
out_kitThe SearchOptionsKit to populate with the contents of this SearchOptionsKit.

◆ ShowBehavior()

bool HPS.SearchOptionsKit.ShowBehavior ( out HPS.Search.Behavior  out_behavior)
inline

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 ( out HPS.Search.Type []  out_types)
inline

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 ( out HPS.Search.Space  out_search_space)
inline

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()

HPS.SearchOptionsKit HPS.SearchOptionsKit.UnsetBehavior ( )
inline

Removes the behavior to use when performing a search.

Returns
A reference to this SearchOptionsKit.

◆ UnsetCriteria()

HPS.SearchOptionsKit HPS.SearchOptionsKit.UnsetCriteria ( )
inline

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

Returns
A reference to this SearchOptionsKit.

◆ UnsetEverything()

HPS.SearchOptionsKit HPS.SearchOptionsKit.UnsetEverything ( )
inline

Removes all settings from this SearchOptionsKit.

Returns
A reference to this SearchOptionsKit.

◆ UnsetSearchSpace()

HPS.SearchOptionsKit HPS.SearchOptionsKit.UnsetSearchSpace ( )
inline

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:
  • internals/hps_core/source/cs/HPS.SearchOptionsKit.cs