Base class for data providers. More...
#include <sink.h>
Public Types | |
| using | Output = IO< Outputs... > |
| Grouped output types. More... | |
Public Member Functions | |
| Connection | connect_to_sink (Sink< Outputs... > &dst) noexcept |
| Connect this source to a sink. More... | |
| virtual void | disconnect () noexcept override |
| Disconnect from all connected sinks. More... | |
| void | disconnect_from_all_sinks () noexcept |
| Disconnect from all connected sinks. More... | |
| virtual | ~Source () |
 Public Member Functions inherited from fkie_message_filters::FilterBase | |
Static Public Attributes | |
| static constexpr std::size_t | NUM_OUTPUTS = sizeof...(Outputs) |
| Number of output arguments. More... | |
Protected Member Functions | |
| void | send (const Outputs &... out) |
| Pass data to all connected sinks. More... | |
Private Attributes | |
| boost::signals2::signal< void(const Outputs &...)> | signal_ |
Friends | |
| template<typename... > | |
| class | Sink |
Detailed Description
template<typename... Outputs>
class fkie_message_filters::Source< Outputs >
Base class for data providers.
In the message filter library, all data flows from sources to sinks. The sources are providers of data, which may either be generated synthetically or gathered from other sources, such as ROS topics.
Derived classes need to call the send() method to pass actual data to the connected sinks. This class does nothing but track which sinks have been connected. The send() method takes the same number and types of arguments as specified in the template instantiation.
- See also
- Sink
Member Typedef Documentation
◆ Output
| using fkie_message_filters::Source< Outputs >::Output = IO<Outputs...> |
Constructor & Destructor Documentation
◆ ~Source()
|
inlinevirtual |
Member Function Documentation
◆ connect_to_sink()
|
noexcept |
Connect this source to a sink.
Can be called multiple times to connect multiple sinks; in that case, the sinks receive data in the same order as they have been connected. This function does basically the same thing as Sink::connect_to_source(), only from the opposite point of view.
dstthe sink that is to be connected
- Returns
- a connection object that can be used to monitor or sever the created connection
Definition at line 30 of file source_impl.h.
◆ disconnect()
|
overridevirtualnoexcept |
Disconnect from all connected sinks.
The source implementation calls disconnect_from_all_sinks().
Implements fkie_message_filters::FilterBase.
Reimplemented in fkie_message_filters::Filter< In, Out >, fkie_message_filters::Filter< IO< Inputs... >, IO< Outputs... > >, fkie_message_filters::Filter< IO< Inputs... >, IO< Inputs... >::template Select< Is... > >, and fkie_message_filters::Filter< IO< Inputs... >, IO< Inputs... > >.
Definition at line 45 of file source_impl.h.
◆ disconnect_from_all_sinks()
|
noexcept |
Disconnect from all connected sinks.
Severs the connection to all sinks, turning the send() method into a no-op.
Definition at line 39 of file source_impl.h.
◆ send()
|
protected |
Friends And Related Function Documentation
◆ Sink
Member Data Documentation
◆ NUM_OUTPUTS
|
static |
◆ signal_
|
private |
The documentation for this class was generated from the following files: