RF24Log  0.1.3
Unified logging library
Public Member Functions | Public Attributes | List of all members
FormatSpecifier Struct Reference

Some data about a format specifier. More...

#include <FormatSpecifier.h>

Public Member Functions

 FormatSpecifier (char pad=' ')
 Construct a new Specifier Flags object. More...
 
bool isFlagged (char c)
 is a character a valid specifier flag More...
 
bool isPaddPrec (char c)
 is a character a valid specifier padding/precision quantity More...
 
bool isFmtOption (char c)
 is a character a valid/supported specifier format option More...
 

Public Attributes

char fill
 The default character used as padding.
 
uint16_t width
 The width of the padding.
 
int8_t precis
 The number of decimal places. If negative, then default of 2 places is used.
 
uint8_t length
 bit-length of the data (only applies to integer numbers) More...
 
char specifier
 datatype specifier
 

Detailed Description

Some data about a format specifier.

Definition at line 22 of file FormatSpecifier.h.

Constructor & Destructor Documentation

◆ FormatSpecifier()

FormatSpecifier::FormatSpecifier ( char  pad = ' ')
inline

Construct a new Specifier Flags object.

Parameters
padThe default char used when padding data

Definition at line 28 of file FormatSpecifier.h.

Member Function Documentation

◆ isFlagged()

bool FormatSpecifier::isFlagged ( char  c)

is a character a valid specifier flag

Parameters
cA character
Returns
true if the c param is a valid option; false otherwise

Definition at line 19 of file FormatSpecifier.cpp.

◆ isFmtOption()

bool FormatSpecifier::isFmtOption ( char  c)

is a character a valid/supported specifier format option

Parameters
cA character
Returns
true if the c param could be followed by another option; false otherwise

Definition at line 57 of file FormatSpecifier.cpp.

◆ isPaddPrec()

bool FormatSpecifier::isPaddPrec ( char  c)

is a character a valid specifier padding/precision quantity

Parameters
cA character
Returns
true if the c param is a valid option; false otherwise

Definition at line 30 of file FormatSpecifier.cpp.

Member Data Documentation

◆ length

uint8_t FormatSpecifier::length

bit-length of the data (only applies to integer numbers)

If the most-significant bit is asserted, then the formatted data is treated as though it is unsigned.

Definition at line 63 of file FormatSpecifier.h.


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