Ikarus::NonLinearSolverLogger Class Reference

Implementation of an observer for logging non-linear solvers.

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

Inheritance diagram for Ikarus::NonLinearSolverLogger:

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

Public Member Functions
template<typename BC >
NonLinearSolverLogger &	subscribeTo (BC &bc)
void	update (NonLinearSolverMessages message, const Concepts::NonLinearSolverState auto &state)
	Implementation of the update method for logging control messages with a control routine state. More...
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...

Member Typedef Documentation

Token

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

inherited

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:

subscribeTo()

template<typename BC >

NonLinearSolverLogger & Ikarus::NonLinearSolverLogger::subscribeTo ( BC &  bc )

inline

unSubscribe()

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

inlineinherited

unSubscribeAll()

void Ikarus::Listener::unSubscribeAll ( )

inlineinherited

unSubscribeLast()

void Ikarus::Listener::unSubscribeLast ( )

inlineinherited

update()

void Ikarus::NonLinearSolverLogger::update ( NonLinearSolverMessages  message, const Concepts::NonLinearSolverState auto &  state  )

inline

Parameters

message	The received nonlinear solver message.
state	The received nonlinear solver state.

Here is the caller graph for this function:

---

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

• nonlinearsolverlogger.hh