shore::source< S, T > Class Template Reference

Template for turning a class into a pipeline source. More...

Public Types
typedef S	source_type
	The type of the wrapped object.
typedef T	current_type
	The type of the data that are emitted.

Public Member Functions
template<typename Arg1 >
	source (Arg1 arg1)
template<typename Arg1 , typename Arg2 >
	source (Arg1 arg1, Arg2 arg2)
template<typename Arg1 , typename Arg2 , typename Arg3 >
	source (Arg1 arg1, Arg2 arg2, Arg3 arg3)
template<typename Arg1 , typename Arg2 , typename Arg3 , typename Arg4 >
	source (Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
template<typename Arg1 , typename Arg2 , typename Arg3 , typename Arg4 , typename Arg5 >
	source (Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4, Arg5 arg5)
template<typename Arg1 , typename Arg2 , typename Arg3 , typename Arg4 , typename Arg5 , typename Arg6 >
	source (Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4, Arg5 arg5, Arg6 arg6)
	source (const source &t)
	Copy constructor: need to bind the slots to the correct object.
void	set_flush (const bool f)
	May be set to false to indicate that sigflush should not be emitted when no more data is left; useful when subsequently dumping multiple sources to the same pipeline.
source_type *	operator-> ()
	Dereferencing operators retrieve the wrapped object.
source_type &	operator* ()
	Dereferencing operators retrieve the wrapped object.
const source_type *	operator-> () const
	Dereferencing operators retrieve the wrapped object.
const source_type &	operator* () const
	Dereferencing operators retrieve the wrapped object.
signal< const current_type & > &	sigdata ()
	Gets the signal for passing data to downstream pipeline elements.
signal< void > &	sigflush ()
	Gets the signal for indicating no more data will be generated to downstream elements.
slot< void > &	slotfreeze ()
	Gets the slot for receiving freeze requests from downstream elements.
slot< void > &	slotthaw ()
	Gets the slot for receiving thaw requests from downstream elements.
void	dump ()
	Emit data until no more is left or sigfreeze is received from a downstream pipeline element.

Detailed Description

template<typename S, typename T = typename source_traits<S>::current_type>
class shore::source< S, T >

Template for turning a class into a pipeline source.

The source class must provide the methods current(), has_data() and next().

---

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

• shore/processing/pipeline.hpp