urcl::primary_interface::AbstractPrimaryConsumer Class Reference

Base consumer for primary packages. More...

#include <abstract_primary_consumer.h>

Inheritance diagram for urcl::primary_interface::AbstractPrimaryConsumer:

Public Member Functions
	AbstractPrimaryConsumer ()=default
virtual bool	consume (std::shared_ptr< PrimaryPackage > product) final
	This consume method is usally being called by the Pipeline structure. We don't necessarily need to know the specific package type here, as the packages themselves will take care to be consumed with the correct function (visitor pattern). More...
virtual bool	consume (RobotMessage &pkg)=0
virtual bool	consume (RobotState &pkg)=0
virtual bool	consume (VersionMessage &pkg)=0
virtual bool	consume (KinematicsInfo &pkg)=0
virtual	~AbstractPrimaryConsumer ()=default
Public Member Functions inherited from urcl::comm::IConsumer< PrimaryPackage >
virtual bool	consume (std::shared_ptr< PrimaryPackage > product)=0
	Consumes a product, utilizing it's contents. More...
virtual void	onTimeout ()
	Functionality for handling consumer timeouts. More...
virtual void	setupConsumer ()
	Set-up functionality of the consumer. More...
virtual void	stopConsumer ()
	Stops the consumer. More...
virtual void	teardownConsumer ()
	Fully tears down the consumer - by default no difference to stopping it. More...

Detailed Description

Base consumer for primary packages.

Primary interface consumers can inherit from this class in order to implement the visitor pattern for consuming primary packages.

Definition at line 46 of file abstract_primary_consumer.h.

Constructor & Destructor Documentation

urcl::primary_interface::AbstractPrimaryConsumer::AbstractPrimaryConsumer ( )

default

virtual urcl::primary_interface::AbstractPrimaryConsumer::~AbstractPrimaryConsumer ( )

virtualdefault

Member Function Documentation

virtual bool urcl::primary_interface::AbstractPrimaryConsumer::consume ( std::shared_ptr< PrimaryPackage >  product )

inlinefinalvirtual

This consume method is usally being called by the Pipeline structure. We don't necessarily need to know the specific package type here, as the packages themselves will take care to be consumed with the correct function (visitor pattern).

Parameters

product

package as it is received from the robot

Returns

true on successful consuming

Definition at line 61 of file abstract_primary_consumer.h.

virtual bool urcl::primary_interface::AbstractPrimaryConsumer::consume ( RobotMessage &  pkg )

pure virtual

virtual bool urcl::primary_interface::AbstractPrimaryConsumer::consume ( RobotState &  pkg )

pure virtual

virtual bool urcl::primary_interface::AbstractPrimaryConsumer::consume ( VersionMessage &  pkg )

pure virtual

virtual bool urcl::primary_interface::AbstractPrimaryConsumer::consume ( KinematicsInfo &  pkg )

pure virtual

---

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

• abstract_primary_consumer.h