urcl::comm::IProducer< T > Class Template Reference

Parent class for arbitrary producers of packages. More...

#include <pipeline.h>

Inheritance diagram for urcl::comm::IProducer< T >:

Public Member Functions
virtual void	setupProducer ()
	Set-up functionality of the producers. More...
virtual void	startProducer ()
virtual void	stopProducer ()
	Stops the producer. More...
virtual void	teardownProducer ()
	Fully tears down the producer - by default no difference to stopping it. More...
virtual bool	tryGet (std::vector< std::unique_ptr< T >> &products)=0
	Reads packages from some source and produces corresponding objects. More...

Detailed Description

template<typename T>
class urcl::comm::IProducer< T >

Parent class for arbitrary producers of packages.

Template Parameters

T	Type of the produced products

Definition at line 169 of file pipeline.h.

Member Function Documentation

template<typename T>

virtual void urcl::comm::IProducer< T >::setupProducer ( )

inlinevirtual

Set-up functionality of the producers.

Reimplemented in urcl::comm::URProducer< T >, and urcl::comm::URProducer< urcl::rtde_interface::RTDEPackage >.

Definition at line 175 of file pipeline.h.

template<typename T>

virtual void urcl::comm::IProducer< T >::startProducer ( )

inlinevirtual

Reimplemented in urcl::comm::URProducer< T >, and urcl::comm::URProducer< urcl::rtde_interface::RTDEPackage >.

Definition at line 192 of file pipeline.h.

template<typename T>

virtual void urcl::comm::IProducer< T >::stopProducer ( )

inlinevirtual

Stops the producer.

Reimplemented in urcl::comm::URProducer< T >, and urcl::comm::URProducer< urcl::rtde_interface::RTDEPackage >.

Definition at line 188 of file pipeline.h.

template<typename T>

virtual void urcl::comm::IProducer< T >::teardownProducer ( )

inlinevirtual

Fully tears down the producer - by default no difference to stopping it.

Reimplemented in urcl::comm::URProducer< T >, and urcl::comm::URProducer< urcl::rtde_interface::RTDEPackage >.

Definition at line 181 of file pipeline.h.

template<typename T>

virtual bool urcl::comm::IProducer< T >::tryGet ( std::vector< std::unique_ptr< T >> &  products )

pure virtual

Reads packages from some source and produces corresponding objects.

Parameters

products

Vector of unique pointers to be filled with produced packages.

Returns

Success of the package production.

Implemented in urcl::comm::URProducer< T >, and urcl::comm::URProducer< urcl::rtde_interface::RTDEPackage >.

---

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

• pipeline.h