Goby3  3.1.5a
2024.05.23
goby::util::FlexOStreamBuf Class Reference

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

Inheritance diagram for goby::util::FlexOStreamBuf:

Public Member Functions

 FlexOStreamBuf (FlexOstream *parent)
 
 ~FlexOStreamBuf ()
 
int sync ()
 virtual inherited from std::streambuf. Called when std::endl or std::flush is inserted into the stream More...
 
int overflow (int c=EOF)
 virtual inherited from std::streambuf. Called when something is inserted into the stream More...
 
void name (const std::string &s)
 name of the application being served More...
 
void add_stream (logger::Verbosity verbosity, std::ostream *os)
 add a stream to the logger More...
 
void remove_stream (std::ostream *os)
 remove a stream from the logger More...
 
bool is_quiet () const
 do all attached streams have Verbosity == quiet? More...
 
bool is_gui () const
 is there an attached stream with Verbosity == gui (ncurses GUI) More...
 
void enable_gui ()
 
logger::Verbosity highest_verbosity () const
 
void group_name (const std::string &s)
 current group name (last insertion of group("") into the stream) More...
 
void set_die_flag (bool b)
 exit on error at the next call to sync() More...
 
void set_verbosity_depth (logger::Verbosity depth)
 
logger::Verbosity verbosity_depth ()
 
void add_group (const std::string &name, logger::Group g)
 add a new group More...
 
void refresh ()
 refresh the display (does nothing if !is_gui()) More...
 
void set_lock_action (logger_lock::LockAction lock_action)
 
logger_lock::LockAction lock_action ()
 

Detailed Description

Definition at line 87 of file flex_ostreambuf.h.

Constructor & Destructor Documentation

◆ FlexOStreamBuf()

goby::util::FlexOStreamBuf::FlexOStreamBuf ( FlexOstream parent)

◆ ~FlexOStreamBuf()

goby::util::FlexOStreamBuf::~FlexOStreamBuf ( )

Member Function Documentation

◆ add_group()

void goby::util::FlexOStreamBuf::add_group ( const std::string &  name,
logger::Group  g 
)

add a new group

◆ add_stream()

void goby::util::FlexOStreamBuf::add_stream ( logger::Verbosity  verbosity,
std::ostream *  os 
)

add a stream to the logger

◆ enable_gui()

void goby::util::FlexOStreamBuf::enable_gui ( )

◆ group_name()

void goby::util::FlexOStreamBuf::group_name ( const std::string &  s)
inline

current group name (last insertion of group("") into the stream)

Definition at line 119 of file flex_ostreambuf.h.

◆ highest_verbosity()

logger::Verbosity goby::util::FlexOStreamBuf::highest_verbosity ( ) const
inline

Definition at line 116 of file flex_ostreambuf.h.

◆ is_gui()

bool goby::util::FlexOStreamBuf::is_gui ( ) const
inline

is there an attached stream with Verbosity == gui (ncurses GUI)

Definition at line 112 of file flex_ostreambuf.h.

◆ is_quiet()

bool goby::util::FlexOStreamBuf::is_quiet ( ) const
inline

do all attached streams have Verbosity == quiet?

Definition at line 109 of file flex_ostreambuf.h.

◆ lock_action()

logger_lock::LockAction goby::util::FlexOStreamBuf::lock_action ( )
inline

Definition at line 136 of file flex_ostreambuf.h.

◆ name()

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

name of the application being served

Definition at line 100 of file flex_ostreambuf.h.

◆ overflow()

int goby::util::FlexOStreamBuf::overflow ( int  c = EOF)

virtual inherited from std::streambuf. Called when something is inserted into the stream

◆ refresh()

void goby::util::FlexOStreamBuf::refresh ( )

refresh the display (does nothing if !is_gui())

◆ remove_stream()

void goby::util::FlexOStreamBuf::remove_stream ( std::ostream *  os)

remove a stream from the logger

◆ set_die_flag()

void goby::util::FlexOStreamBuf::set_die_flag ( bool  b)
inline

exit on error at the next call to sync()

Definition at line 122 of file flex_ostreambuf.h.

◆ set_lock_action()

void goby::util::FlexOStreamBuf::set_lock_action ( logger_lock::LockAction  lock_action)
inline

Definition at line 134 of file flex_ostreambuf.h.

◆ set_verbosity_depth()

void goby::util::FlexOStreamBuf::set_verbosity_depth ( logger::Verbosity  depth)
inline

Definition at line 124 of file flex_ostreambuf.h.

◆ sync()

int goby::util::FlexOStreamBuf::sync ( )

virtual inherited from std::streambuf. Called when std::endl or std::flush is inserted into the stream

◆ verbosity_depth()

logger::Verbosity goby::util::FlexOStreamBuf::verbosity_depth ( )
inline

Definition at line 126 of file flex_ostreambuf.h.


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