KiCad PCB EDA Suite
Public Member Functions | Public Attributes | Private Attributes | List of all members
DRC_CONSTRAINT Class Reference

#include <drc_rule.h>

Public Member Functions

 DRC_CONSTRAINT (DRC_CONSTRAINT_T aType=NULL_CONSTRAINT, const wxString &aName=wxEmptyString)
 
bool IsNull () const
 
const MINOPTMAX< int > & GetValue () const
 
MINOPTMAX< int > & Value ()
 
void SetParentRule (DRC_RULE *aParentRule)
 
DRC_RULE * GetParentRule () const
 
void SetName (const wxString &aName)
 
wxString GetName () const
 
SEVERITY GetSeverity () const
 

Public Attributes

DRC_CONSTRAINT_T m_Type
 
MINOPTMAX< int > m_Value
 
int m_DisallowFlags
 
ZONE_CONNECTION m_ZoneConnection
 
DRC_RULE_CONDITION * m_Test
 

Private Attributes

wxString m_name
 
DRC_RULE * m_parentRule
 

Detailed Description

Definition at line 121 of file drc_rule.h.

Constructor & Destructor Documentation

◆ DRC_CONSTRAINT()

DRC_CONSTRAINT::DRC_CONSTRAINT ( DRC_CONSTRAINT_T  aType = NULL_CONSTRAINT,
const wxString &  aName = wxEmptyString 
)
inline

Definition at line 124 of file drc_rule.h.

125 :
126 m_Type( aType ),
127 m_Value(),
128 m_DisallowFlags( 0 ),
129 m_ZoneConnection( ZONE_CONNECTION::INHERITED ),
130 m_Test( nullptr ),
131 m_name( aName ),
132 m_parentRule( nullptr )
133 {
134 }
DRC_CONSTRAINT::m_Test
DRC_RULE_CONDITION * m_Test
Definition: drc_rule.h:175
DRC_CONSTRAINT::m_DisallowFlags
int m_DisallowFlags
Definition: drc_rule.h:173
DRC_CONSTRAINT::m_parentRule
DRC_RULE * m_parentRule
Definition: drc_rule.h:179
DRC_CONSTRAINT::m_ZoneConnection
ZONE_CONNECTION m_ZoneConnection
Definition: drc_rule.h:174
DRC_CONSTRAINT::m_Value
MINOPTMAX< int > m_Value
Definition: drc_rule.h:172
DRC_CONSTRAINT::m_Type
DRC_CONSTRAINT_T m_Type
Definition: drc_rule.h:171
DRC_CONSTRAINT::m_name
wxString m_name
Definition: drc_rule.h:178

Member Function Documentation

◆ GetName()

wxString DRC_CONSTRAINT::GetName ( void  ) const
inline

Definition at line 149 of file drc_rule.h.

150 {
151 if( m_parentRule )
152 {
153 if( m_parentRule->m_Implicit )
154 return m_parentRule->m_Name;
155 else
156 return wxString::Format( _( "rule %s" ), m_parentRule->m_Name );
157 }
158
159 return m_name;
160 }
DRC_RULE::m_Implicit
bool m_Implicit
Definition: drc_rule.h:110
DRC_RULE::m_Name
wxString m_Name
Definition: drc_rule.h:112
_
#define _(s)
Definition: eda_3d_actions.cpp:33
Format
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

References _, Format(), DRC_RULE::m_Implicit, DRC_RULE::m_Name, m_name, and m_parentRule.

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCounts(), PCB_VIA::GetMinAnnulus(), BOARD_CONNECTED_ITEM::GetOwnClearance(), PAD::GetOwnClearance(), PCB_TRACK::GetWidthConstraint(), BOARD_INSPECTION_TOOL::InspectClearance(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), and ROUTER_TOOL::updateSizesAfterLayerSwitch().

◆ GetParentRule()

DRC_RULE * DRC_CONSTRAINT::GetParentRule ( ) const
inline

Definition at line 145 of file drc_rule.h.

145{ return m_parentRule; }

References m_parentRule.

Referenced by DRC_TEST_PROVIDER::accountCheck(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCounts(), DRC_ENGINE::EvalRules(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

◆ GetSeverity()

SEVERITY DRC_CONSTRAINT::GetSeverity ( ) const
inline

Definition at line 162 of file drc_rule.h.

163 {
164 if( m_parentRule )
165 return m_parentRule->m_Severity;
166 else
167 return RPT_SEVERITY_UNDEFINED;
168 }
DRC_RULE::m_Severity
SEVERITY m_Severity
Definition: drc_rule.h:117
RPT_SEVERITY_UNDEFINED
@ RPT_SEVERITY_UNDEFINED
Definition: report_severity.h:27

References m_parentRule, DRC_RULE::m_Severity, and RPT_SEVERITY_UNDEFINED.

Referenced by DRAWING_TOOL::DrawVia(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

◆ GetValue()

const MINOPTMAX< int > & DRC_CONSTRAINT::GetValue ( ) const
inline

Definition at line 141 of file drc_rule.h.

141{ return m_Value; }

References m_Value.

Referenced by ZONE_FILLER::buildCopperItemClearances(), ZONE_FILLER::buildThermalSpokes(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCounts(), DRAWING_TOOL::DrawVia(), ZONE_FILLER::fillNonCopperZone(), ZONE_FILLER::knockoutThermalReliefs(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), DRC_CACHE_GENERATOR::Run(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

◆ IsNull()

bool DRC_CONSTRAINT::IsNull ( ) const
inline

Definition at line 136 of file drc_rule.h.

137 {
138 return m_Type == NULL_CONSTRAINT;
139 }
NULL_CONSTRAINT
@ NULL_CONSTRAINT
Definition: drc_rule.h:46

References m_Type, and NULL_CONSTRAINT.

Referenced by ROUTER_TOOL::handleLayerSwitch(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), and ROUTER_TOOL::updateSizesAfterLayerSwitch().

◆ SetName()

void DRC_CONSTRAINT::SetName ( const wxString &  aName)
inline

Definition at line 147 of file drc_rule.h.

147{ m_name = aName; }

References m_name.

Referenced by DRC_ENGINE::EvalRules().

◆ SetParentRule()

void DRC_CONSTRAINT::SetParentRule ( DRC_RULE *  aParentRule)
inline

Definition at line 144 of file drc_rule.h.

144{ m_parentRule = aParentRule; }

References m_parentRule.

Referenced by DRC_RULE::AddConstraint(), and DRC_ENGINE::EvalRules().

◆ Value()

MINOPTMAX< int > & DRC_CONSTRAINT::Value ( )
inline

Definition at line 142 of file drc_rule.h.

142{ return m_Value; }

References m_Value.

Referenced by ZONE_FILLER::buildThermalSpokes(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), DRC_TEST_PROVIDER_HOLE_SIZE::checkViaHole(), BOARD_DESIGN_SETTINGS::GetBiggestClearanceValue(), PCB_VIA::GetMinAnnulus(), BOARD_CONNECTED_ITEM::GetOwnClearance(), PAD::GetOwnClearance(), PCB_TRACK::GetWidthConstraint(), DRC_ENGINE::loadImplicitRules(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), and DRC_TEST_PROVIDER_TRACK_WIDTH::Run().

Member Data Documentation

◆ m_DisallowFlags

int DRC_CONSTRAINT::m_DisallowFlags

Definition at line 173 of file drc_rule.h.

Referenced by DRAWING_TOOL::DrawVia(), DRC_ENGINE::EvalRules(), BOARD_INSPECTION_TOOL::InspectConstraints(), DRC_ENGINE::loadImplicitRules(), DRC_RULES_PARSER::parseConstraint(), and DRC_TEST_PROVIDER_DISALLOW::Run().

◆ m_name

wxString DRC_CONSTRAINT::m_name
private

Definition at line 178 of file drc_rule.h.

Referenced by GetName(), and SetName().

◆ m_parentRule

DRC_RULE* DRC_CONSTRAINT::m_parentRule
private

Definition at line 179 of file drc_rule.h.

Referenced by GetName(), GetParentRule(), GetSeverity(), and SetParentRule().

◆ m_Test

DRC_RULE_CONDITION* DRC_CONSTRAINT::m_Test

Definition at line 175 of file drc_rule.h.

Referenced by DRC_RULES_PARSER::parseConstraint().

◆ m_Type

DRC_CONSTRAINT_T DRC_CONSTRAINT::m_Type

Definition at line 171 of file drc_rule.h.

Referenced by DRC_ENGINE::compileRules(), DRC_ENGINE::EvalRules(), IsNull(), and DRC_RULES_PARSER::parseConstraint().

◆ m_Value

MINOPTMAX<int> DRC_CONSTRAINT::m_Value

Definition at line 172 of file drc_rule.h.

Referenced by DRC_ENGINE::EvalRules(), GetValue(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), DRC_RULES_PARSER::parseConstraint(), reportMax(), reportMin(), reportOpt(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), PCB_CONTROL::UpdateMessagePanel(), ROUTER_TOOL::updateSizesAfterLayerSwitch(), and Value().

◆ m_ZoneConnection

ZONE_CONNECTION DRC_CONSTRAINT::m_ZoneConnection

Definition at line 174 of file drc_rule.h.

Referenced by DRC_ENGINE::EvalRules(), DRC_ENGINE::EvalZoneConnection(), BOARD_INSPECTION_TOOL::InspectClearance(), ZONE_FILLER::knockoutThermalReliefs(), DRC_RULES_PARSER::parseConstraint(), and DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer().

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