version 0.4.1
Ikarus::ControlLogger Class Reference

ControlLogger class for logging control messages. More...

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

Inheritance diagram for Ikarus::ControlLogger:
[legend]

Public Types

using MessageType = ControlMessages
 

Public Member Functions

void updateImpl (ControlMessages message) final
 Implementation of the update method for control message logging. More...
 
void updateImpl (ControlMessages message, const std::string &val) final
 Implementation of the update method for logging control messages with string values. More...
 
void updateImpl (ControlMessages message, int val1, const std::string &val2) final
 Implementation of the update method for logging control messages with an integer and a string value. More...
 
void updateImpl (ControlMessages message, int val1, double val2) final
 Implementation of the update method for logging control messages with an integer and a double value. 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, double val)
 
virtual void updateImpl (MessageType message, int val)
 
virtual void updateImpl (MessageType message, const Eigen::VectorXd &vec)
 

Detailed Description

This class implements an observer for control messages and logs relevant information based on the received messages.

Member Typedef Documentation

◆ MessageType

using Ikarus::IObserver< ControlMessages >::MessageType = ControlMessages
inherited

Member Function Documentation

◆ update() [1/7]

void Ikarus::IObserver< ControlMessages >::update ( MessageType  message)
inlineinherited
Parameters
messageThe message to be received.

◆ update() [2/7]

void Ikarus::IObserver< ControlMessages >::update ( MessageType  message,
const Eigen::VectorXd &  vec 
)
inlineinherited
Parameters
messageThe message to be received.
vecThe Eigen::VectorXd associated with the message.

◆ update() [3/7]

void Ikarus::IObserver< ControlMessages >::update ( MessageType  message,
const std::string &  val 
)
inlineinherited
Parameters
messageThe message to be received.
valThe string value associated with the message.

◆ update() [4/7]

void Ikarus::IObserver< ControlMessages >::update ( MessageType  message,
double  val 
)
inlineinherited
Parameters
messageThe message to be received.
valThe double value associated with the message.

◆ update() [5/7]

void Ikarus::IObserver< ControlMessages >::update ( MessageType  message,
int  val 
)
inlineinherited
Parameters
messageThe message to be received.
valThe integer value associated with the message.

◆ update() [6/7]

void Ikarus::IObserver< ControlMessages >::update ( MessageType  message,
int  val1,
const std::string &  val2 
)
inlineinherited
Parameters
messageThe message to be received.
val1The integer value associated with the message.
val2The string value associated with the message.

◆ update() [7/7]

void Ikarus::IObserver< ControlMessages >::update ( MessageType  message,
int  val1,
double  val2 
)
inlineinherited
Parameters
messageThe message to be received.
val1The integer value associated with the message.
val2The double value associated with the message.

◆ updateImpl() [1/7]

void Ikarus::ControlLogger::updateImpl ( ControlMessages  message)
finalvirtual
Parameters
messageThe received control message.

Reimplemented from Ikarus::IObserver< ControlMessages >.

◆ updateImpl() [2/7]

void Ikarus::ControlLogger::updateImpl ( ControlMessages  message,
const std::string &  val 
)
finalvirtual
Parameters
messageThe received control message.
valThe string value associated with the message.

Reimplemented from Ikarus::IObserver< ControlMessages >.

◆ updateImpl() [3/7]

void Ikarus::ControlLogger::updateImpl ( ControlMessages  message,
int  val1,
const std::string &  val2 
)
finalvirtual
Parameters
messageThe received control message.
val1The integer value associated with the message.
val2The string value associated with the message.

Reimplemented from Ikarus::IObserver< ControlMessages >.

◆ updateImpl() [4/7]

void Ikarus::ControlLogger::updateImpl ( ControlMessages  message,
int  val1,
double  val2 
)
finalvirtual
Parameters
messageThe received control message.
val1The integer value associated with the message.
val2The double value associated with the message.

Reimplemented from Ikarus::IObserver< ControlMessages >.

◆ updateImpl() [5/7]

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

◆ updateImpl() [6/7]

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

◆ updateImpl() [7/7]

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

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