Ikarus::NonLinearSolverLogger Class Reference

Implementation of an observer for logging non-linear solvers.This class inherits from the IObserver class and provides specific implementations for updating based on NonLinearSolverMessages.

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

Inheritance diagram for Ikarus::NonLinearSolverLogger:

Public Types
using	MessageType = NonLinearSolverMessages

Public Member Functions
void	updateImpl (NonLinearSolverMessages message) final
	Handles the update when a NonLinearSolverMessages is received. More...
void	updateImpl (NonLinearSolverMessages message, double val) final
	Handles the update when a NonLinearSolverMessages with a double value is received. More...
void	updateImpl (NonLinearSolverMessages message, int intVal) final
	Handles the update when a NonLinearSolverMessages with an integer value is received. More...
void	update (MessageType message)
	Update method for receiving notifications with a message. More...
void	update (MessageType message, double val)
	Update method for receiving notifications with a message and a double value. More...
void	update (MessageType message, int val)
	Update method for receiving notifications with a message and an integer value. More...
void	update (MessageType message, const std::string &val)
	Update method for receiving notifications with a message and a string value. More...
void	update (MessageType message, int val1, double val2)
	Update method for receiving notifications with a message and two values (integer and double). More...
void	update (MessageType message, int val1, const std::string &val2)
	Update method for receiving notifications with a message, an integer value, and a string value. More...
void	update (MessageType message, const Eigen::VectorXd &vec)
	Update method for receiving notifications with a message and an Eigen::VectorXd. More...

Protected Member Functions
virtual void	updateImpl (MessageType message, const std::string &val)
virtual void	updateImpl (MessageType message, int val1, const std::string &val2)
virtual void	updateImpl (MessageType message, int val1, double val2)
virtual void	updateImpl (MessageType message, const Eigen::VectorXd &vec)

Member Typedef Documentation

MessageType

using Ikarus::IObserver< NonLinearSolverMessages >::MessageType = NonLinearSolverMessages

inherited

Member Function Documentation

update() [1/7]

void Ikarus::IObserver< NonLinearSolverMessages >::update ( MessageType  message )

inlineinherited

Parameters

message

The message to be received.

update() [2/7]

void Ikarus::IObserver< NonLinearSolverMessages >::update ( MessageType  message, const Eigen::VectorXd &  vec  )

inlineinherited

Parameters

message	The message to be received.
vec	The Eigen::VectorXd associated with the message.

update() [3/7]

void Ikarus::IObserver< NonLinearSolverMessages >::update ( MessageType  message, const std::string &  val  )

inlineinherited

Parameters

message	The message to be received.
val	The string value associated with the message.

update() [4/7]

void Ikarus::IObserver< NonLinearSolverMessages >::update ( MessageType  message, double  val  )

inlineinherited

Parameters

message	The message to be received.
val	The double value associated with the message.

update() [5/7]

void Ikarus::IObserver< NonLinearSolverMessages >::update ( MessageType  message, int  val  )

inlineinherited

Parameters

message	The message to be received.
val	The integer value associated with the message.

update() [6/7]

void Ikarus::IObserver< NonLinearSolverMessages >::update ( MessageType  message, int  val1, const std::string &  val2  )

inlineinherited

Parameters

message	The message to be received.
val1	The integer value associated with the message.
val2	The string value associated with the message.

update() [7/7]

void Ikarus::IObserver< NonLinearSolverMessages >::update ( MessageType  message, int  val1, double  val2  )

inlineinherited

Parameters

message	The message to be received.
val1	The integer value associated with the message.
val2	The double value associated with the message.

updateImpl() [1/7]

virtual void Ikarus::IObserver< NonLinearSolverMessages >::updateImpl ( MessageType  message, const Eigen::VectorXd &  vec  )

inlineprotectedvirtualinherited

updateImpl() [2/7]

virtual void Ikarus::IObserver< NonLinearSolverMessages >::updateImpl ( MessageType  message, const std::string &  val  )

inlineprotectedvirtualinherited

updateImpl() [3/7]

virtual void Ikarus::IObserver< NonLinearSolverMessages >::updateImpl ( MessageType  message, int  val1, const std::string &  val2  )

inlineprotectedvirtualinherited

updateImpl() [4/7]

virtual void Ikarus::IObserver< NonLinearSolverMessages >::updateImpl ( MessageType  message, int  val1, double  val2  )

inlineprotectedvirtualinherited

updateImpl() [5/7]

void Ikarus::NonLinearSolverLogger::updateImpl ( NonLinearSolverMessages  message )

finalvirtual

Parameters

message

The NonLinearSolverMessages received.

Reimplemented from Ikarus::IObserver< NonLinearSolverMessages >.

updateImpl() [6/7]

void Ikarus::NonLinearSolverLogger::updateImpl ( NonLinearSolverMessages  message, double  val  )

finalvirtual

Parameters

message	The NonLinearSolverMessages received.
val	The double value associated with the message.

Reimplemented from Ikarus::IObserver< NonLinearSolverMessages >.

updateImpl() [7/7]

void Ikarus::NonLinearSolverLogger::updateImpl ( NonLinearSolverMessages  message, int  intVal  )

finalvirtual

Parameters

message	The NonLinearSolverMessages received.
intVal	The integer value associated with numberOfIterations.

Reimplemented from Ikarus::IObserver< NonLinearSolverMessages >.

---

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

• nonlinearsolverlogger.hh