Goby3  3.1.5a
2024.05.23
goby::util::logger::Group Class Reference

Defines a group of messages to be sent to the Goby logger. For Verbosity == verbose streams, all entries appear interleaved, but each group is offset with a different color. For Verbosity == gui streams, all groups have a separate subwindow. More...

#include <goby/util/debug_logger/logger_manipulators.h>

Public Member Functions

 Group (std::string name="", std::string description="", goby::util::Colors::Color color=goby::util::Colors::nocolor)
 
Getters
std::string name () const
 Name of this group (used in the group manipulator) More...
 
std::string description () const
 Human readable description of this group. More...
 
goby::util::Colors::Color color () const
 Color to use when displaying this group (for streams that support terminal escape codes only: std::cout, std::cerr, std::clog) More...
 
bool enabled () const
 Is this group enabled? More...
 

Setters

void name (const std::string &s)
 
void description (const std::string &s)
 
void color (goby::util::Colors::Color c)
 
void enabled (bool b)
 

Detailed Description

Defines a group of messages to be sent to the Goby logger. For Verbosity == verbose streams, all entries appear interleaved, but each group is offset with a different color. For Verbosity == gui streams, all groups have a separate subwindow.

Definition at line 68 of file logger_manipulators.h.

Constructor & Destructor Documentation

◆ Group()

goby::util::logger::Group::Group ( std::string  name = "",
std::string  description = "",
goby::util::Colors::Color  color = goby::util::Colors::nocolor 
)
inline

Definition at line 71 of file logger_manipulators.h.

Member Function Documentation

◆ color() [1/2]

goby::util::Colors::Color goby::util::logger::Group::color ( ) const
inline

Color to use when displaying this group (for streams that support terminal escape codes only: std::cout, std::cerr, std::clog)

Definition at line 84 of file logger_manipulators.h.

◆ color() [2/2]

void goby::util::logger::Group::color ( goby::util::Colors::Color  c)
inline

Definition at line 93 of file logger_manipulators.h.

◆ description() [1/2]

std::string goby::util::logger::Group::description ( ) const
inline

Human readable description of this group.

Definition at line 82 of file logger_manipulators.h.

◆ description() [2/2]

void goby::util::logger::Group::description ( const std::string &  s)
inline

Definition at line 92 of file logger_manipulators.h.

◆ enabled() [1/2]

bool goby::util::logger::Group::enabled ( ) const
inline

Is this group enabled?

Definition at line 86 of file logger_manipulators.h.

◆ enabled() [2/2]

void goby::util::logger::Group::enabled ( bool  b)
inline

Definition at line 94 of file logger_manipulators.h.

◆ name() [1/2]

std::string goby::util::logger::Group::name ( ) const
inline

Name of this group (used in the group manipulator)

Definition at line 80 of file logger_manipulators.h.

◆ name() [2/2]

void goby::util::logger::Group::name ( const std::string &  s)
inline

Definition at line 91 of file logger_manipulators.h.


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