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...

Inheritance diagram for ISearchFilter:

Collaboration diagram for 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
virtual ErrCode INTERFACE_FUNC	acceptsComponent (IComponent component, Bool accepts)=0
	Defines whether or not the component should be included in the search results. More...

virtual ErrCode INTERFACE_FUNC	visitChildren (IComponent component, Bool visit)=0
	Defines whether or not the children of said component should be traversed during a recursive search. More...

Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...

virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...

virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...

virtual ErrCode INTERFACE_FUNC	equals (IBaseObject other, Bool equal) const =0
	Compares object to another object for equality. More...

virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...

Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...

virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...

virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

◆ acceptsComponent()

virtual ErrCode INTERFACE_FUNC acceptsComponent	(	IComponent *	component,
		Bool *	accepts
	)

pure virtual

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

Parameters

	component	The component being evaluated.
[out]	accepts	True of the component is to be included in the results; false otherwise.

◆ visitChildren()

virtual ErrCode INTERFACE_FUNC visitChildren	(	IComponent *	component,
		Bool *	visit
	)