|
KiCad PCB EDA Suite
|
#include <drc_re_numeric_constraint_types.h>
Public Member Functions | |
| BITMAPS | GetOverlayBitmap () const override |
| Returns the bitmap to use for the overlay panel background. | |
| std::vector< DRC_RE_FIELD_POSITION > | GetFieldPositions () const override |
| Returns the field positions for controls overlaid on the constraint bitmap. | |
| DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA ()=default | |
| DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA (const DRC_RE_BASE_CONSTRAINT_DATA &aBaseData) | |
| DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA (int aId, int aParentId, double aNumericInputValue, wxString aRuleName) | |
| std::vector< wxString > | GetConstraintClauses (const RULE_GENERATION_CONTEXT &aContext) const override |
| Returns just the constraint clauses without the rule wrapper. | |
| wxString | GenerateRule (const RULE_GENERATION_CONTEXT &aContext) override |
| double | GetNumericInputValue () |
| void | SetNumericInputValue (double aNumericInput) |
| VALIDATION_RESULT | Validate () const override |
| Validates the constraint data. | |
| void | CopyFrom (const ICopyable &aSource) override |
| std::vector< PCB_LAYER_ID > | GetLayers () |
| void | SetLayers (std::vector< PCB_LAYER_ID > aLayers) |
| wxString | GetLayerSource () |
| void | SetLayerSource (wxString aSource) |
| wxString | GetRuleCondition () |
| void | SetRuleCondition (wxString aRuleCondition) |
| wxString | GetConstraintCode () const |
| void | SetConstraintCode (wxString aCode) |
| wxString | GetGeneratedRule () const |
| void | SetGeneratedRule (const wxString &aRule) |
| wxString | GetOriginalRuleText () const |
| void | SetOriginalRuleText (const wxString &aText) |
| bool | WasEdited () const |
| void | SetWasEdited (bool aEdited) |
| SEVERITY | GetSeverity () const |
| void | SetSeverity (SEVERITY aSeverity) |
| int | GetId () |
| Get the unique ID of the rule. | |
| void | SetId (int aId) |
| Set the unique ID of the rule. | |
| int | GetParentId () |
| Get the parent ID of the rule. | |
| void | SetParentId (int aParentId) |
| Set the parent ID of the rule. | |
| wxString | GetRuleName () |
| Get the name of the rule. | |
| void | SetRuleName (wxString aRuleName) |
| Set the name of the rule. | |
| wxString | GetComment () |
| Get the comment associated with the rule. | |
| void | SetComment (wxString aComment) |
| Set the comment for the rule. | |
| bool | IsNew () |
| Check if the rule is marked as new. | |
| void | SetIsNew (bool aIsNew) |
| Mark the rule as new or not. | |
Static Public Member Functions | |
| static wxString | sanitizeRuleName (const wxString &aRuleName) |
| Sanitize a rule name for use in S-expression output. | |
Protected Member Functions | |
| wxString | buildRule (const RULE_GENERATION_CONTEXT &aContext, const std::vector< wxString > &aConstraintClauses) const |
Static Protected Member Functions | |
| static wxString | quoteString (const wxString &aCondition) |
| static wxString | trimTrailingZeros (const wxString &aValue) |
| static wxString | formatDouble (double aValue, int aPrecision=6) |
Private Attributes | |
| double | m_numericInputValue { 0 } |
| std::vector< PCB_LAYER_ID > | m_layers |
| wxString | m_layerSource |
| Original layer text: "inner", "outer", or layer name. | |
| wxString | m_ruleCondition |
| wxString | m_constraintCode |
| wxString | m_generatedRule |
| wxString | m_originalRuleText |
| bool | m_wasEdited = false |
| SEVERITY | m_severity = RPT_SEVERITY_UNDEFINED |
| int | m_id |
| std::optional< int > | m_parentId |
| wxString | m_ruleName |
| wxString | m_comment |
| bool | m_isNew |
| Flag indicating if the user is creating a new rule (true) or editing an existing rule (false). | |
Definition at line 179 of file drc_re_numeric_constraint_types.h.
|
inlineprotectedinherited |
Definition at line 197 of file drc_re_base_constraint_data.h.
References RULE_GENERATION_CONTEXT::comment, RULE_GENERATION_CONTEXT::conditionExpression, RULE_GENERATION_CONTEXT::layerClause, quoteString(), RULE_GENERATION_CONTEXT::ruleName, and sanitizeRuleName().
Referenced by DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA::GenerateRule(), DRC_RE_ALLOWED_ORIENTATION_CONSTRAINT_DATA::GenerateRule(), DRC_RE_BOOL_INPUT_CONSTRAINT_DATA::GenerateRule(), DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA::GenerateRule(), DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA::GenerateRule(), DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA::GenerateRule(), DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA::GenerateRule(), and DRC_RE_VIA_STYLE_CONSTRAINT_DATA::GenerateRule().
|
inlineoverridevirtualinherited |
Reimplemented from DRC_RE_BASE_CONSTRAINT_DATA.
Definition at line 99 of file drc_re_numeric_input_constraint_data.h.
References DRC_RE_BASE_CONSTRAINT_DATA::CopyFrom(), DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA(), and m_numericInputValue.
|
default |
|
inlineexplicit |
Definition at line 35 of file drc_re_numeric_input_constraint_data.h.
|
inlineexplicit |
Definition at line 40 of file drc_re_numeric_input_constraint_data.h.
|
inlinestaticprotectedinherited |
Definition at line 191 of file drc_re_base_constraint_data.h.
References trimTrailingZeros().
Referenced by DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA::GetConstraintClauses(), DRC_RE_MATCHED_LENGTH_DIFF_PAIR_CONSTRAINT_DATA::GetConstraintClauses(), DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA::GetConstraintClauses(), DRC_RE_ROUTING_DIFF_PAIR_CONSTRAINT_DATA::GetConstraintClauses(), DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA::GetConstraintClauses(), and DRC_RE_VIA_STYLE_CONSTRAINT_DATA::GetConstraintClauses().
|
inlineoverridevirtualinherited |
Reimplemented from DRC_RE_BASE_CONSTRAINT_DATA.
Definition at line 80 of file drc_re_numeric_input_constraint_data.h.
References DRC_RE_BASE_CONSTRAINT_DATA::buildRule(), and GetConstraintClauses().
|
inlineinherited |
Get the comment associated with the rule.
Definition at line 104 of file rule_editor_data_base.h.
References m_comment.
Referenced by DRC_RULE_SAVER::generateRuleText().
|
inlineoverridevirtualinherited |
Returns just the constraint clauses without the rule wrapper.
Used for merging multiple constraint panels into a single rule.
Reimplemented from DRC_RE_BASE_CONSTRAINT_DATA.
Definition at line 53 of file drc_re_numeric_input_constraint_data.h.
References DRC_RE_BASE_CONSTRAINT_DATA::formatDouble(), DRC_RE_BASE_CONSTRAINT_DATA::GetConstraintCode(), and m_numericInputValue.
Referenced by GenerateRule().
|
inlineinherited |
Definition at line 98 of file drc_re_base_constraint_data.h.
References m_constraintCode.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DRC_RULE_SAVER::generateRuleText(), DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA::GetConstraintClauses(), DRC_RE_BOOL_INPUT_CONSTRAINT_DATA::GetConstraintClauses(), DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA::GetConstraintClauses(), and DRC_RE_ROUTING_WIDTH_CONSTRAINT_DATA::GetConstraintClauses().
|
inlineoverridevirtual |
Returns the field positions for controls overlaid on the constraint bitmap.
Override in derived classes to specify where input fields should be placed. Each position includes X range, Y coordinate, and tab order for navigation.
Reimplemented from DRC_RE_BASE_CONSTRAINT_DATA.
Definition at line 184 of file drc_re_numeric_constraint_types.h.
References RIGHT.
|
inlineinherited |
Definition at line 102 of file drc_re_base_constraint_data.h.
References m_generatedRule.
Referenced by DRC_RULE_SAVER::generateRuleText().
|
inlineinherited |
Get the unique ID of the rule.
Definition at line 62 of file rule_editor_data_base.h.
References m_id.
Referenced by DIALOG_DRC_RULE_EDITOR::buildRuleTreeNode(), and DIALOG_DRC_RULE_EDITOR::LoadExistingRules().
|
inlineinherited |
Definition at line 86 of file drc_re_base_constraint_data.h.
References m_layers.
|
inlineinherited |
Definition at line 90 of file drc_re_base_constraint_data.h.
References m_layerSource.
|
inlineinherited |
Definition at line 85 of file drc_re_numeric_input_constraint_data.h.
References m_numericInputValue.
|
inlineinherited |
Definition at line 106 of file drc_re_base_constraint_data.h.
References m_originalRuleText.
|
inlineoverridevirtual |
Returns the bitmap to use for the overlay panel background.
Override in derived classes to provide constraint-specific artwork.
Reimplemented from DRC_RE_BASE_CONSTRAINT_DATA.
Definition at line 183 of file drc_re_numeric_constraint_types.h.
References constraint_minimum_connection_width.
|
inlineinherited |
Get the parent ID of the rule.
Definition at line 76 of file rule_editor_data_base.h.
References m_parentId.
Referenced by RULE_EDITOR_DIALOG_BASE::AppendNewRuleTreeItem().
|
inlineinherited |
Definition at line 94 of file drc_re_base_constraint_data.h.
References m_ruleCondition.
Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().
|
inlineinherited |
Get the name of the rule.
Definition at line 90 of file rule_editor_data_base.h.
References m_ruleName.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and DIALOG_DRC_RULE_EDITOR::UpdateRuleTypeTreeItemData().
|
inlineinherited |
Definition at line 114 of file drc_re_base_constraint_data.h.
References m_severity.
|
inlineinherited |
Check if the rule is marked as new.
Definition at line 118 of file rule_editor_data_base.h.
References m_isNew.
Referenced by DIALOG_DRC_RULE_EDITOR::RemoveRule().
|
inlinestaticprotectedinherited |
Definition at line 170 of file drc_re_base_constraint_data.h.
References CTX_QUOTED_STR, and EscapeString().
Referenced by buildRule().
|
inlinestaticinherited |
Sanitize a rule name for use in S-expression output.
Replaces spaces and invalid characters with underscores.
Definition at line 138 of file drc_re_base_constraint_data.h.
References result.
Referenced by buildRule(), and DRC_RULE_SAVER::generateMergedRuleText().
|
inlineinherited |
Set the comment for the rule.
| aComment | The comment to set. |
Definition at line 111 of file rule_editor_data_base.h.
References m_comment.
|
inlineinherited |
Definition at line 100 of file drc_re_base_constraint_data.h.
References m_constraintCode.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and DRC_RULE_EDITOR_UTILS::ConstraintFromKicadDrc().
|
inlineinherited |
Definition at line 104 of file drc_re_base_constraint_data.h.
References m_generatedRule.
|
inlineinherited |
Set the unique ID of the rule.
| aId | The unique ID to set. |
Definition at line 69 of file rule_editor_data_base.h.
References m_id.
Referenced by DIALOG_DRC_RULE_EDITOR::buildRuleTreeNodeData().
|
inlineinherited |
Mark the rule as new or not.
| aIsNew | True to mark the rule as new, false to mark it as existing. |
Definition at line 125 of file rule_editor_data_base.h.
References m_isNew.
Referenced by DIALOG_DRC_RULE_EDITOR::buildRuleTreeNode(), and DIALOG_DRC_RULE_EDITOR::UpdateRuleTypeTreeItemData().
|
inlineinherited |
Definition at line 88 of file drc_re_base_constraint_data.h.
References m_layers.
|
inlineinherited |
Definition at line 92 of file drc_re_base_constraint_data.h.
References m_layerSource.
|
inlineinherited |
Definition at line 87 of file drc_re_numeric_input_constraint_data.h.
References m_numericInputValue.
|
inlineinherited |
Definition at line 108 of file drc_re_base_constraint_data.h.
References m_originalRuleText.
|
inlineinherited |
Set the parent ID of the rule.
| aParentId | The parent ID to set. |
Definition at line 83 of file rule_editor_data_base.h.
References m_parentId.
Referenced by DIALOG_DRC_RULE_EDITOR::buildRuleTreeNodeData().
|
inlineinherited |
Definition at line 96 of file drc_re_base_constraint_data.h.
References m_ruleCondition.
Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().
|
inlineinherited |
Set the name of the rule.
| aRuleName | The name of the rule to set. |
Definition at line 97 of file rule_editor_data_base.h.
References m_ruleName.
|
inlineinherited |
Definition at line 116 of file drc_re_base_constraint_data.h.
References m_severity.
|
inlineinherited |
Definition at line 112 of file drc_re_base_constraint_data.h.
References m_wasEdited.
|
inlinestaticprotectedinherited |
Definition at line 175 of file drc_re_base_constraint_data.h.
References result.
Referenced by formatDouble().
|
inlineoverridevirtualinherited |
Validates the constraint data.
Override in derived classes to add constraint-specific validation.
Reimplemented from DRC_RE_BASE_CONSTRAINT_DATA.
Definition at line 89 of file drc_re_numeric_input_constraint_data.h.
References _, m_numericInputValue, and result.
Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().
|
inlineinherited |
Definition at line 110 of file drc_re_base_constraint_data.h.
References m_wasEdited.
|
privateinherited |
Definition at line 143 of file rule_editor_data_base.h.
Referenced by CopyFrom(), GetComment(), and SetComment().
|
privateinherited |
Definition at line 239 of file drc_re_base_constraint_data.h.
Referenced by CopyFrom(), GetConstraintCode(), and SetConstraintCode().
|
privateinherited |
Definition at line 240 of file drc_re_base_constraint_data.h.
Referenced by CopyFrom(), GetGeneratedRule(), and SetGeneratedRule().
|
privateinherited |
Definition at line 140 of file rule_editor_data_base.h.
Referenced by GetId(), RULE_EDITOR_DATA_BASE(), and SetId().
|
privateinherited |
Flag indicating if the user is creating a new rule (true) or editing an existing rule (false).
Definition at line 144 of file rule_editor_data_base.h.
Referenced by IsNew(), RULE_EDITOR_DATA_BASE(), and SetIsNew().
|
privateinherited |
Definition at line 236 of file drc_re_base_constraint_data.h.
Referenced by CopyFrom(), GetLayers(), and SetLayers().
|
privateinherited |
Original layer text: "inner", "outer", or layer name.
Definition at line 237 of file drc_re_base_constraint_data.h.
Referenced by CopyFrom(), GetLayerSource(), and SetLayerSource().
|
privateinherited |
Definition at line 109 of file drc_re_numeric_input_constraint_data.h.
Referenced by CopyFrom(), DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA(), GetConstraintClauses(), GetNumericInputValue(), SetNumericInputValue(), and Validate().
|
privateinherited |
Definition at line 241 of file drc_re_base_constraint_data.h.
Referenced by CopyFrom(), GetOriginalRuleText(), and SetOriginalRuleText().
|
privateinherited |
Definition at line 141 of file rule_editor_data_base.h.
Referenced by GetParentId(), RULE_EDITOR_DATA_BASE(), and SetParentId().
|
privateinherited |
Definition at line 238 of file drc_re_base_constraint_data.h.
Referenced by CopyFrom(), GetRuleCondition(), and SetRuleCondition().
|
privateinherited |
Definition at line 142 of file rule_editor_data_base.h.
Referenced by GetRuleName(), RULE_EDITOR_DATA_BASE(), and SetRuleName().
|
privateinherited |
Definition at line 243 of file drc_re_base_constraint_data.h.
Referenced by CopyFrom(), GetSeverity(), and SetSeverity().
|
privateinherited |
Definition at line 242 of file drc_re_base_constraint_data.h.
Referenced by CopyFrom(), SetWasEdited(), and WasEdited().