W60X_Arduino: Print Class Reference

Arduino W60X

W60X_Arduino
Print Class Referenceabstract

Inherited by Server, and Stream.

Public Member Functions

int getWriteError ()
 This function is used to get write error number. More...
 
void clearWriteError ()
 This function is used to clear write error number. More...
 
virtual size_t write (uint8_t)=0
 This pure virtual function is used to define the operation that writes binary data. More...
 
virtual size_t write (const uint8_t *buffer, size_t size)
 This function is used to write buffer to the interface defined by the object. More...
 
size_t write (const char *str)
 This function is used to write buffer to the interface defined by the object. More...
 
size_t write (const char *buffer, size_t size)
 This function is used to write buffer to the interface defined by the object. More...
 
size_t print (const String &)
 This function is used to print buffer to the interface defined by the object. More...
 
size_t print (const char [])
 This function is used to print buffer to the interface defined by the object. More...
 
size_t print (char)
 This function is used to print buffer to the interface defined by the object. More...
 
size_t print (unsigned char, int=DEC)
 This function is used to print target to the interface defined by the object. More...
 
size_t print (int, int=DEC)
 This function is used to print target to the interface defined by the object. More...
 
size_t print (unsigned int, int=DEC)
 This function is used to print target to the interface defined by the object. More...
 
size_t print (long, int=DEC)
 This function is used to print target to the interface defined by the object. More...
 
size_t print (unsigned long, int=DEC)
 This function is used to print target to the interface defined by the object. More...
 
size_t print (double, int=BIN)
 This function is used to print target to the interface defined by the object. More...
 
size_t print (const Printable &)
 This function is used to print target to the interface defined by the object. More...
 
size_t println (void)
 This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
'). More...
 
size_t println (const String &s)
 This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
'). More...
 
size_t println (const char [])
 This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
'). More...
 
size_t println (char)
 This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
'). More...
 
size_t println (unsigned char, int=DEC)
 This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
'). More...
 
size_t println (int, int=DEC)
 This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
'). More...
 
size_t println (unsigned int, int=DEC)
 This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
'). More...
 
size_t println (long, int=DEC)
 This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
'). More...
 
size_t println (unsigned long, int=DEC)
 This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
'). More...
 
size_t println (double, int=BIN)
 This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
'). More...
 
size_t println (const Printable &)
 This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
'). More...
 

Protected Member Functions

void setWriteError (int err=1)
 

Member Function Documentation

◆ clearWriteError()

void Print::clearWriteError ( )
inline

This function is used to clear write error number.

Parameters
[in]None
Returns
None
Note

◆ getWriteError()

int Print::getWriteError ( )
inline

This function is used to get write error number.

Parameters
[in]None
Returns
The write error set by the object.
Note

◆ print() [1/10]

size_t Print::print ( const String &  s)

This function is used to print buffer to the interface defined by the object.

Parameters
[in]sSpecify the String.
Returns
The length of print successfully.
Note

◆ print() [2/10]

size_t Print::print ( const char  str[])

This function is used to print buffer to the interface defined by the object.

Parameters
[in]sSpecify the string buffer.
Returns
The length of print successfully.
Note

◆ print() [3/10]

size_t Print::print ( char  c)

This function is used to print buffer to the interface defined by the object.

Parameters
[in]cSpecify the target - char.
Returns
The length of print successfully (1 byte).
Note

◆ print() [4/10]

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

This function is used to print target to the interface defined by the object.

Parameters
[in]bSpecify the target - char.
[in]baseSpecify the base.
Returns
The length of print successfully.
Note

◆ print() [5/10]

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

This function is used to print target to the interface defined by the object.

Parameters
[in]nSpecify the target - int.
[in]baseSpecify the base.
Returns
The length of print successfully.
Note

◆ print() [6/10]

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

This function is used to print target to the interface defined by the object.

Parameters
[in]nSpecify the target - unsigned int.
[in]baseSpecify the base.
Returns
The length of print successfully.
Note

◆ print() [7/10]

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

This function is used to print target to the interface defined by the object.

Parameters
[in]nSpecify the target - long.
[in]baseSpecify the base.
Returns
The length of print successfully.
Note

◆ print() [8/10]

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

This function is used to print target to the interface defined by the object.

Parameters
[in]nSpecify the target - unsigned long.
[in]baseSpecify the base.
Returns
The length of print successfully.
Note

◆ print() [9/10]

size_t Print::print ( double  n,
int  digits = BIN 
)

This function is used to print target to the interface defined by the object.

Parameters
[in]nSpecify the target - double.
[in]digitsSpecify the digits.
Returns
The length of print successfully.
Note

◆ print() [10/10]

size_t Print::print ( const Printable x)

This function is used to print target to the interface defined by the object.

Parameters
[in]xSpecify the target - Printable.
Returns
The length of print successfully.
Note

◆ println() [1/11]

size_t Print::println ( void  )

This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
').

Parameters
[in]None
Returns
The length of print successfully.
Note

◆ println() [2/11]

size_t Print::println ( const String &  s)

This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
').

Parameters
[in]sSpecify the String.
Returns
The length of print successfully.
Note

◆ println() [3/11]

size_t Print::println ( const char  c[])

This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
').

Parameters
[in]cSpecify the string buffer.
Returns
The length of print successfully.
Note

◆ println() [4/11]

size_t Print::println ( char  c)

This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
').

Parameters
[in]cSpecify the target - char.
Returns
The length of print successfully.
Note

◆ println() [5/11]

size_t Print::println ( unsigned char  b,
int  base = DEC 
)

This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
').

Parameters
[in]nSpecify the target - int.
[in]baseSpecify the base.
Returns
The length of print successfully.
Note

◆ println() [6/11]

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

This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
').

Parameters
[in]numSpecify the target - int.
[in]baseSpecify the base.
Returns
The length of print successfully.
Note

◆ println() [7/11]

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

This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
').

Parameters
[in]numSpecify the target - unsigned int.
[in]baseSpecify the base.
Returns
The length of print successfully.
Note

◆ println() [8/11]

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

This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
').

Parameters
[in]numSpecify the target - long.
[in]baseSpecify the base.
Returns
The length of print successfully.
Note

◆ println() [9/11]

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

This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
').

Parameters
[in]numSpecify the target - unsigned long.
[in]baseSpecify the base.
Returns
The length of print successfully.
Note

◆ println() [10/11]

size_t Print::println ( double  num,
int  digits = BIN 
)

This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
').

Parameters
[in]numSpecify the target - double.
[in]digitsSpecify the digits.
Returns
The length of print successfully.
Note

◆ println() [11/11]

size_t Print::println ( const Printable x)

This function is used to print target to the interface defined by the object with carriage ret ('') and new line ('
').

Parameters
[in]xSpecify the target - Printable.
Returns
The length of print successfully.
Note

◆ write() [1/4]

virtual size_t Print::write ( uint8_t  )
pure virtual

This pure virtual function is used to define the operation that writes binary data.

Parameters
[in]vala value to send as a single byte
Returns
The length of write successfully (1 byte).
Note

Implemented in WiFiUDP, HardwareSerial, WiFiServer, WiFiClient, UDP, TwoWire, and Client.

◆ write() [2/4]

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

This function is used to write buffer to the interface defined by the object.

Parameters
[in]bufferSpecify the buffer.
[in]sizeSpecify the size.
Returns
The length of write successfully.
Note
Parameters
[in]bufferSpecify the buffer.
[in]sizeSpecify the size.
Returns
The length of write successfully (1 byte).
Note

Reimplemented in WiFiUDP, WiFiClient, WiFiServer, UDP, Client, and TwoWire.

◆ write() [3/4]

size_t Print::write ( const char *  str)
inline

This function is used to write buffer to the interface defined by the object.

Parameters
[in]strSpecify the buffer of string.
Returns
The length of write successfully.
Note

◆ write() [4/4]

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

This function is used to write buffer to the interface defined by the object.

Parameters
[in]bufferSpecify the buffer of string.
[in]sizeSpecify the size.
Returns
The length of write successfully.
Note
Generated by   doxygen 1.8.14