JawaCommanderBase Class Reference

#include <core/JawaCommander.h>

Inheritance diagram for JawaCommanderBase:

Public Member Functions
	JawaCommanderBase ()
bool	parseCommand (const char *inputStr)
	Parse the specified command string. More...
void	process (const char ch)
	Append a single character to the parsers input buffer. More...
void	process (const char *msg)
	Append a string of character to the parsers input buffer. More...
char *	getBuffer ()
	Return a direct pointer to the parsers input buffer. More...
size_t	getBufferSize ()
	Return the maximum size of the input buffer. More...
size_t	getMessageSize ()
	Return the maximum size of the input buffer. More...

Static Public Member Functions
static JawaCommanderBase *	get ()

Static Protected Member Functions
static JawaCommanderBase **	base ()

Protected Attributes
bool	fNewLine = true
bool	fSkipEOL = false
uint8_t	fBufferSize
uint8_t	fMsgSize
char *	fBuffer
char *	fMessageBuffer
char *	fPtr

Constructor & Destructor Documentation

JawaCommanderBase()

JawaCommanderBase::JawaCommanderBase ( )

inline

Member Function Documentation

base()

static JawaCommanderBase** JawaCommanderBase::base ( )

inlinestaticprotected

get()

static JawaCommanderBase* JawaCommanderBase::get ( )

inlinestatic

getBuffer()

char* JawaCommanderBase::getBuffer ( )

inline

Return a direct pointer to the parsers input buffer.

getBufferSize()

size_t JawaCommanderBase::getBufferSize ( )

inline

Return the maximum size of the input buffer.

getMessageSize()

size_t JawaCommanderBase::getMessageSize ( )

inline

Return the maximum size of the input buffer.

parseCommand()

bool JawaCommanderBase::parseCommand ( const char *  inputStr )

inline

Parse the specified command string.

The specified string is not copied but will not be modified by the parser. Input is expected to have been sanitized and should contain no CR nor LF.

process() [1/2]

void JawaCommanderBase::process ( const char *  msg )

inline

Append a string of character to the parsers input buffer.

process() [2/2]

void JawaCommanderBase::process ( const char  ch )

inline

Append a single character to the parsers input buffer.

Member Data Documentation

fBuffer

char* JawaCommanderBase::fBuffer

protected

fBufferSize

uint8_t JawaCommanderBase::fBufferSize

protected

fMessageBuffer

char* JawaCommanderBase::fMessageBuffer

protected

fMsgSize

uint8_t JawaCommanderBase::fMsgSize

protected

fNewLine

bool JawaCommanderBase::fNewLine = true

protected

fPtr

char* JawaCommanderBase::fPtr

protected

fSkipEOL

bool JawaCommanderBase::fSkipEOL = false

protected

---

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

• core/JawaCommander.h