Gazebo Common

API Reference

4.9.0

String buffer for the base logger. More...

#include <Console.hh>

Public Member Functions

 Buffer (LogType _type, const int _color, const int _verbosity)
 Constructor. More...
 
virtual ~Buffer ()
 Destructor. More...
 
int sync () override
 Sync the stream (output the string buffer contents). More...
 
std::streamsize xsputn (const char *_char, std::streamsize _count) override
 Writes _count characters to the string buffer. More...
 
- Public Member Functions inherited from stringbuf
T stringbuf (T... args)
 
T eback (T... args)
 
T egptr (T... args)
 
T epptr (T... args)
 
T gbump (T... args)
 
T getloc (T... args)
 
T gptr (T... args)
 
T imbue (T... args)
 
T in_avail (T... args)
 
T operator= (T... args)
 
T overflow (T... args)
 
T pbackfail (T... args)
 
T pbase (T... args)
 
T pbump (T... args)
 
T pptr (T... args)
 
T pubimbue (T... args)
 
T pubseekoff (T... args)
 
T pubseekpos (T... args)
 
T pubsetbuf (T... args)
 
T pubsync (T... args)
 
T sbumpc (T... args)
 
T seekoff (T... args)
 
T seekpos (T... args)
 
T setbuf (T... args)
 
T setg (T... args)
 
T setp (T... args)
 
T sgetc (T... args)
 
T sgetn (T... args)
 
T showmanyc (T... args)
 
T snextc (T... args)
 
T sputbackc (T... args)
 
T sputc (T... args)
 
T sputn (T... args)
 
T str (T... args)
 
T sungetc (T... args)
 
T swap (T... args)
 
T sync (T... args)
 
T uflow (T... args)
 
T underflow (T... args)
 
T xsgetn (T... args)
 
T xsputn (T... args)
 

Public Attributes

int color
 ANSI color code using Select Graphic Rendition parameters (SGR). See http://en.wikipedia.org/wiki/ANSI_escape_code#Colors. More...
 
LogType type
 Destination type for the messages. More...
 
int verbosity
 Level of verbosity. More...
 

Detailed Description

String buffer for the base logger.

Constructor & Destructor Documentation

◆ Buffer()

Buffer ( LogType  _type,
const int  _color,
const int  _verbosity 
)

Constructor.

Parameters
[in]_typeOutput destination type (STDOUT, or STDERR)
[in]_colorColor of the output stream.
[in]_verbosityVerbosity level.

◆ ~Buffer()

virtual ~Buffer ( )
virtual

Destructor.

Member Function Documentation

◆ sync()

int sync ( )
override

Sync the stream (output the string buffer contents).

Returns
Return 0 on success.

◆ xsputn()

std::streamsize xsputn ( const char *  _char,
std::streamsize  _count 
)
override

Writes _count characters to the string buffer.

Parameters
[in]_charInput rharacter array.
[in]_countNumber of characters in array.
Returns
The number of characters successfully written.

Member Data Documentation

◆ color

int color

ANSI color code using Select Graphic Rendition parameters (SGR). See http://en.wikipedia.org/wiki/ANSI_escape_code#Colors.

◆ type

LogType type

Destination type for the messages.

◆ verbosity

int verbosity

Level of verbosity.


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