Public Member Functions | List of all members
urcl::comm::ShellConsumer< T > Class Template Reference

The ShellConsumer class is a simple consumer that writes a readable representation to the logging info channel. More...

#include <shell_consumer.h>

Inheritance diagram for urcl::comm::ShellConsumer< T >:
Inheritance graph
[legend]

Public Member Functions

virtual bool consume (std::shared_ptr< T > product)
 Consumes a package, writing a human readable representation to the logging. More...
 
 ShellConsumer ()=default
 
virtual ~ShellConsumer ()=default
 
- Public Member Functions inherited from urcl::comm::IConsumer< T >
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

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

The ShellConsumer class is a simple consumer that writes a readable representation to the logging info channel.

Template Parameters
HeaderTHeader type of the packages to consume

Definition at line 46 of file shell_consumer.h.

Constructor & Destructor Documentation

template<typename T >
urcl::comm::ShellConsumer< T >::ShellConsumer ( )
default
template<typename T >
virtual urcl::comm::ShellConsumer< T >::~ShellConsumer ( )
virtualdefault

Member Function Documentation

template<typename T >
virtual bool urcl::comm::ShellConsumer< T >::consume ( std::shared_ptr< T >  product)
inlinevirtual

Consumes a package, writing a human readable representation to the logging.

Parameters
productThe package to consume
Returns
True if the output was successful

Implements urcl::comm::IConsumer< T >.

Definition at line 59 of file shell_consumer.h.


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


ur_client_library
Author(s): Thomas Timm Andersen, Simon Rasmussen, Felix Exner, Lea Steffen, Tristan Schnell
autogenerated on Sun May 9 2021 02:16:26