A single-entry point for performing searches across the VMS system. The search manager will expose all available searches supplied by loaded search agent plugins. A search can be started across multiple search agents and run simultaneously by the search manager.
More...
Public Member Functions | |
| bool | CancelSearch (IEnumerable< SearchDefinition > definitions) |
| Attempt to cancel the currently running search based on there search criteria. This will only signal the search agent plugin to cancel a search and then return. After calling this, no more results from the cancel search will be returned. | |
| SearchDefinition | CreateSearchDefinition (SearchFilterCategory searchFilterCategory, SearchScope searchScope) |
| Creates a new search definition based on a search category. | |
| void | DestroySearchDefinition (SearchDefinition searchDefinition) |
| Destroys the provided search definition. | |
| void | Dispose () |
| Dispose the SearchManager, and then signal all running searches to cancel. | |
| SearchManager () | |
| Creates a new SearchManager for performing searches across the VMS system. | |
| SearchManager (IEnumerable< SearchAgentPlugin > searchAgentPlugins) | |
| Creates a new SearchManager for performing searches across the VMS system using the provided search agent plugins. | |
| void | StartSearch (SearchDefinition definition, DateTime from, DateTime to, IEnumerable< Item > items) |
| Starts a new search based on the given search criteria. Only one search can be started at a time. If a new search is started the previous search is canceled, and any subsequent result is ignored. This is equivalent to calling CancelSearch first. | |
| void | StartSearch (SearchDefinition definition, DateTime from, DateTime to, IEnumerable< Item > items, SearchSortOrder sortOrder) |
| Starts a new search based on the given search criteria. Only one search can be started at a time. If a new search is started the previous search is canceled, and any subsequent result is ignored. This is equivalent to calling CancelSearch first. | |
Protected Member Functions | |
| virtual void | Dispose (bool disposing) |
| Override to handle disposing objects in inherited classes. | |
| virtual void | FireErrorOccurred (SearchError searchError, SearchDefinition searchDefinition, Guid sessionId) |
| Fire ErrorOccurred events. | |
| virtual void | FirePartialResultReady (IEnumerable< SearchResultData > searchResults, SearchDefinition searchDefinition, Guid sessionId) |
| Fire SearchResultReady events. | |
| virtual void | FireSearchDone (SearchDefinition searchDefinition, Guid sessionId) |
| Fire SearchDone events. | |
Properties | |
| ReadOnlyCollection< SearchFilterCategory > | SearchFilterCategories [get] |
| Returns all search filter categories from all the loaded search agent plugins. | |
Events | |
| EventHandler< SearchErrorEventArgs > | ErrorOccurred |
| An event used to inform the caller about run-time error. | |
| EventHandler< SearchDoneEventArgs > | SearchDone |
| An event used to inform the caller that a started search has completed. | |
| EventHandler< SearchResultReadyEventArgs > | SearchResultReady |
| An event used to inform that a set of results is ready. | |
Detailed Description
A single-entry point for performing searches across the VMS system. The search manager will expose all available searches supplied by loaded search agent plugins. A search can be started across multiple search agents and run simultaneously by the search manager.
- A dedicated thread will run per criteria for a started search.
- Only one search per criteria can be performed at a time. (This means that a second search for a criteria will cancel the first search)
- The criteriaLimit is per criteria. Meaning that searching for 3 criteria with a limit of 50 will return a maximum of 150 results in total.
Constructor & Destructor Documentation
◆ SearchManager() [1/2]
|
inline |
Creates a new SearchManager for performing searches across the VMS system.
◆ SearchManager() [2/2]
|
inline |
Creates a new SearchManager for performing searches across the VMS system using the provided search agent plugins.
- Parameters
-
searchAgentPlugins Search agent plugins to add to the search manager.
Member Function Documentation
◆ CancelSearch()
|
inline |
Attempt to cancel the currently running search based on there search criteria. This will only signal the search agent plugin to cancel a search and then return. After calling this, no more results from the cancel search will be returned.
- Parameters
-
definitions A list of search definitions to cancel.
- Returns
- True if at least one search was signaled to cancel.
◆ CreateSearchDefinition()
|
inline |
Creates a new search definition based on a search category.
- Parameters
-
searchFilterCategory The category to base the definition on. searchScope The search scope associated with the definition.
- Returns
- A new search definition.
◆ DestroySearchDefinition()
|
inline |
Destroys the provided search definition.
- Parameters
-
searchDefinition The search definition to destroy.
◆ Dispose() [1/2]
|
inline |
Dispose the SearchManager, and then signal all running searches to cancel.
◆ Dispose() [2/2]
|
inlineprotectedvirtual |
Override to handle disposing objects in inherited classes.
- Parameters
-
disposing Indicate if the method is called from Dispose() or the finalizer.
◆ FireErrorOccurred()
|
inlineprotectedvirtual |
Fire ErrorOccurred events.
- Parameters
-
searchError The search error that occurred. searchDefinition The Search.SearchDefinition which initiated the search. sessionId A unique session id identifing the search where the exception originated from.
◆ FirePartialResultReady()
|
inlineprotectedvirtual |
Fire SearchResultReady events.
- Parameters
-
searchResults The enumerable representing a chunk of SearchResultDatas ready to be offloaded. searchDefinition The Search.SearchDefinition which initiated the search. sessionId A unique session id identifying the search where the result originated from.
◆ FireSearchDone()
|
inlineprotectedvirtual |
Fire SearchDone events.
- Parameters
-
searchDefinition The search definition that has completed. sessionId The sessionId firing the search done event.
◆ StartSearch() [1/2]
|
inline |
Starts a new search based on the given search criteria.
Only one search can be started at a time. If a new search is started the previous search is canceled, and any subsequent result is ignored. This is equivalent to calling CancelSearch first.
- Parameters
-
definition A search definition on which to start a search. from The start of the time span in which to search. to The end of the time span in which to search. items The items (i.e. cameras) to include in the search.
◆ StartSearch() [2/2]
|
inline |
Starts a new search based on the given search criteria.
Only one search can be started at a time. If a new search is started the previous search is canceled, and any subsequent result is ignored. This is equivalent to calling CancelSearch first.
- Parameters
-
definition A search definition on which to start a search. from The start of the time span in which to search. to The end of the time span in which to search. items The items (i.e. cameras) to include in the search. sortOrder The order in which the results should be delivered.
Property Documentation
◆ SearchFilterCategories
|
get |
Returns all search filter categories from all the loaded search agent plugins.
Event Documentation
◆ ErrorOccurred
| EventHandler<SearchErrorEventArgs> VideoOS.Platform.Search.SearchManager.ErrorOccurred |
An event used to inform the caller about run-time error.
◆ SearchDone
| EventHandler<SearchDoneEventArgs> VideoOS.Platform.Search.SearchManager.SearchDone |
An event used to inform the caller that a started search has completed.
◆ SearchResultReady
| EventHandler<SearchResultReadyEventArgs> VideoOS.Platform.Search.SearchManager.SearchResultReady |
An event used to inform that a set of results is ready.