WireCell::Fanout< Data, Address > Class Template Reference

#include <Faninout.h>

Public Types
typedef Data	result_type
typedef Address	address_type
typedef std::deque< result_type >	data_queue
typedef std::map< int, data_queue >	queue_map
typedef boost::signals2::signal< result_type()>	signal
typedef signal::slot_type	slot

Public Member Functions
void	connect (const slot &s)
void	address (const address_type &addr)
	Register an address. More...
result_type	operator() (const address_type &addr)

Private Attributes
signal	m_signal
queue_map	m_fan

Detailed Description

template<typename Data, typename Address = int>
class WireCell::Fanout< Data, Address >

A fanout which takes in Data from a connected slot and buffers it into set of addressable queues.

Definition at line 14 of file Faninout.h.

Member Typedef Documentation

template<typename Data, typename Address = int>

typedef Address WireCell::Fanout< Data, Address >::address_type

Definition at line 18 of file Faninout.h.

template<typename Data, typename Address = int>

typedef std::deque<result_type> WireCell::Fanout< Data, Address >::data_queue

Definition at line 19 of file Faninout.h.

template<typename Data, typename Address = int>

typedef std::map< int, data_queue > WireCell::Fanout< Data, Address >::queue_map

Definition at line 20 of file Faninout.h.

template<typename Data, typename Address = int>

typedef Data WireCell::Fanout< Data, Address >::result_type

Definition at line 17 of file Faninout.h.

template<typename Data, typename Address = int>

typedef boost::signals2::signal<result_type ()> WireCell::Fanout< Data, Address >::signal

Definition at line 23 of file Faninout.h.

template<typename Data, typename Address = int>

typedef signal::slot_type WireCell::Fanout< Data, Address >::slot

Definition at line 25 of file Faninout.h.

Member Function Documentation

template<typename Data, typename Address = int>

void WireCell::Fanout< Data, Address >::address ( const address_type &  addr )

inline

Register an address.

Definition at line 31 of file Faninout.h.

                                               {
            m_fan[addr] = data_queue();
        }

template<typename Data, typename Address = int>

void WireCell::Fanout< Data, Address >::connect ( const slot &  s )

inline

Definition at line 28 of file Faninout.h.

{ m_signal.connect(s); }

template<typename Data, typename Address = int>

result_type WireCell::Fanout< Data, Address >::operator() ( const address_type &  addr )

inline

Return a data from the given address. If the address has not yet been registered it will be but any previously returned data will not be seen.

Definition at line 38 of file Faninout.h.

                                                         {
            data_queue& dq = m_fan[addr];
            if (!dq.size()) {
                result_type dat = *m_signal();
                for (auto it = m_fan.begin(); it != m_fan.end(); ++it) {
                    it->second.push_back(dat);
                }
            }
            result_type dat = dq.front();
            dq.pop_front();
            return dat; 
        }

Member Data Documentation

template<typename Data, typename Address = int>

queue_map WireCell::Fanout< Data, Address >::m_fan

private

Definition at line 53 of file Faninout.h.

template<typename Data, typename Address = int>

signal WireCell::Fanout< Data, Address >::m_signal

private

Definition at line 52 of file Faninout.h.

---

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

• wire-cell-build/util/inc/WireCellUtil/Faninout.h