vulp  2.2.2
vulp::observation::ObserverPipeline Class Reference

Observer pipeline. More...

#include <ObserverPipeline.h>

Public Types

using iterator = ObserverPtrVector::iterator
 

Public Member Functions

void reset (const Dictionary &config)
 Reset observers. More...
 
void connect_source (std::shared_ptr< Source > source)
 
void append_observer (std::shared_ptr< Observer > observer)
 
SourcePtrVector & sources ()
 Sources of the pipeline. More...
 
size_t nb_sources ()
 Number of sources in the pipeline. More...
 
ObserverPtrVector & observers ()
 Observers of the pipeline. Order matters. More...
 
size_t nb_observers ()
 Number of observers in the pipeline. More...
 
void run (Dictionary &observation)
 Run observer pipeline on an observation dictionary. More...
 

Detailed Description

Observer pipeline.

An observer pipeline is a list of sources and observers, to be executed in that order. Observers further down the pipeline may depend on the results of those that precede them, which are written to the observation dictionary. The pipeline is thus assumed to be topologically sorted.

Definition at line 22 of file ObserverPipeline.h.

Member Typedef Documentation

◆ iterator

using vulp::observation::ObserverPipeline::iterator = ObserverPtrVector::iterator

Definition at line 28 of file ObserverPipeline.h.

Member Function Documentation

◆ append_observer()

void vulp::observation::ObserverPipeline::append_observer ( std::shared_ptr< Observer observer)
inline

Definition at line 52 of file ObserverPipeline.h.

◆ connect_source()

void vulp::observation::ObserverPipeline::connect_source ( std::shared_ptr< Source source)
inline

Definition at line 44 of file ObserverPipeline.h.

◆ nb_observers()

size_t vulp::observation::ObserverPipeline::nb_observers ( )
inline

Number of observers in the pipeline.

Definition at line 66 of file ObserverPipeline.h.

◆ nb_sources()

size_t vulp::observation::ObserverPipeline::nb_sources ( )
inline

Number of sources in the pipeline.

Definition at line 60 of file ObserverPipeline.h.

◆ observers()

ObserverPtrVector& vulp::observation::ObserverPipeline::observers ( )
inline

Observers of the pipeline. Order matters.

Definition at line 63 of file ObserverPipeline.h.

◆ reset()

void vulp::observation::ObserverPipeline::reset ( const Dictionary &  config)

Reset observers.

Parameters
[in]configOverall configuration dictionary.

Definition at line 15 of file ObserverPipeline.cpp.

◆ run()

void vulp::observation::ObserverPipeline::run ( Dictionary &  observation)

Run observer pipeline on an observation dictionary.

Parameters
[in,out]observationObservation dictionary.

Definition at line 21 of file ObserverPipeline.cpp.

◆ sources()

SourcePtrVector& vulp::observation::ObserverPipeline::sources ( )
inline

Sources of the pipeline.

Definition at line 57 of file ObserverPipeline.h.


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