Interface for a minimal algorithm part that wants to expose some parameters to a module. More...

#include <Findlet.h>

Inheritance diagram for Findlet< AIOTypes >:

[legend]

Collaboration diagram for Findlet< AIOTypes >:

[legend]

Classes
struct	ToVectorImpl
	Forward a range of mutable objects. More...

struct	ToVectorImpl< const T >
	Specialisation to only forward a range for immutable types. More...

Public Types
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
virtual	~Findlet ()=default
	Make destructor of interface virtual.

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

virtual void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
	Forward prefixed parameters of this findlet to the module parameter list.

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
template<class T >
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 Types
using	Super = ProcessingSignalListener
	Type of the base class.

Private Attributes
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

Interface for a minimal algorithm part that wants to expose some parameters to a module.

Definition at line 26 of file Findlet.h.

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

Classes