The SearchOptionsKit class is a user space object. It contains options used when performing a search. More...
Public Member Functions | |
override void | Dispose () |
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... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.SearchOptionsKit in_kit) |
Copies the source SearchOptionsKit into this SearchOptionsKit. More... | |
void | Show (out HPS.SearchOptionsKit out_kit) |
Copies this SearchOptionsKit into the given SearchOptionsKit. More... | |
override bool | Empty () |
Indicates whether this SearchOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.SearchOptionsKit in_kit) |
Check if the source SearchOptionsKit is equivalent to this SearchOptionsKit. 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 | SetBehavior (HPS.Search.Behavior in_behavior) |
Sets the behavior to use 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... | |
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 | UnsetSearchSpace () |
Removes which segments to look in when performing a search. More... | |
HPS.SearchOptionsKit | UnsetEverything () |
Removes all settings from this 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... | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object that) | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Static Public Member Functions | |
static HPS.SearchOptionsKit | 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. More... | |
static bool | operator== (HPS.SearchOptionsKit a, HPS.SearchOptionsKit b) |
static bool | operator!= (HPS.SearchOptionsKit a, HPS.SearchOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The SearchOptionsKit class is a user space object. It contains options used when performing a search.
|
inline |
The default constructor creates an empty SearchOptionsKit object.
|
inline |
The copy constructor creates a new SearchOptionsKit object that contains the same settings as the source SearchOptionsKit.
in_kit | The source SearchOptionsKit to copy. |
|
inlinevirtual |
Indicates whether this SearchOptionsKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source SearchOptionsKit is equivalent to this SearchOptionsKit.
in_kit | The source SearchOptionsKit to compare to this SearchOptionsKit. |
|
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
Copies the source SearchOptionsKit into this SearchOptionsKit.
in_kit | The source SearchOptionsKit to copy. |
|
inline |
Sets the behavior to use when performing a search.
in_behavior | The behavior to use when performing a search. |
|
inline |
Sets the type of entity to look for when performing a search.
in_request | The type of entity to look for. |
|
inline |
Sets the type of entities to look for when performing a search.
in_requests | Array of the entity types to look for. |
|
inline |
Sets which segments to look in when performing a search.
in_search_space | Which segments to look in when performing a search. |
|
inline |
Copies this SearchOptionsKit into the given SearchOptionsKit.
out_kit | The SearchOptionsKit to populate with the contents of this SearchOptionsKit. |
|
inline |
Shows the behavior to use when performing a search.
out_behavior | The behavior to use when performing a search. |
|
inline |
Shows the entity types to look for when performing a search.
out_types | Array of the entity types to look for. |
|
inline |
Shows which segments to look in when performing a search.
out_search_space | Which segments to look in when performing a search. |
|
inline |
Removes the behavior to use when performing a search.
|
inline |
Removes the entity types to look for when performing a search.
|
inline |
Removes all settings from this SearchOptionsKit.
|
inline |
Removes which segments to look in when performing a search.