Ikarus::GenericListener< BC > Class Template Reference

GenericListener class for observing specific messages. This class template implements an listener for a specific message type. More...

#include <ikarus/utils/listener/genericlistener.hh>

Inheritance diagram for Ikarus::GenericListener< BC >:

Public Types
using	Token = std::shared_ptr< void >

Public Member Functions
template<typename F >
	GenericListener (BC &bc, Messages message, F &&f)
	Constructor for GenericListener. More...
void	updateImpl (Messages message, const State &state)
template<typename Broadcaster >
auto	subscribe (Broadcaster &broadcaster, std::function< void(typename Broadcaster::MessageType, const typename Broadcaster::State &)> callback)
	Function to subscribe to a broadcaster with a given function (either a lambda, std::function or function pointer). More...
void	unSubscribeAll ()
	Unsubscribe from all listeners. At the moment unsubscribing can't be done more granularly. More...
void	unSubscribeLast ()
	Unsubscribe from the last subscribed listener. More...
void	unSubscribe (const Token &token)
	Unsubscribe from a specific token. More...

Detailed Description

template<typename BC>
class Ikarus::GenericListener< BC >

Template Parameters

M	The type of messages to be listend to.

Member Typedef Documentation

Token

using Ikarus::Listener::Token = std::shared_ptr<void>

inherited

Constructor & Destructor Documentation

GenericListener()

template<typename BC >

template<typename F >

Ikarus::GenericListener< BC >::GenericListener ( BC &  bc, Messages  message, F &&  f  )

inline

Initializes the listener with a specific message and a function to be executed upon listening.

Template Parameters

F	Type of the function to be executed.

Parameters

message	The message to be listend to.
f	The function to be executed with the current step.

Member Function Documentation

subscribe()

template<typename Broadcaster >

auto Ikarus::Listener::subscribe ( Broadcaster &  broadcaster, std::function< void(typename Broadcaster::MessageType, const typename Broadcaster::State &)>  callback  )

inlineinherited

Template Parameters

Broadcaster

the type of the Broadcaster (for example a NonlinearSolver or ControlRoutine)

Parameters

broadcaster	the broadcaster
callback	the function

Here is the caller graph for this function:

unSubscribe()

void Ikarus::Listener::unSubscribe ( const Token &  token )

inlineinherited

unSubscribeAll()

void Ikarus::Listener::unSubscribeAll ( )

inlineinherited

unSubscribeLast()

void Ikarus::Listener::unSubscribeLast ( )

inlineinherited

updateImpl()

template<typename BC >

void Ikarus::GenericListener< BC >::updateImpl ( Messages  message, const State &  state  )

inline

Here is the caller graph for this function:

---

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

• genericlistener.hh