OStreamLogger Class Reference

Class to manage logging messages to a ostream based object. More...

#include <OStreamLogger.h>

Inheritance diagram for OStreamLogger:

Public Member Functions
	OStreamLogger (std::ostream *stream)
	Construct a new OStreamLogger object. More...
Public Member Functions inherited from RF24LogAbstractHandler
	RF24LogAbstractHandler ()
	Sets log level to INFO upon instantiation.
void	log (uint8_t logLevel, const char *vendorId, const char *message, va_list *args)
	log a message. More...
void	setLogLevel (uint8_t logLevel)

Protected Member Functions
void	appendTimestamp ()
	output a timestamp
void	appendChar (char data, uint16_t depth=1)
	append a character a number of times More...
void	appendInt (long data)
	append a signed (+/-) number More...
void	appendUInt (unsigned long data, uint8_t base=10)
	append an ‘unsigned’ (only +) number More...
void	appendDouble (double data, uint8_t precision=2)
	append a floating point number More...
void	appendStr (const char *data)
	append a c-string More...
Protected Member Functions inherited from RF24LogPrintfParser
void	write (uint8_t logLevel, const char *vendorId, const char *message, va_list *args)
Protected Member Functions inherited from RF24LogAbstractStream
void	appendLogLevel (uint8_t logLevel)
	output a description of the log level More...
void	descTimeLevel (uint8_t logLevel)
	Automate the output of the header' timestamp and level description. More...
void	appendFormat (FormatSpecifier *fmt_parser, va_list *args)
	output a data according to the format specifier More...

Additional Inherited Members
Protected Attributes inherited from RF24LogAbstractHandler
uint8_t	_logLevel

Detailed Description

Class to manage logging messages to a ostream based object.

Definition at line 23 of file OStreamLogger.h.

Constructor & Destructor Documentation

OStreamLogger()

OStreamLogger::OStreamLogger

(

std::ostream *

stream

)

Construct a new OStreamLogger object.

Parameters

stream

The output stream that inherits from ostream class.

Definition at line 19 of file OStreamLogger.cpp.

Member Function Documentation

appendChar()

void OStreamLogger::appendChar ( char  data, uint16_t  depth = 1  )

protectedvirtual

append a character a number of times

Parameters

data	The char to use
depth	The number of times that the data is sequentially output.

Implements RF24LogAbstractStream.

Definition at line 40 of file OStreamLogger.cpp.

appendDouble()

void OStreamLogger::appendDouble ( double  data, uint8_t  precision = 2  )

protectedvirtual

append a floating point number

Parameters

data	The numeric data
precision	The number of decimals places to output

Implements RF24LogAbstractStream.

Definition at line 95 of file OStreamLogger.cpp.

appendInt()

void OStreamLogger::appendInt ( long  data )

protectedvirtual

append a signed (+/-) number

Parameters

data	The numeric data

Implements RF24LogAbstractStream.

Definition at line 51 of file OStreamLogger.cpp.

appendStr()

void OStreamLogger::appendStr ( const char *  data )

protectedvirtual

append a c-string

Parameters

data	The c-string data

Implements RF24LogAbstractStream.

Definition at line 105 of file OStreamLogger.cpp.

appendUInt()

void OStreamLogger::appendUInt ( unsigned long  data, uint8_t  base = 10  )

protectedvirtual

append an ‘unsigned’ (only +) number

Parameters

data	The numeric data
base	The base counting scheme. Defaults to 10 for decimal counting system

Implements RF24LogAbstractStream.

Definition at line 58 of file OStreamLogger.cpp.

---

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

• src/RF24Loggers/OStreamLogger.h
• src/RF24Loggers/OStreamLogger.cpp