openDAQ
Open data acquisition platform
SearchFilterPtr Class Reference

Search filter that can be passed as an optional parameter to openDAQ tree traversal functions to filter out unwanted results. Allows for recursive searches. More...

Inherits ObjectPtr< ISearchFilter >.

Detailed Description

Search filter that can be passed as an optional parameter to openDAQ tree traversal functions to filter out unwanted results. Allows for recursive searches.

Each filter defines an "accepts component" and "visit children" function.

Accepts component defines whether or not the component being evaluated as part of a search method should be included in the resulting output.

Visit children defines whether or not the children of said component should be traversed during a recursive search.

Public Member Functions

daq::Bool acceptsComponent (const daq::ComponentPtr &component) const
 Defines whether or not the component should be included in the search results. More...
 
daq::Bool visitChildren (const daq::ComponentPtr &component) const
 Defines whether or not the children of said component should be traversed during a recursive search. More...
 

Member Function Documentation

◆ acceptsComponent()

daq::Bool acceptsComponent ( const daq::ComponentPtr &  component) const
inline

Defines whether or not the component should be included in the search results.

Parameters
componentThe component being evaluated.
Returns
True of the component is to be included in the results; false otherwise.

◆ visitChildren()

daq::Bool visitChildren ( const daq::ComponentPtr &  component) const
inline

Defines whether or not the children of said component should be traversed during a recursive search.

Parameters
componentThe component being evaluated.
Returns
True of the component's children should be traversed; false otherwise.