
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. This does not necessarily give the true type of the underlying object. 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... | |
![]() | |
Kit (HPS.Kit in_that) | |
override 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... | |
![]() | |
IntPtr | GetClassID () |
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... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. 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 | |
![]() | |
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
|
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.
- Parameters
-
in_kit The source SearchOptionsKit to copy.
Member Function Documentation
|
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.
|
inline |
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.
|
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.
|
inlinevirtual |
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.Kit.
|
inline |
Copies the source SearchOptionsKit into this SearchOptionsKit.
- Parameters
-
in_kit The source SearchOptionsKit to copy.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
Copies this SearchOptionsKit into the given SearchOptionsKit.
- Parameters
-
out_kit The SearchOptionsKit to populate with the contents of this SearchOptionsKit.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
Removes the behavior to use when performing a search.
- Returns
- A reference to this SearchOptionsKit.
|
inline |
Removes the entity types to look for when performing a search.
- Returns
- A reference to this SearchOptionsKit.
|
inline |
Removes all settings from this SearchOptionsKit.
- Returns
- A reference to this SearchOptionsKit.
|
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