KiCad PCB EDA Suite
EDA_PATTERN_MATCH Class Referenceabstract

#include <eda_pattern_match.h>

Inheritance diagram for EDA_PATTERN_MATCH:
EDA_PATTERN_MATCH_REGEX EDA_PATTERN_MATCH_RELATIONAL EDA_PATTERN_MATCH_SUBSTR EDA_PATTERN_MATCH_WILDCARD EDA_PATTERN_MATCH_WILDCARD_EXPLICIT

Classes

struct  FIND_RESULT
 

Public Member Functions

virtual ~EDA_PATTERN_MATCH ()
 
virtual bool SetPattern (const wxString &aPattern)=0
 Set the pattern against which candidates will be matched. More...
 
virtual wxString const & GetPattern () const =0
 Return the pattern passed to SetPattern(). More...
 
virtual FIND_RESULT Find (const wxString &aCandidate) const =0
 Return the location and possibly length of a match iff a given candidate string matches the set pattern. More...
 

Detailed Description

Definition at line 43 of file eda_pattern_match.h.

Constructor & Destructor Documentation

◆ ~EDA_PATTERN_MATCH()

virtual EDA_PATTERN_MATCH::~EDA_PATTERN_MATCH ( )
inlinevirtual

Definition at line 62 of file eda_pattern_match.h.

62 {}

Member Function Documentation

◆ Find()

virtual FIND_RESULT EDA_PATTERN_MATCH::Find ( const wxString &  aCandidate) const
pure virtual

Return the location and possibly length of a match iff a given candidate string matches the set pattern.

Otherwise, return an invalid FIND_RESULT.

Implemented in EDA_PATTERN_MATCH_RELATIONAL, EDA_PATTERN_MATCH_WILDCARD, EDA_PATTERN_MATCH_REGEX, and EDA_PATTERN_MATCH_SUBSTR.

◆ GetPattern()

virtual wxString const& EDA_PATTERN_MATCH::GetPattern ( ) const
pure virtual

◆ SetPattern()

virtual bool EDA_PATTERN_MATCH::SetPattern ( const wxString &  aPattern)
pure virtual

Set the pattern against which candidates will be matched.

If the pattern can not be processed, returns false.

Implemented in EDA_PATTERN_MATCH_RELATIONAL, EDA_PATTERN_MATCH_WILDCARD_EXPLICIT, EDA_PATTERN_MATCH_WILDCARD, EDA_PATTERN_MATCH_REGEX, and EDA_PATTERN_MATCH_SUBSTR.


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