< Home

< Table of Contents

REFERENCE MANUAL

HPS.SearchOptionsKit Class Reference

The SearchOptionsKit class is a user space object. More...

Inheritance diagram for HPS.SearchOptionsKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this SearchOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.SearchOptionsKit in_kit)
 Check if the source SearchOptionsKit is equivalent to this SearchOptionsKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
 SearchOptionsKit ()
 The default constructor creates an empty SearchOptionsKit object. More...
 
 SearchOptionsKit (HPS.SearchOptionsKit in_kit)
 The copy constructor creates a new SearchOptionsKit object that contains the same settings as the source SearchOptionsKit. More...
 
void Set (HPS.SearchOptionsKit in_kit)
 Copies the source SearchOptionsKit into this SearchOptionsKit. More...
 
HPS.SearchOptionsKit SetBehavior (HPS.Search.Behavior in_behavior)
 Sets the behavior to use when performing a search. More...
 
HPS.SearchOptionsKit SetCriteria (HPS.Search.Type in_request)
 Sets the type of entity to look for when performing a search. More...
 
HPS.SearchOptionsKit SetCriteria (HPS.Search.Type[] in_requests)
 Sets the type of entities to look for when performing a search. More...
 
HPS.SearchOptionsKit SetSearchSpace (HPS.Search.Space in_search_space)
 Sets which segments to look in when performing a search. More...
 
void Show (out HPS.SearchOptionsKit out_kit)
 Copies this SearchOptionsKit into the given SearchOptionsKit. More...
 
bool ShowBehavior (out HPS.Search.Behavior out_behavior)
 Shows the behavior to use when performing a search. More...
 
bool ShowCriteria (out HPS.Search.Type[] out_types)
 Shows the entity types to look for when performing a search. More...
 
bool ShowSearchSpace (out HPS.Search.Space out_search_space)
 Shows which segments to look in when performing a search. More...
 
HPS.SearchOptionsKit UnsetBehavior ()
 Removes the behavior to use when performing a search. More...
 
HPS.SearchOptionsKit UnsetCriteria ()
 Removes the entity types to look for when performing a search. More...
 
HPS.SearchOptionsKit UnsetEverything ()
 Removes all settings from this SearchOptionsKit. More...
 
HPS.SearchOptionsKit UnsetSearchSpace ()
 Removes which segments to look in when performing a search. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static HPS.SearchOptionsKit GetDefault ()
 Creates a SearchOptionsKit which contains the default settings. More...
 
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
 
HandleRef scptr
 

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

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_search_options_kit" kindref="compound">SearchOptionsKit</ref> to copy.

Member Function Documentation

override bool HPS.SearchOptionsKit.Empty ( )
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 ( HPS.SearchOptionsKit  in_kit)

Check if the source SearchOptionsKit is equivalent to this SearchOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_search_options_kit" kindref="compound">SearchOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_search_options_kit" kindref="compound">SearchOptionsKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.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.
override HPS.Type HPS.SearchOptionsKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

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

Copies the source SearchOptionsKit into this SearchOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_search_options_kit" kindref="compound">SearchOptionsKit</ref> to copy.
HPS.SearchOptionsKit HPS.SearchOptionsKit.SetBehavior ( HPS.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.
HPS.SearchOptionsKit HPS.SearchOptionsKit.SetCriteria ( HPS.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.
HPS.SearchOptionsKit HPS.SearchOptionsKit.SetCriteria ( HPS.Search.Type[]  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.
HPS.SearchOptionsKit HPS.SearchOptionsKit.SetSearchSpace ( HPS.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.
void HPS.SearchOptionsKit.Show ( out HPS.SearchOptionsKit  out_kit)

Copies this SearchOptionsKit into the given SearchOptionsKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_search_options_kit" kindref="compound">SearchOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_search_options_kit" kindref="compound">SearchOptionsKit</ref>.
bool HPS.SearchOptionsKit.ShowBehavior ( out HPS.Search.Behavior  out_behavior)

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

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

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

Removes the behavior to use when performing a search.

Returns
A reference to this SearchOptionsKit.
HPS.SearchOptionsKit HPS.SearchOptionsKit.UnsetCriteria ( )

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

Returns
A reference to this SearchOptionsKit.
HPS.SearchOptionsKit HPS.SearchOptionsKit.UnsetEverything ( )

Removes all settings from this SearchOptionsKit.

Returns
A reference to this SearchOptionsKit.
HPS.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: