MoorDyn
Public Member Functions | Protected Attributes | List of all members
moordyn::LogUser Class Reference

A helper for the entities to use the logger. More...

#include <Log.hpp>

Inheritance diagram for moordyn::LogUser:
Inheritance graph
[legend]
Collaboration diagram for moordyn::LogUser:
Collaboration graph
[legend]

Public Member Functions

 LogUser (Log *log=NULL)
 Constructor. More...
 
 ~LogUser ()
 Destructor.
 
void SetLogger (Log *log)
 Set the log handler. More...
 
LogGetLogger () const
 Get the log handler. More...
 

Protected Attributes

Log_log
 The log handler.
 

Detailed Description

A helper for the entities to use the logger.

Inheriting this class you can grant the class will have everything required to use the macros LOGGER, LOGDBG, LOGMSG, LOGWRN and LOGERR

Constructor & Destructor Documentation

◆ LogUser()

moordyn::LogUser::LogUser ( Log log = NULL)
inline

Constructor.

Parameters
logThe log handler. NULL can be passed, providing later the log handler with SetLogger()
Warning
No messages shall be logged until a non NULL log handler is provided

Member Function Documentation

◆ GetLogger()

Log* moordyn::LogUser::GetLogger ( ) const
inline

Get the log handler.

Returns
The log handler
Here is the caller graph for this function:

◆ SetLogger()

void moordyn::LogUser::SetLogger ( Log log)
inline

Set the log handler.

Parameters
logThe log handler
Here is the caller graph for this function:

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