DRC_RULE Class Reference

#include <drc_rule.h>

Public Member Functions
	DRC_RULE ()
	DRC_RULE (const wxString &aName)
virtual	~DRC_RULE ()
virtual bool	AppliesTo (const BOARD_ITEM *a, const BOARD_ITEM *b=nullptr) const
void	AddConstraint (DRC_CONSTRAINT &aConstraint)
std::optional< DRC_CONSTRAINT >	FindConstraint (DRC_CONSTRAINT_T aType)
bool	IsImplicit () const
void	SetImplicitSource (const DRC_IMPLICIT_SOURCE aImplicitSource)
DRC_IMPLICIT_SOURCE	GetImplicitSource () const

Static Public Member Functions
static wxString	FormatRuleFromProto (const kiapi::board::CustomRule &aRule, wxString *aErrorText=nullptr)

Public Attributes
bool	m_Unary
KIID	m_ImplicitItemId
wxString	m_Name
wxString	m_LayerSource
LSET	m_LayerCondition
DRC_RULE_CONDITION *	m_Condition
std::vector< DRC_CONSTRAINT >	m_Constraints
SEVERITY	m_Severity

Private Attributes
DRC_IMPLICIT_SOURCE	m_implicitSource

Detailed Description

Definition at line 125 of file drc_rule.h.

Constructor & Destructor Documentation

DRC_RULE() [1/2]

DRC_RULE::DRC_RULE

(

)

Definition at line 34 of file drc_rule.cpp.

References m_Condition, m_ImplicitItemId, m_implicitSource, m_LayerCondition, m_Severity, m_Unary, NONE, and RPT_SEVERITY_UNDEFINED.

DRC_RULE() [2/2]

DRC_RULE::DRC_RULE

(

const wxString &

aName

)

Definition at line 45 of file drc_rule.cpp.

References m_Condition, m_ImplicitItemId, m_implicitSource, m_LayerCondition, m_Name, m_Severity, m_Unary, NONE, and RPT_SEVERITY_UNDEFINED.

~DRC_RULE()

DRC_RULE::~DRC_RULE ( )

virtual

Definition at line 57 of file drc_rule.cpp.

References m_Condition.

Member Function Documentation

AddConstraint()

void DRC_RULE::AddConstraint

(

DRC_CONSTRAINT &

aConstraint

)

Definition at line 63 of file drc_rule.cpp.

References m_Constraints, and DRC_CONSTRAINT::SetParentRule().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and DRC_RULES_PARSER::parseConstraint().

AppliesTo()

virtual bool DRC_RULE::AppliesTo ( const BOARD_ITEM * a, const BOARD_ITEM * b = nullptr ) const

inlinevirtual

Definition at line 133 of file drc_rule.h.

FindConstraint()

std::optional< DRC_CONSTRAINT > DRC_RULE::FindConstraint

(

DRC_CONSTRAINT_T

aType

)

Definition at line 70 of file drc_rule.cpp.

References m_Constraints.

Referenced by DRC_RULES_PARSER::parseConstraint(), and DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal().

FormatRuleFromProto()

wxString DRC_RULE::FormatRuleFromProto ( const kiapi::board::CustomRule & aRule, wxString * aErrorText = nullptr )

static

Definition at line 82 of file drc_rule.cpp.

References EDA_UNIT_UTILS::FormatInternalUnits(), FromProtoEnum(), BOARD::GetStandardLayerName(), pcbIUScale, text, UNDEFINED_LAYER, and UNSELECTED_LAYER.

Referenced by API_HANDLER_PCB::handleSetCustomDesignRules().

GetImplicitSource()

DRC_IMPLICIT_SOURCE DRC_RULE::GetImplicitSource ( ) const

inline

Definition at line 148 of file drc_rule.h.

References m_implicitSource.

Referenced by PNS_PCBNEW_RULE_RESOLVER::QueryConstraint().

IsImplicit()

bool DRC_RULE::IsImplicit ( ) const

inline

Definition at line 144 of file drc_rule.h.

References m_implicitSource, and NONE.

Referenced by DRC_ENGINE::EvalRules(), DRC_ENGINE::HasUserDefinedPhysicalConstraint(), DIALOG_DRC::OnDRCItemRClick(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), and DRC_TEST_PROVIDER_DISALLOW::Run().

SetImplicitSource()

void DRC_RULE::SetImplicitSource ( const DRC_IMPLICIT_SOURCE aImplicitSource )

inline

Definition at line 146 of file drc_rule.h.

References m_implicitSource.

Member Data Documentation

m_Condition

DRC_RULE_CONDITION* DRC_RULE::m_Condition

Definition at line 156 of file drc_rule.h.

Referenced by DRC_RULE_LOADER::createConstraintData(), DRC_RULE(), DRC_RULE(), DRC_RULE_LOADER::LoadRule(), DRC_PANEL_MATCHER::MatchRule(), and ~DRC_RULE().

m_Constraints

std::vector<DRC_CONSTRAINT> DRC_RULE::m_Constraints

Definition at line 157 of file drc_rule.h.

Referenced by AddConstraint(), FindConstraint(), DRC_RULE_LOADER::findConstraint(), and DRC_PANEL_MATCHER::MatchRule().

m_ImplicitItemId

KIID DRC_RULE::m_ImplicitItemId

Definition at line 152 of file drc_rule.h.

Referenced by DRC_RULE(), and DRC_RULE().

m_implicitSource

DRC_IMPLICIT_SOURCE DRC_RULE::m_implicitSource

private

Definition at line 161 of file drc_rule.h.

Referenced by DRC_RULE(), DRC_RULE(), GetImplicitSource(), IsImplicit(), and SetImplicitSource().

m_LayerCondition

LSET DRC_RULE::m_LayerCondition

Definition at line 155 of file drc_rule.h.

Referenced by DRC_RULE(), DRC_RULE(), and DRC_RULE_LOADER::LoadRule().

m_LayerSource

wxString DRC_RULE::m_LayerSource

Definition at line 154 of file drc_rule.h.

Referenced by DRC_RULE_LOADER::LoadRule().

m_Name

wxString DRC_RULE::m_Name

Definition at line 153 of file drc_rule.h.

Referenced by DRC_RULE_LOADER::createConstraintData(), DRC_RULE(), DRC_RULE_LOADER::LoadRule(), makeCustomRuleData(), DIALOG_DRC::OnDRCItemRClick(), DRC_ENGINE::ReportViolation(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), and test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run().

m_Severity

SEVERITY DRC_RULE::m_Severity

Definition at line 158 of file drc_rule.h.

Referenced by DRC_RULE(), DRC_RULE(), PCB_MARKER::GetSeverity(), and DRC_RULE_LOADER::LoadRule().

m_Unary

bool DRC_RULE::m_Unary

Definition at line 151 of file drc_rule.h.

Referenced by DRC_RULE(), and DRC_RULE().

---

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

• drc_rule.h
• drc_rule.cpp