Click or drag to resize
OSIsoft, LLC

AFSearch Methods

The AFSearch type exposes the following members.

Methods
  NameDescription
Public methodCode exampleAggregate
Performs all requested aggregates on the objects that match the search criteria.
Public methodCode exampleAggregateAsync
Performs all requested aggregates on the objects that match the search criteria asynchronously.
Public methodCode exampleBinnedSummaryTBin
Generates a summary broken down by the specified bins for items matching the search criteria.
Public methodCode exampleBinnedSummaryAsyncTBin
Generates a summary broken down by the specified bins for items matching the search criteria asynchronously.
Public methodClose
Closes the search that is cached in the server.
Public methodStatic memberConvertAFPatternToRegexPattern
Convert an AF query pattern to a pattern that can be used with .NET Regex class.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodCode exampleFindObjectFields(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.
Public methodCode exampleFindObjectFieldsTObject(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.
Public methodCode exampleFindObjectFieldsTObject(String, FuncIListObject, 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.
Public methodCode exampleFindObjectIds
This method will return a list of the ID for each object that matches the search tokens.
Public methodCode exampleFrequencyDistribution
Generates a frequency distribution for the specified items.
Public methodCode exampleFrequencyDistributionAsync
Generates a frequency distribution for the specified items asynchronously.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetTotalCount
Returns the total count of the items that could be returned from the search query.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodCode exampleGroupedSummary
Generates summaries broken down by group for items matching the search criteria.
Public methodCode exampleGroupedSummaryAsync
Generates summaries broken down by group for items matching the search criteria asynchronously.
Public methodCode exampleHistogramTBin
Generates a histogram using the specified weighting for items matching this search.
Public methodCode exampleHistogramAsyncTBin
Generates a histogram using the specified weighting for items matching this search asynchronously.
Public methodStatic memberParseQuery Obsolete.
Parses the specified search query into search tokens which can be used to search for objects.
Public methodStatic memberParseQueryString
Parses the specified search query into search tokens which can be used to search for objects.
Public methodRefresh
Refreshes the search that is cached in the server.
Public methodCode exampleSummary(String, AFSummaryTypes)
Summarizes the result of this search.
Public methodSummary(String, AFSummaryTypes, String)
Summarizes the result of this search with the specified weighting.
Public methodCode exampleSummaryAsync(String, AFSummaryTypes, CancellationToken)
Summarizes the result of this search asynchronously.
Public methodSummaryAsync(String, AFSummaryTypes, String, CancellationToken)
Summarizes the result of this search with the specified weighting asynchronously.
Public methodToString
Returns a String that represents the current object.
(Overrides ObjectToString.)
Public methodTryFindSearchToken Obsolete.
Find the AFSearchToken associated with the specified AFSearchFilter.
Public methodTryFindSearchTokens Obsolete.
Find the AFSearchToken list associated with the specified AFSearchFilter.
Top
See Also
Enabling Operational Intelligence