Firmware for Arduino | PLEN Project Company Inc.
Utility::AbstractParser Class Referenceabstract

Abstract parser interface. More...

#include <Parser.h>

Inheritance diagram for Utility::AbstractParser:
Utility::CharGroupParser Utility::HexStringParser Utility::NilParser Utility::StringGroupParser

Public Member Functions

virtual ~AbstractParser ()
 Destructor. More...
 
virtual bool parse (const char *input)=0
 Parser function interface. More...
 
virtual const int8_t & index ()
 Get matched index of after parsing. More...
 

Protected Member Functions

 AbstractParser ()
 Constructor. More...
 

Protected Attributes

int8_t m_index
 

Detailed Description

Abstract parser interface.

Constructor & Destructor Documentation

Utility::AbstractParser::AbstractParser ( )
protected

Constructor.

The method is protected to disable instantiation.

virtual Utility::AbstractParser::~AbstractParser ( )
virtual

Destructor.

Member Function Documentation

virtual const int8_t& Utility::AbstractParser::index ( )
virtual

Get matched index of after parsing.

Returns
Matched index
Return values
!-1Matched. (The value is the index selected from the condition given when instantiating the class.)
-1Parsing failed, so there is no matched index.
virtual bool Utility::AbstractParser::parse ( const char *  input)
pure virtual

Parser function interface.

Parameters
[in]inputString you want to parse.
Returns
Result

Implemented in Utility::HexStringParser, Utility::StringGroupParser, Utility::CharGroupParser, and Utility::NilParser.

Member Data Documentation

int8_t Utility::AbstractParser::m_index
protected

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