Collaboration diagram for Factories:

Detailed Description

Functions
	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, VisibleSearchFilter, ISearchFilter) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a search filter that accepts only visible components. "Visit children" returns `true` only if the component being evaluated is visible. More...

IList requiredTags	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, ExcludedTagsSearchFilter, ISearchFilter, IList *, excludedTags) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a search filter that accepts components that do not have any of the excluded tags. "Visit children" always returns `true`. More...

IList requiredTags const IntfID intfId	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, LocalIdSearchFilter, ISearchFilter, IString *, localId) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a search filter that accepts components with the specified local ID. "Visit children" always returns `true`. More...

IList requiredTags const IntfID intfId ISearchFilter	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, AndSearchFilter, ISearchFilter, ISearchFilter , left, ISearchFilter , right) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a "conjunction" search filter that combines 2 filters, accepting a component only if both filters accept it. "Visit children" returns `true` only if both filters do so. More...

IList requiredTags const IntfID intfId ISearchFilter ISearchFilter ISearchFilter right	OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE (LIBRARY_FACTORY, NotSearchFilter, ISearchFilter, ISearchFilter *, filter) OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE(LIBRARY_FACTORY
	Creates a search filter that negates the "accepts component" result of the filter provided as construction argument. Does not negate the "visit children" result. More...

SearchFilterPtr	Visible ()
	Creates a search filter that accepts only visible components. "Visit children" returns `true` only if the component being evaluated is visible.

SearchFilterPtr	RequireTags (const ListPtr< IString > &requiredTags)
	Creates a search filter that accepts components that have all the required tags. "Visit children" always returns `true`. More...

SearchFilterPtr	ExcludeTags (const ListPtr< IString > &excludedTags)
	Creates a search filter that accepts components that do not have any of the excluded tags. "Visit children" always returns `true`. More...

SearchFilterPtr	InterfaceId (const IntfID &intfId)
	Creates a search filter that accepts components that implement the interface with the given interface ID. "Visit children" always returns `true`. More...

SearchFilterPtr	LocalId (const StringPtr &localId)
	Creates a search filter that accepts components with the specified local ID. "Visit children" always returns `true`. More...

SearchFilterPtr	Any ()
	Creates a search filter that accepts all components. "Visit children" always returns `true`.

SearchFilterPtr	And (const SearchFilterPtr &left, const SearchFilterPtr &right)
	Creates a "conjunction" search filter that combines 2 filters, accepting a component only if both filters accept it. "Visit children" returns `true` only if both filters do so. More...

SearchFilterPtr	Or (const SearchFilterPtr &left, const SearchFilterPtr &right)
	Creates a "disjunction" search filter that combines 2 filters, accepting a component if any of the two filters accepts it. "Visit children" returns `true` if any of the two filters accepts does so. More...

SearchFilterPtr	Not (const SearchFilterPtr &filter)
	Creates a search filter that negates the "accepts component" result of the filter provided as construction argument. Does not negate the "visit children" result. More...

SearchFilterPtr	Custom (const FunctionPtr &acceptsFunction, const FunctionPtr &visitFunction=nullptr)
	Creates a custom search filter with a user-defined "accepts" and "visit children" function. More...

SearchFilterPtr	Recursive (const SearchFilterPtr &filter)
	Creates a search filter that indicates that the tree traversal method should recursively search the tree. This filter constructor should always be the final filter wrapper, and should not be used as a constructor argument for another filter. More...

Function Documentation

◆ And()

SearchFilterPtr And	(	const SearchFilterPtr &	left,
		const SearchFilterPtr &	right
	)

inline

Creates a "conjunction" search filter that combines 2 filters, accepting a component only if both filters accept it. "Visit children" returns true only if both filters do so.

Parameters

left	The first argument of the conjunction operation.
right	The second argument of the conjunction operation.

◆ Custom()

SearchFilterPtr Custom	(	const FunctionPtr &	acceptsFunction,
		const FunctionPtr &	visitFunction = `nullptr`
	)

inline

Creates a custom search filter with a user-defined "accepts" and "visit children" function.

Parameters

acceptsFunction	The function to be called when "accepts component" is called. Should return `true` or `false`.
visitFunction	The function to be called when "visit children" is called. Should return `true` or `false`.

◆ ExcludeTags()

SearchFilterPtr ExcludeTags ( const ListPtr< IString > & excludedTags )

inline

Creates a search filter that accepts components that do not have any of the excluded tags. "Visit children" always returns true.

Parameters

excludedTags A list of strings containing the tags that a component must not have to be accepted.

◆ InterfaceId()

SearchFilterPtr InterfaceId ( const IntfID & intfId )

inline

Creates a search filter that accepts components that implement the interface with the given interface ID. "Visit children" always returns true.

Parameters

intfId The interface ID that should be implemented by accepted components.

◆ LocalId()

SearchFilterPtr LocalId ( const StringPtr & localId )

inline

Creates a search filter that accepts components with the specified local ID. "Visit children" always returns true.

Parameters

localId The local ID of the accepted components.

◆ Not()

SearchFilterPtr Not ( const SearchFilterPtr & filter )

inline

Creates a search filter that negates the "accepts component" result of the filter provided as construction argument. Does not negate the "visit children" result.

Parameters

filter The filter of which results should be negated.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [1/5]

IList requiredTags const IntfID intfId ISearchFilter OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		AndSearchFilter	,
		ISearchFilter	,
		ISearchFilter *	,
		left	,
		ISearchFilter *	,
		right
	)

Creates a "conjunction" search filter that combines 2 filters, accepting a component only if both filters accept it. "Visit children" returns true only if both filters do so.

Parameters

left	The first argument of the conjunction operation.
right	The second argument of the conjunction operation.

Creates a "disjunction" search filter that combines 2 filters, accepting a component if any of the two filters accepts it. "Visit children" returns true if any of the two filters accepts does so.

Parameters

left	The first argument of the disjunction operation.
right	The second argument of the disjunction operation.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [2/5]

IList requiredTags OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		ExcludedTagsSearchFilter	,
		ISearchFilter	,
		IList *	,
		excludedTags
	)

Creates a search filter that accepts components that do not have any of the excluded tags. "Visit children" always returns true.

Parameters

excludedTags A list of strings containing the tags that a component must not have to be accepted.

Creates a search filter that accepts components that implement the interface with the given interface ID. "Visit children" always returns true.

Parameters

intfId The interface ID that should be implemented by accepted components.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [3/5]

IList requiredTags const IntfID intfId OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		LocalIdSearchFilter	,
		ISearchFilter	,
		IString *	,
		localId
	)

Creates a search filter that accepts components with the specified local ID. "Visit children" always returns true.

Parameters

localId The local ID of the accepted components.

Creates a search filter that accepts all components. "Visit children" always returns true.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [4/5]

IList requiredTags const IntfID intfId ISearchFilter ISearchFilter ISearchFilter right OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		NotSearchFilter	,
		ISearchFilter	,
		ISearchFilter *	,
		filter
	)

Creates a search filter that negates the "accepts component" result of the filter provided as construction argument. Does not negate the "visit children" result.

Parameters

filter The filter of which results should be negated.

Creates a custom search filter with a user-defined "accepts" and "visit children" function.

Parameters

acceptsFunction	The function to be called when "accepts component" is called. Should return `true` or `false`.
visitFunction	The function to be called when "visit children" is called. Should return `true` or `false`.

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [5/5]

OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE	(	LIBRARY_FACTORY	,
		VisibleSearchFilter	,
		ISearchFilter
	)

Creates a search filter that accepts only visible components. "Visit children" returns true only if the component being evaluated is visible.

Creates a search filter that accepts components that have all the required tags. "Visit children" always returns true.

Parameters

requiredTags A list of strings containing the tags that a component must have to be accepted.

◆ Or()

SearchFilterPtr Or	(	const SearchFilterPtr &	left,
		const SearchFilterPtr &	right
	)

inline

Creates a "disjunction" search filter that combines 2 filters, accepting a component if any of the two filters accepts it. "Visit children" returns true if any of the two filters accepts does so.

Parameters

left	The first argument of the disjunction operation.
right	The second argument of the disjunction operation.

◆ Recursive()

SearchFilterPtr Recursive ( const SearchFilterPtr & filter )

inline

Creates a search filter that indicates that the tree traversal method should recursively search the tree. This filter constructor should always be the final filter wrapper, and should not be used as a constructor argument for another filter.

Parameters

filter The filter to be wrapped with a "recursive" flag.

◆ RequireTags()

SearchFilterPtr RequireTags ( const ListPtr< IString > & requiredTags )

inline

Creates a search filter that accepts components that have all the required tags. "Visit children" always returns true.

Parameters

requiredTags A list of strings containing the tags that a component must have to be accepted.

	openDAQ Open data acquisition platform

Detailed Description

Functions

Function Documentation

◆ And()

◆ Custom()

◆ ExcludeTags()

◆ InterfaceId()

◆ LocalId()

◆ Not()

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [1/5]

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [2/5]

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [3/5]

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [4/5]

◆ OPENDAQ_DECLARE_CLASS_FACTORY_WITH_INTERFACE() [5/5]

◆ Or()

◆ Recursive()

◆ RequireTags()