Provides formatted output to stream. More...

Inheritance diagram for Print:

Public Member Functions
int	getWriteError ()
	Gets last error. More...

void	clearWriteError ()
	Clears the last write error. More...

virtual size_t	write (uint8_t)=0
	Writes a single character to output stream. More...

size_t	write (const char *str)
	Writes a c-string to output stream. More...

virtual size_t	write (const uint8_t *buffer, size_t size)
	Writes characters from a buffer to output stream. More...

size_t	write (const char *buffer, size_t size)
	Writes characters from a buffer to output stream. More...

size_t	print (char)
	Prints a single character to output stream. More...

size_t	print (const char[])
	Prints a c-string to output stream. More...

size_t	print (unsigned long, int base=DEC)
	Prints a number to output stream. More...

size_t	print (long, int base=DEC)
	Prints a number to output stream. More...

size_t	print (unsigned int, int base=DEC)

size_t	print (unsigned char, int base=DEC)

size_t	print (int, int base=DEC)
	Prints a number to output stream. More...

size_t	print (double, int digits=2)
	Prints number to output stream. More...

size_t	print (const Printable &p)
	Prints a Printable object to output stream. More...

size_t	print (const String &s)
	Prints a String to output stream. More...

size_t	println (void)
	Prints a newline to output stream. More...

size_t	println (const char[])
	Prints a c-string to output stream, appending newline. More...

size_t	println (char)
	Prints a single character to output stream, appending newline. More...

size_t	println (unsigned char, int base=DEC)
	Prints a number to output stream, appending newline. More...

size_t	println (unsigned int, int base=DEC)

size_t	println (unsigned long, int base=DEC)

size_t	println (int, int base=DEC)
	Prints a number to output stream, appending newline. More...

size_t	println (long, int base=DEC)
	Prints a number to output stream, appending newline. More...

size_t	println (double, int digits=2)
	Prints a number to output stream, appending newline. More...

size_t	println (const Printable &p)
	Prints a Printable object to output stream, appending newline. More...

size_t	println (const String &s)
	Prints a String to output stream, appending newline. More...

size_t	printf (const char *fmt,...)
	Prints a formatted c-string to output stream. More...

Protected Member Functions
void	setWriteError (int err=1)

Detailed Description

Provides formatted output to stream.

Member Function Documentation

void Print::clearWriteError ( )

inline

Clears the last write error.

int Print::getWriteError ( )

inline

Gets last error.

Return values

int	Error number of last write error

size_t Print::print ( char )

Prints a single character to output stream.

Return values

size_t Quantity of characters written to stream

size_t Print::print ( const char [] )

Prints a c-string to output stream.

Parameters

char[] c-string to print

Return values

size_t	Quantity of characters written to output stream
size_t	Quantity of characters written to stream

size_t Print::print	(	unsigned	char,
		int	base = `DEC`
	)

Prints a number to output stream.

Parameters

unsigned long	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

Parameters

unsigned int	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

Parameters

unsigned char	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

size_t Print::print	(	long	,
		int	base = `DEC`
	)

Prints a number to output stream.

Parameters

long	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

size_t Print::print	(	int	,
		int	base = `DEC`
	)

Prints a number to output stream.

Parameters

int	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

size_t Print::print	(	double	,
		int	digits = `2`
	)

Prints number to output stream.

Prints a number to output stream.

Parameters

double	Number to print
int	Decimal places to show

Return values

size_t Quantity of characters written to output stream

Parameters

double	Number to print
digits	The decimal places to print (Default: 2, e.g. 21.35)

Return values

size_t Quantity of characters written to stream

size_t Print::print ( const Printable & p )

Prints a Printable object to output stream.

Parameters

p	Object to print

Return values

size_t Quantity of characters written to stream

size_t Print::print ( const String & s )

Prints a String to output stream.

Parameters

s	String to print

Return values

size_t Quantity of characters written to stream

size_t Print::printf	(	const char *	fmt,
			...
	)

Prints a formatted c-string to output stream.

Parameters

fmt	Pointer to formated c-string to print
...	Parameters for placeholders within formated string

Return values

size_t Quantity of characters written to stream

Note: Use standard printf placeholders, e.g. d for integer, s for c-string, etc.

size_t Print::println ( void )

Prints a newline to output stream.

Parameters

Prints newline to output stream

Return values

size_t	Quantity of characters written to output stream
size_t	Quantity of characters written to stream

size_t Print::println ( const char [] )

Prints a c-string to output stream, appending newline.

Parameters

char[] c-string to print

Return values

size_t Quantity of characters written to stream

size_t Print::println ( char )

Prints a single character to output stream, appending newline.

Parameters

char	Character to print

Return values

size_t Quantity of characters written to stream

size_t Print::println	(	unsigned	long,
		int	base = `DEC`
	)

Prints a number to output stream, appending newline.

Parameters

unsigned char	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

Parameters

unsigned int	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

Parameters

unsigned long	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

size_t Print::println	(	int	,
		int	base = `DEC`
	)

Prints a number to output stream, appending newline.

Parameters

int	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

size_t Print::println	(	long	,
		int	base = `DEC`
	)

Prints a number to output stream, appending newline.

Parameters

long	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

size_t Print::println	(	double	,
		int	digits = `2`
	)

Prints a number to output stream, appending newline.

Parameters

double	Number to print
digits	The decimal places to print (Default: 2, e.g. 21.35)

Return values

size_t Quantity of characters written to stream

size_t Print::println ( const Printable & p )

Prints a Printable object to output stream, appending newline.

Parameters

p	Object to print

Return values

size_t Quantity of characters written to stream

size_t Print::println ( const String & s )

Prints a String to output stream, appending newline.

Parameters

s	String to print

Return values

size_t Quantity of characters written to stream

size_t Print::write ( uint8_t )

pure virtual

Writes a single character to output stream.

Parameters

uint8_t Character to write to output stream

Return values

size_t Quantity of characters written to output stream

Implemented in LCD, HardwareSerial, MemoryDataStream, Adafruit_GFX, TwoWire, and CommandOutput.

size_t Print::write ( const char * str )

inline

Writes a c-string to output stream.

Parameters

str	Pointer to c-string

Return values

size_t Quantity of characters written to stream

size_t Print::write	(	const uint8_t *	buffer,
		size_t	size
	)

virtual

Writes characters from a buffer to output stream.

Parameters

buffer	Pointer to character buffer
size	Quantity of characters to write

Return values

size_t Quantity of characters written to stream

Reimplemented in MemoryDataStream, and TwoWire.

size_t Print::write	(	const char *	buffer,
		size_t	size
	)

inline

Writes characters from a buffer to output stream.

Parameters

buffer	Pointer to character buffer
size	Quantity of characters to write

Return values

size_t Quantity of characters written to stream

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation