KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Private Attributes | List of all members
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
 

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 118 of file drc_rule.h.

Constructor & Destructor Documentation

◆ DRC_RULE() [1/2]

DRC_RULE::DRC_RULE ( )

Definition at line 31 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 42 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 54 of file drc_rule.cpp.

References m_Condition.

Member Function Documentation

◆ AddConstraint()

void DRC_RULE::AddConstraint ( DRC_CONSTRAINT & aConstraint)

Definition at line 60 of file drc_rule.cpp.

References m_Constraints, and DRC_CONSTRAINT::SetParentRule().

Referenced by DRC_RULES_PARSER::parseConstraint().

◆ AppliesTo()

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

Definition at line 126 of file drc_rule.h.

◆ FindConstraint()

std::optional< DRC_CONSTRAINT > DRC_RULE::FindConstraint ( DRC_CONSTRAINT_T aType)

Definition at line 67 of file drc_rule.cpp.

References m_Constraints.

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

◆ GetImplicitSource()

DRC_IMPLICIT_SOURCE DRC_RULE::GetImplicitSource ( ) const
inline

Definition at line 138 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 134 of file drc_rule.h.

References m_implicitSource, and NONE.

Referenced by DRC_ENGINE::EvalRules(), 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 136 of file drc_rule.h.

References m_implicitSource.

Member Data Documentation

◆ m_Condition

DRC_RULE_CONDITION* DRC_RULE::m_Condition

Definition at line 146 of file drc_rule.h.

Referenced by DRC_RULE(), DRC_RULE(), and ~DRC_RULE().

◆ m_Constraints

std::vector<DRC_CONSTRAINT> DRC_RULE::m_Constraints

Definition at line 147 of file drc_rule.h.

Referenced by AddConstraint(), and FindConstraint().

◆ m_ImplicitItemId

KIID DRC_RULE::m_ImplicitItemId

Definition at line 142 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 151 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 145 of file drc_rule.h.

Referenced by DRC_RULE(), and DRC_RULE().

◆ m_LayerSource

wxString DRC_RULE::m_LayerSource

Definition at line 144 of file drc_rule.h.

◆ m_Name

wxString DRC_RULE::m_Name

Definition at line 143 of file drc_rule.h.

Referenced by DRC_RULE(), 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 148 of file drc_rule.h.

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

◆ m_Unary

bool DRC_RULE::m_Unary

Definition at line 141 of file drc_rule.h.

Referenced by DRC_RULE(), and DRC_RULE().

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