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
 

Public Attributes

DRC_CONSTRAINT_T m_Type
 
MINOPTMAX< int > m_Value
 
int m_DisallowFlags
 

Private Attributes

wxString m_name
 
DRC_RULE * m_parentRule
 

Detailed Description

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

108  :
109  m_Type( aType ),
110  m_Value(),
111  m_DisallowFlags( 0 ),
112  m_name( aName ),
113  m_parentRule( nullptr )
114  {
115  }
DRC_CONSTRAINT::m_parentRule
DRC_RULE * m_parentRule
Definition: drc_rule.h:150
DRC_CONSTRAINT::m_Value
MINOPTMAX< int > m_Value
Definition: drc_rule.h:145
DRC_CONSTRAINT::m_name
wxString m_name
Definition: drc_rule.h:149
DRC_CONSTRAINT::m_DisallowFlags
int m_DisallowFlags
Definition: drc_rule.h:146
DRC_CONSTRAINT::m_Type
DRC_CONSTRAINT_T m_Type
Definition: drc_rule.h:144

Member Function Documentation

◆ GetName()

wxString DRC_CONSTRAINT::GetName ( void  ) const
inline

Definition at line 130 of file drc_rule.h.

131  {
132  if( m_parentRule )
133  {
134  if( m_parentRule->m_Implicit )
135  return m_parentRule->m_Name;
136  else
137  return wxString::Format( _( "rule %s" ), m_parentRule->m_Name );
138  }
139 
140  return m_name;
141  }
DRC_CONSTRAINT::m_parentRule
DRC_RULE * m_parentRule
Definition: drc_rule.h:150
DRC_RULE::m_Implicit
bool m_Implicit
Definition: drc_rule.h:95
DRC_RULE::m_Name
wxString m_Name
Definition: drc_rule.h:96
DRC_CONSTRAINT::m_name
wxString m_name
Definition: drc_rule.h:149
_
#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(), PCB_TRACK::GetWidthConstraints(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem().

◆ GetParentRule()

DRC_RULE* DRC_CONSTRAINT::GetParentRule ( ) const
inline

Definition at line 126 of file drc_rule.h.

126 { return m_parentRule; }
DRC_CONSTRAINT::m_parentRule
DRC_RULE * m_parentRule
Definition: drc_rule.h:150

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_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem().

◆ GetValue()

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

Definition at line 122 of file drc_rule.h.

122 { return m_Value; }
DRC_CONSTRAINT::m_Value
MINOPTMAX< int > m_Value
Definition: drc_rule.h:145

References m_Value.

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCounts(), DRAWING_TOOL::DrawVia(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

◆ IsNull()

bool DRC_CONSTRAINT::IsNull ( ) const
inline

Definition at line 117 of file drc_rule.h.

118  {
119  return m_Type == NULL_CONSTRAINT;
120  }
NULL_CONSTRAINT
Definition: drc_rule.h:43
DRC_CONSTRAINT::m_Type
DRC_CONSTRAINT_T m_Type
Definition: drc_rule.h:144

References m_Type, and NULL_CONSTRAINT.

Referenced by ROUTER_TOOL::handleLayerSwitch(), and PNS_PCBNEW_RULE_RESOLVER::QueryConstraint().

◆ SetName()

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

Definition at line 128 of file drc_rule.h.

128 { m_name = aName; }
DRC_CONSTRAINT::m_name
wxString m_name
Definition: drc_rule.h:149

References m_name.

◆ SetParentRule()

void DRC_CONSTRAINT::SetParentRule ( DRC_RULE *  aParentRule)
inline

Definition at line 125 of file drc_rule.h.

125 { m_parentRule = aParentRule; }
DRC_CONSTRAINT::m_parentRule
DRC_RULE * m_parentRule
Definition: drc_rule.h:150

References m_parentRule.

Referenced by DRC_RULE::AddConstraint().

◆ Value()

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

Definition at line 123 of file drc_rule.h.

123 { return m_Value; }
DRC_CONSTRAINT::m_Value
MINOPTMAX< int > m_Value
Definition: drc_rule.h:145

References m_Value.

Referenced by DRC_TEST_PROVIDER_HOLE_SIZE::checkPad(), DRC_TEST_PROVIDER_HOLE_SIZE::checkVia(), BOARD_DESIGN_SETTINGS::GetBiggestClearanceValue(), PCB_VIA::GetMinAnnulus(), BOARD_CONNECTED_ITEM::GetOwnClearance(), PCB_TRACK::GetWidthConstraints(), DRC_ENGINE::loadImplicitRules(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), and DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run().

Member Data Documentation

◆ m_DisallowFlags

int DRC_CONSTRAINT::m_DisallowFlags

Definition at line 146 of file drc_rule.h.

Referenced by DRC_ENGINE::loadImplicitRules(), and DRC_RULES_PARSER::parseConstraint().

◆ m_name

wxString DRC_CONSTRAINT::m_name
private

Definition at line 149 of file drc_rule.h.

Referenced by GetName(), and SetName().

◆ m_parentRule

DRC_RULE* DRC_CONSTRAINT::m_parentRule
private

Definition at line 150 of file drc_rule.h.

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

◆ m_Type

DRC_CONSTRAINT_T DRC_CONSTRAINT::m_Type

Definition at line 144 of file drc_rule.h.

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

◆ m_Value

MINOPTMAX<int> DRC_CONSTRAINT::m_Value

Definition at line 145 of file drc_rule.h.

Referenced by GetValue(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::InspectClearance(), DRC_RULES_PARSER::parseConstraint(), BOARD_INSPECTION_TOOL::reportClearance(), reportMax(), reportMin(), reportOpt(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), and Value().

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