Commander-API  V2.0.0
Commander-API is a C++ API, that parses character based commands.
commandResponse Class Reference

Default response class. More...

#include <Commander-IO.hpp>

Public Member Functions

virtual int available ()
 
virtual int read ()
 
virtual int peek ()
 
virtual size_t readBytes (uint8_t *buff, uint32_t size)
 
virtual void flush ()
 
virtual size_t write (uint8_t b)
 
virtual size_t print (char c)
 
virtual size_t print (char *str)
 
virtual size_t print (const char *str)
 
virtual size_t print (int8_t b)
 
virtual size_t print (uint8_t b)
 
virtual size_t print (int16_t b)
 
virtual size_t print (uint16_t b)
 
virtual size_t print (int32_t b)
 
virtual size_t print (uint32_t b)
 
virtual size_t print (float f)
 
virtual size_t print (double f)
 
virtual size_t println ()
 
virtual size_t println (char c)
 
virtual size_t println (char *str)
 
virtual size_t println (const char *str)
 
virtual size_t println (int8_t b)
 
virtual size_t println (uint8_t b)
 
virtual size_t println (int16_t b)
 
virtual size_t println (uint16_t b)
 
virtual size_t println (int32_t b)
 
virtual size_t println (uint32_t b)
 
virtual size_t println (float f)
 
virtual size_t println (double f)
 
virtual int printf (const char *fmt,...)
 

Detailed Description

Default response class.

This base class is responsible to create a communication channel between the function associated with a command and the sender entity. This entity can be anything like Serial, Client... Because every function in this class is virtual, it means that they can be overridden with subclasses. It is useful, because if we make a subclass for every entity that can communicate with Commander, we can automatically pair the right function for that entity. The base class doesn't do much. To make it any use, we have to create a subclass for it like below.

Member Function Documentation

◆ available()

virtual int commandResponse::available ( )
inlinevirtual

◆ flush()

virtual void commandResponse::flush ( )
inlinevirtual

◆ peek()

virtual int commandResponse::peek ( )
inlinevirtual

◆ print() [1/11]

virtual size_t commandResponse::print ( char *  str)
inlinevirtual

◆ print() [2/11]

virtual size_t commandResponse::print ( char  c)
inlinevirtual

◆ print() [3/11]

virtual size_t commandResponse::print ( const char *  str)
inlinevirtual

◆ print() [4/11]

virtual size_t commandResponse::print ( double  f)
inlinevirtual

◆ print() [5/11]

virtual size_t commandResponse::print ( float  f)
inlinevirtual

◆ print() [6/11]

virtual size_t commandResponse::print ( int16_t  b)
inlinevirtual

◆ print() [7/11]

virtual size_t commandResponse::print ( int32_t  b)
inlinevirtual

◆ print() [8/11]

virtual size_t commandResponse::print ( int8_t  b)
inlinevirtual

◆ print() [9/11]

virtual size_t commandResponse::print ( uint16_t  b)
inlinevirtual

◆ print() [10/11]

virtual size_t commandResponse::print ( uint32_t  b)
inlinevirtual

◆ print() [11/11]

virtual size_t commandResponse::print ( uint8_t  b)
inlinevirtual

◆ printf()

virtual int commandResponse::printf ( const char *  fmt,
  ... 
)
inlinevirtual

◆ println() [1/12]

virtual size_t commandResponse::println ( )
inlinevirtual

◆ println() [2/12]

virtual size_t commandResponse::println ( char *  str)
inlinevirtual

◆ println() [3/12]

virtual size_t commandResponse::println ( char  c)
inlinevirtual

◆ println() [4/12]

virtual size_t commandResponse::println ( const char *  str)
inlinevirtual

◆ println() [5/12]

virtual size_t commandResponse::println ( double  f)
inlinevirtual

◆ println() [6/12]

virtual size_t commandResponse::println ( float  f)
inlinevirtual

◆ println() [7/12]

virtual size_t commandResponse::println ( int16_t  b)
inlinevirtual

◆ println() [8/12]

virtual size_t commandResponse::println ( int32_t  b)
inlinevirtual

◆ println() [9/12]

virtual size_t commandResponse::println ( int8_t  b)
inlinevirtual

◆ println() [10/12]

virtual size_t commandResponse::println ( uint16_t  b)
inlinevirtual

◆ println() [11/12]

virtual size_t commandResponse::println ( uint32_t  b)
inlinevirtual

◆ println() [12/12]

virtual size_t commandResponse::println ( uint8_t  b)
inlinevirtual

◆ read()

virtual int commandResponse::read ( )
inlinevirtual

◆ readBytes()

virtual size_t commandResponse::readBytes ( uint8_t *  buff,
uint32_t  size 
)
inlinevirtual

◆ write()

virtual size_t commandResponse::write ( uint8_t  b)
inlinevirtual