KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
DRC_RULE_EDITOR_CONTENT_PANEL_BASE Class Referenceabstract

#include <drc_re_content_panel_base.h>

Inheritance diagram for DRC_RULE_EDITOR_CONTENT_PANEL_BASE:
DRC_RE_ABSOLUTE_LENGTH_TWO_PANEL DRC_RE_ALLOWED_ORIENTATION_PANEL DRC_RE_BOOL_INPUT_PANEL DRC_RE_CUSTOM_RULE_PANEL DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_PANEL DRC_RE_NUMERIC_INPUT_PANEL DRC_RE_PERMITTED_LAYERS_PANEL DRC_RE_ROUTING_DIFF_PAIR_PANEL DRC_RE_ROUTING_WIDTH_PANEL DRC_RE_VIA_STYLE_PANEL PANEL_DRC_RULE_EDITOR

Public Member Functions

 DRC_RULE_EDITOR_CONTENT_PANEL_BASE ()=default
 
virtual ~DRC_RULE_EDITOR_CONTENT_PANEL_BASE ()=default
 
virtual bool ValidateInputs (int *aErrorCount, std::string *aValidationMessage)=0
 
virtual wxString GenerateRule (const RULE_GENERATION_CONTEXT &aContext)=0
 
wxStaticBitmap * GetConstraintImage (wxPanel *aParent, BITMAPS aBitMap)
 

Protected Member Functions

wxString buildRule (const RULE_GENERATION_CONTEXT &aContext, const std::vector< wxString > &aConstraintClauses) const
 

Static Protected Member Functions

static wxString sanitizeRuleName (const wxString &aRuleName)
 
static wxString escapeCondition (const wxString &aCondition)
 
static wxString trimTrailingZeros (const wxString &aValue)
 
static wxString formatDouble (double aValue, int aPrecision=6)
 

Detailed Description

Definition at line 50 of file drc_re_content_panel_base.h.

Constructor & Destructor Documentation

◆ DRC_RULE_EDITOR_CONTENT_PANEL_BASE()

DRC_RULE_EDITOR_CONTENT_PANEL_BASE::DRC_RULE_EDITOR_CONTENT_PANEL_BASE ( )
default

◆ ~DRC_RULE_EDITOR_CONTENT_PANEL_BASE()

virtual DRC_RULE_EDITOR_CONTENT_PANEL_BASE::~DRC_RULE_EDITOR_CONTENT_PANEL_BASE ( )
virtualdefault

Member Function Documentation

◆ buildRule()

wxString DRC_RULE_EDITOR_CONTENT_PANEL_BASE::buildRule ( const RULE_GENERATION_CONTEXT & aContext,
const std::vector< wxString > & aConstraintClauses ) const
inlineprotected

Definition at line 126 of file drc_re_content_panel_base.h.

References RULE_GENERATION_CONTEXT::comment, RULE_GENERATION_CONTEXT::conditionExpression, escapeCondition(), RULE_GENERATION_CONTEXT::layerClause, RULE_GENERATION_CONTEXT::ruleName, and sanitizeRuleName().

Referenced by DRC_RE_ALLOWED_ORIENTATION_PANEL::GenerateRule(), DRC_RE_BOOL_INPUT_PANEL::GenerateRule(), DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_PANEL::GenerateRule(), DRC_RE_NUMERIC_INPUT_PANEL::GenerateRule(), DRC_RE_PERMITTED_LAYERS_PANEL::GenerateRule(), and DRC_RE_ROUTING_DIFF_PAIR_PANEL::GenerateRule().

◆ escapeCondition()

static wxString DRC_RULE_EDITOR_CONTENT_PANEL_BASE::escapeCondition ( const wxString & aCondition)
inlinestaticprotected

Definition at line 99 of file drc_re_content_panel_base.h.

References CTX_QUOTED_STR, and EscapeString().

Referenced by buildRule().

◆ formatDouble()

static wxString DRC_RULE_EDITOR_CONTENT_PANEL_BASE::formatDouble ( double aValue,
int aPrecision = 6 )
inlinestaticprotected

Definition at line 120 of file drc_re_content_panel_base.h.

References trimTrailingZeros().

Referenced by DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_PANEL::GenerateRule(), DRC_RE_NUMERIC_INPUT_PANEL::GenerateRule(), and DRC_RE_ROUTING_DIFF_PAIR_PANEL::GenerateRule().

◆ GenerateRule()

virtual wxString DRC_RULE_EDITOR_CONTENT_PANEL_BASE::GenerateRule ( const RULE_GENERATION_CONTEXT & aContext)
pure virtual

Implemented in DRC_RE_ABSOLUTE_LENGTH_TWO_PANEL, DRC_RE_ALLOWED_ORIENTATION_PANEL, DRC_RE_BOOL_INPUT_PANEL, DRC_RE_CUSTOM_RULE_PANEL, DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_PANEL, DRC_RE_NUMERIC_INPUT_PANEL, DRC_RE_PERMITTED_LAYERS_PANEL, DRC_RE_ROUTING_DIFF_PAIR_PANEL, DRC_RE_ROUTING_WIDTH_PANEL, DRC_RE_VIA_STYLE_PANEL, and PANEL_DRC_RULE_EDITOR.

◆ GetConstraintImage()

wxStaticBitmap * DRC_RULE_EDITOR_CONTENT_PANEL_BASE::GetConstraintImage ( wxPanel * aParent,
BITMAPS aBitMap )
inline

Definition at line 61 of file drc_re_content_panel_base.h.

References KiBitmapBundle().

Referenced by DRC_RE_ABSOLUTE_LENGTH_TWO_PANEL::DRC_RE_ABSOLUTE_LENGTH_TWO_PANEL(), DRC_RE_ALLOWED_ORIENTATION_PANEL::DRC_RE_ALLOWED_ORIENTATION_PANEL(), DRC_RE_BOOL_INPUT_PANEL::DRC_RE_BOOL_INPUT_PANEL(), DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_PANEL::DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_PANEL(), DRC_RE_NUMERIC_INPUT_PANEL::DRC_RE_NUMERIC_INPUT_PANEL(), DRC_RE_PERMITTED_LAYERS_PANEL::DRC_RE_PERMITTED_LAYERS_PANEL(), DRC_RE_ROUTING_DIFF_PAIR_PANEL::DRC_RE_ROUTING_DIFF_PAIR_PANEL(), DRC_RE_ROUTING_WIDTH_PANEL::DRC_RE_ROUTING_WIDTH_PANEL(), and DRC_RE_VIA_STYLE_PANEL::DRC_RE_VIA_STYLE_PANEL().

◆ sanitizeRuleName()

static wxString DRC_RULE_EDITOR_CONTENT_PANEL_BASE::sanitizeRuleName ( const wxString & aRuleName)
inlinestaticprotected

Definition at line 68 of file drc_re_content_panel_base.h.

References result.

Referenced by buildRule().

◆ trimTrailingZeros()

static wxString DRC_RULE_EDITOR_CONTENT_PANEL_BASE::trimTrailingZeros ( const wxString & aValue)
inlinestaticprotected

Definition at line 104 of file drc_re_content_panel_base.h.

References result.

Referenced by formatDouble().

◆ ValidateInputs()

virtual bool DRC_RULE_EDITOR_CONTENT_PANEL_BASE::ValidateInputs ( int * aErrorCount,
std::string * aValidationMessage )
pure virtual

Implemented in DRC_RE_ABSOLUTE_LENGTH_TWO_PANEL, DRC_RE_ALLOWED_ORIENTATION_PANEL, DRC_RE_BOOL_INPUT_PANEL, DRC_RE_CUSTOM_RULE_PANEL, DRC_RE_MINIMUM_TEXT_HEIGHT_THICKNESS_PANEL, DRC_RE_NUMERIC_INPUT_PANEL, DRC_RE_PERMITTED_LAYERS_PANEL, DRC_RE_ROUTING_DIFF_PAIR_PANEL, DRC_RE_ROUTING_WIDTH_PANEL, DRC_RE_VIA_STYLE_PANEL, and PANEL_DRC_RULE_EDITOR.

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