Selector to remove all weighted relations, where a definable Filter gives NaN as a result. More...

Inheritance diagram for FilterSelector< ACollectorItem, ACollectionItem, AFilter >:

[legend]

Collaboration diagram for FilterSelector< ACollectorItem, ACollectionItem, AFilter >:

[legend]

Public Types
using	WeightedRelationItem = WeightedRelation< ACollectorItem, const ACollectionItem >
	Shortcut class name for a weighted relation between a collector item and a collection item.

using	Super = Findlet< WeightedRelation< ACollectorItem, const ACollectionItem > >
	The parent class.

using	IOTypes = std::tuple< AIOTypes... >
	Types that should be served to apply on invokation.

using	IOVectors = std::tuple< std::vector< AIOTypes >... >
	Vector types that should be served to apply on invokation.

Public Member Functions
	FilterSelector ()
	Add the chosen filter as a process signal listener.

void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the parameters of the filter.

void	apply (std::vector< WeightedRelationItem > &weightedRelations) override
	Main function of the class: calculate the filter result and remove all relations, where the filter returns NaN.

virtual std::string	getDescription ()
	Brief description of the purpose of the concret findlet.

virtual void	apply (ToVector< AIOTypes > &... ioVectors)=0
	Main function executing the algorithm.

void	initialize () override
	Receive and dispatch signal before the start of the event processing.

void	beginRun () override
	Receive and dispatch signal for the beginning of a new run.

void	beginEvent () override
	Receive and dispatch signal for the start of a new event.

void	endRun () override
	Receive and dispatch signal for the end of the run.

void	terminate () override
	Receive and dispatch Signal for termination of the event processing.

Protected Types
using	ToVector = typename ToVectorImpl< T >::Type
	Short hand for ToRangeImpl.

Protected Member Functions
void	addProcessingSignalListener (ProcessingSignalListener *psl)
	Register a processing signal listener to be notified.

int	getNProcessingSignalListener ()
	Get the number of currently registered listeners.

Private Attributes
AFilter	m_filter
	The filter to use.

std::vector< ProcessingSignalListener * >	m_subordinaryProcessingSignalListeners
	References to subordinary signal processing listener contained in this findlet.

bool	m_initialized = false
	Flag to keep track whether initialization happend before.

bool	m_terminated = false
	Flag to keep track whether termination happend before.

std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

Selector to remove all weighted relations, where a definable Filter gives NaN as a result.

Will also update all stored weights with the result of the filter. Please note that all other stored weights will be overriden!

Most likely, the full stack is used as follows:

match two lists of elements (Collectors and Collections) resulting in a list of weighted relations among those
select only some relations using a certain criteria (this is where the difference between Collector and Collections comes into place)
add the found relations by absorbing the collection items into the collector items.

Please note that the CollectionItems are therefore const whereas the CollectorItems are not. All the passed WeightedRelations lists must be sorted.

Most of the provided selectors are built to match many collection items to one collector item.

Definition at line 45 of file FilterSelector.h.

The documentation for this class was generated from the following file:

Public Types