AFEventFrameSearch Methods
- Last UpdatedSep 18, 2024
- PI System
- AF SDK 2024
- Developer
The AFEventFrameSearch type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
  | Aggregate |
Performs all requested aggregates on the objects that match the search criteria.
(Inherited from AFSearch.) |
| AggregateAsync |
Performs all requested aggregates on the objects that match the search criteria asynchronously.
(Inherited from AFSearch.) |
| BinnedSummary<TBin> |
Generates a summary broken down by the specified bins for items matching the search criteria.
(Inherited from AFSearch.) |
| BinnedSummaryAsync<TBin> |
Generates a summary broken down by the specified bins for items matching the search criteria asynchronously.
(Inherited from AFSearch.) |
| Close |
Closes the search that is cached in the server.
(Inherited from AFSearch.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| FindEventFrames | Obsolete.
This method will return the AFEventFrame objects that match the
search tokens.
|
| FindObjectFields(String, Int32, Int32) |
This method will return the values as an IList for the specified fields for each of the objects
that match the search tokens.
(Inherited from AFSearch<T>.) |
| FindObjectFields<TObject>(Int32, Int32) |
This method will return the values for the fields defined by the user-defined type for each of the objects
that match the search tokens.
(Inherited from AFSearch<T>.) |
| FindObjectFields<TObject>(String, Func<IList<Object>, TObject>, Int32, Int32) |
This method will return the values as an object for the specified fields for each of the objects
that match the search tokens using the supplied factory delegate.
(Inherited from AFSearch.) |
| FindObjectFields<TObject>(String, Func<IList<Object>, TObject>, Int32, Int32) |
This method will return the values as an object for the specified fields for each of the objects
that match the search tokens using the supplied factory delegate.
(Inherited from AFSearch<T>.) |
| FindObjectIds |
This method will return a list of the ID for each object that matches the
search tokens.
(Inherited from AFSearch<T>.) |
| FindObjects |
This method will return the objects that match the
search tokens.
(Inherited from AFSearch<T>.) |
| FrequencyDistribution |
Generates a frequency distribution for the specified items.
(Inherited from AFSearch.) |
| FrequencyDistributionAsync |
Generates a frequency distribution for the specified items asynchronously.
(Inherited from AFSearch.) |
| GetCachedEventFrames |
Gets the active matches for this search when there is an active subscriber.
|
 | GetFilters() |
Get the full list of valid filters for a search query
for all servers.
|
| GetFilters(PISystem) |
Get the list of valid filters for a search query
for the specified server.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetObjectFields |
Get the list of valid object fields that can used for the FindObjectFields(String, Int32, Int32)
search for the specified server.
|
| GetTotalCount |
Returns the total count of the items that could be returned from the search query.
(Inherited from AFSearch<T>.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GroupedSummary |
Generates summaries broken down by group for items matching the search criteria.
(Inherited from AFSearch.) |
| GroupedSummaryAsync |
Generates summaries broken down by group for items matching the search criteria asynchronously.
(Inherited from AFSearch.) |
| Histogram<TBin> |
Generates a histogram using the specified weighting for items matching this search.
(Inherited from AFSearch.) |
| HistogramAsync<TBin> |
Generates a histogram using the specified weighting for items matching this search asynchronously.
(Inherited from AFSearch.) |
| IsMatch |
Determines if the specified item matches the search query.
(Inherited from AFSearch<T>.) |
| Refresh |
Refreshes the search that is cached in the server.
(Inherited from AFSearch.) |
| Subscribe(IObserver<AFSearchUpdateEvent<AFEventFrame>>) |
Subscribes an observer to matches for this event frame search.
|
| Subscribe(IObserver<AFSearchUpdateEvent<AFEventFrame>>, Boolean, Int32) |
Subscribes an observer to matches for this event frame search.
|
| Summary(String, AFSummaryTypes) |
Summarizes the result of this search.
(Inherited from AFSearch.) |
| Summary(String, AFSummaryTypes, String) |
Summarizes the result of this search with the specified weighting.
(Inherited from AFSearch.) |
| SummaryAsync(String, AFSummaryTypes, CancellationToken) |
Summarizes the result of this search asynchronously.
(Inherited from AFSearch.) |
| SummaryAsync(String, AFSummaryTypes, String, CancellationToken) |
Summarizes the result of this search with the specified weighting asynchronously.
(Inherited from AFSearch.) |
| ToString |
Returns a String that represents the current object.
(Inherited from AFSearch.) |
| TryFindSearchToken | Obsolete.
Find the AFSearchToken associated with the specified AFSearchFilter.
(Inherited from AFSearch.) |
| TryFindSearchTokens | Obsolete.
Find the AFSearchToken list associated with the specified AFSearchFilter.
(Inherited from AFSearch.) |