Ikarus::IObserver< MT > Class Template Reference

Generic observer interface for the Observer design pattern. See [3] for a description of the design pattern. More...

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

Inheritance diagram for Ikarus::IObserver< MT >:

Public Types
using	MessageType = MT

Public Member Functions
virtual	~IObserver ()=default
	Virtual destructor for the observer interface. 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)
virtual void	updateImpl (MessageType message, double val)
virtual void	updateImpl (MessageType message, int val)
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)

Detailed Description

template<typename MT>
class Ikarus::IObserver< MT >

Template Parameters

MT	The type of message that the observer can handle.

Member Typedef Documentation

MessageType

template<typename MT >

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

Constructor & Destructor Documentation

~IObserver()

template<typename MT >

virtual Ikarus::IObserver< MT >::~IObserver ( )

virtualdefault

Member Function Documentation

update() [1/7]

template<typename MT >

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

inline

Parameters

message

The message to be received.

update() [2/7]

template<typename MT >

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

inline

Parameters

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

update() [3/7]

template<typename MT >

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

inline

Parameters

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

update() [4/7]

template<typename MT >

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

inline

Parameters

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

update() [5/7]

template<typename MT >

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

inline

Parameters

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

update() [6/7]

template<typename MT >

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

inline

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]

template<typename MT >

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

inline

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]

template<typename MT >

virtual void Ikarus::IObserver< MT >::updateImpl ( MessageType  message )

inlineprotectedvirtual

Reimplemented in Ikarus::ControlLogger, Ikarus::ControlSubsamplingVertexVTKWriter< B >, Ikarus::GenericObserver< M >, and Ikarus::NonLinearSolverLogger.

Here is the caller graph for this function:

updateImpl() [2/7]

template<typename MT >

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

inlineprotectedvirtual

updateImpl() [3/7]

template<typename MT >

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

inlineprotectedvirtual

Reimplemented in Ikarus::ControlLogger.

updateImpl() [4/7]

template<typename MT >

virtual void Ikarus::IObserver< MT >::updateImpl ( MessageType  message, double  val  )

inlineprotectedvirtual

Reimplemented in Ikarus::NonLinearSolverLogger.

updateImpl() [5/7]

template<typename MT >

virtual void Ikarus::IObserver< MT >::updateImpl ( MessageType  message, int  val  )

inlineprotectedvirtual

Reimplemented in Ikarus::NonLinearSolverLogger.

updateImpl() [6/7]

template<typename MT >

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

inlineprotectedvirtual

Reimplemented in Ikarus::ControlLogger.

updateImpl() [7/7]

template<typename MT >

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

inlineprotectedvirtual

Reimplemented in Ikarus::ControlLogger.

---

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

• observer.hh