RF24Log  0.1.3
Unified logging library
Protected Member Functions | List of all members
RF24LogAbstractStream Class Referenceabstract

A protected collection of methods that output formatted data to a stream. More...

#include <AbstractStream.h>

Inheritance diagram for RF24LogAbstractStream:
RF24LogPrintfParser ArduinoPrintLogger NativePrintLogger OStreamLogger

Protected Member Functions

virtual void appendTimestamp ()=0
 output a timestamp
 
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...
 
virtual void appendChar (char data, uint16_t depth=1)=0
 append a character a number of times More...
 
virtual void appendInt (long data)=0
 append a signed (+/-) number More...
 
virtual void appendUInt (unsigned long data, uint8_t base=10)=0
 append an ‘unsigned’ (only +) number More...
 
virtual void appendDouble (double data, uint8_t precision=2)=0
 append a floating point number More...
 
virtual void appendStr (const char *data)=0
 append a c-string More...
 

Detailed Description

A protected collection of methods that output formatted data to a stream.

Definition at line 30 of file AbstractStream.h.

Member Function Documentation

◆ appendChar()

virtual void RF24LogAbstractStream::appendChar ( char  data,
uint16_t  depth = 1 
)
protectedpure virtual

append a character a number of times

Parameters
dataThe char to use
depthThe number of times that the data is sequentially output.

Implemented in OStreamLogger, NativePrintLogger, and ArduinoPrintLogger.

◆ appendDouble()

virtual void RF24LogAbstractStream::appendDouble ( double  data,
uint8_t  precision = 2 
)
protectedpure virtual

append a floating point number

Parameters
dataThe numeric data
precisionThe number of decimals places to output

Implemented in OStreamLogger, NativePrintLogger, and ArduinoPrintLogger.

◆ appendFormat()

void RF24LogAbstractStream::appendFormat ( FormatSpecifier fmt_parser,
va_list *  args 
)
protected

output a data according to the format specifier

Parameters
fmt_parserThe object of prefixed specifier options/flags
argsThe sequence of args

Definition at line 67 of file AbstractStream.cpp.

◆ appendInt()

virtual void RF24LogAbstractStream::appendInt ( long  data)
protectedpure virtual

append a signed (+/-) number

Parameters
dataThe numeric data

Implemented in OStreamLogger, NativePrintLogger, and ArduinoPrintLogger.

◆ appendLogLevel()

void RF24LogAbstractStream::appendLogLevel ( uint8_t  logLevel)
protected

output a description of the log level

Parameters
logLevelThe level to describe.

Definition at line 33 of file AbstractStream.cpp.

◆ appendStr()

virtual void RF24LogAbstractStream::appendStr ( const char *  data)
protectedpure virtual

append a c-string

Parameters
dataThe c-string data

Implemented in OStreamLogger, NativePrintLogger, and ArduinoPrintLogger.

◆ appendUInt()

virtual void RF24LogAbstractStream::appendUInt ( unsigned long  data,
uint8_t  base = 10 
)
protectedpure virtual

append an ‘unsigned’ (only +) number

Parameters
dataThe numeric data
baseThe base counting scheme. Defaults to 10 for decimal counting system

Implemented in OStreamLogger, NativePrintLogger, and ArduinoPrintLogger.

◆ descTimeLevel()

void RF24LogAbstractStream::descTimeLevel ( uint8_t  logLevel)
protected

Automate the output of the header' timestamp and level description.

Parameters
logLevelThe Log level to describe.

Definition at line 22 of file AbstractStream.cpp.


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