DRC_CONSTRAINT Class Reference

#include <drc_rule.h>

Public Types
enum class	OPTIONS : std::size_t { SKEW_WITHIN_DIFF_PAIRS = 0 , SPACE_DOMAIN , TIME_DOMAIN , NUM_OPTIONS }

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
void	SetOption (OPTIONS option)
void	ClearOption (OPTIONS option)
bool	GetOption (OPTIONS option) const
void	SetOptionsFromOther (const DRC_CONSTRAINT &aOther)
void	ToProto (kiapi::board::CustomRuleConstraint &aProto) const

Public Attributes
DRC_CONSTRAINT_T	m_Type
MINOPTMAX< int >	m_Value
int	m_DisallowFlags
ZONE_CONNECTION	m_ZoneConnection
DRC_RULE_CONDITION *	m_Test
bool	m_ImplicitMin

Private Attributes
wxString	m_name
DRC_RULE *	m_parentRule
std::bitset< static_cast< int >(OPTIONS::NUM_OPTIONS)>	m_options

Detailed Description

Definition at line 165 of file drc_rule.h.

Member Enumeration Documentation

OPTIONS

enum class DRC_CONSTRAINT::OPTIONS : std::size_t

strong

Enumerator
SKEW_WITHIN_DIFF_PAIRS
SPACE_DOMAIN
TIME_DOMAIN
NUM_OPTIONS

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

References INHERITED, m_DisallowFlags, m_ImplicitMin, m_name, m_parentRule, m_Test, m_Type, m_Value, m_ZoneConnection, and NULL_CONSTRAINT.

Referenced by SetOptionsFromOther().

Member Function Documentation

ClearOption()

void DRC_CONSTRAINT::ClearOption ( OPTIONS option )

inline

Definition at line 227 of file drc_rule.h.

References m_options.

Referenced by DRC_RULES_PARSER::parseConstraint().

GetName()

wxString DRC_CONSTRAINT::GetName ( ) const

inline

Definition at line 204 of file drc_rule.h.

References _, 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(), DRC_ENGINE::GetCachedOwnClearance(), PCB_VIA::GetDrillConstraint(), PCB_VIA::GetMinAnnulus(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), PCB_TRACK::GetWidthConstraint(), PCB_VIA::GetWidthConstraint(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_CREEPAGE::testCreepage(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), PCB_CONTROL::UpdateMessagePanel(), and ROUTER_TOOL::updateSizesAfterRouterEvent().

GetOption()

bool DRC_CONSTRAINT::GetOption ( OPTIONS option ) const

inline

Definition at line 229 of file drc_rule.h.

References m_options.

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_RULE_LOADER::createConstraintData(), PCB_TUNING_PATTERN::CreateNew(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), and ToProto().

GetParentRule()

DRC_RULE * DRC_CONSTRAINT::GetParentRule ( ) const

inline

Definition at line 200 of file drc_rule.h.

References m_parentRule.

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCounts(), DRC_ENGINE::EvalRules(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_CREEPAGE::testCreepage(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer().

GetSeverity()

SEVERITY DRC_CONSTRAINT::GetSeverity ( ) const

inline

Definition at line 217 of file drc_rule.h.

References m_parentRule, and RPT_SEVERITY_UNDEFINED.

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

GetValue()

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

inline

Definition at line 196 of file drc_rule.h.

References m_Value.

Referenced by BOOST_FIXTURE_TEST_CASE(), ZONE_FILLER::buildCopperItemClearances(), ZONE_FILLER::buildDifferentNetZoneClearances(), ZONE_FILLER::buildHatchZoneThermalRings(), ZONE_FILLER::buildThermalSpokes(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCounts(), DRC_RULE_LOADER::createConstraintData(), PCB_TUNING_PATTERN::CreateNew(), DRAWING_TOOL::DrawVia(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), isSymmetricMinOptMax(), ZONE_FILLER::knockoutThermalReliefs(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), DRC_ENGINE::QueryDistinctConstraints(), DRC_ENGINE::QueryWorstConstraint(), ZONE_FILLER::refillZoneFromCache(), DRC_CACHE_GENERATOR::Run(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), 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::testKnockoutTextAgainstZone(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

IsNull()

bool DRC_CONSTRAINT::IsNull ( ) const

inline

Definition at line 191 of file drc_rule.h.

References m_Type, and NULL_CONSTRAINT.

Referenced by ZONE_FILLER::buildCopperItemClearances(), ZONE_FILLER::buildDifferentNetZoneClearances(), PCB_TUNING_PATTERN::CreateNew(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), ROUTER_TOOL::handleLayerSwitch(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), ZONE_FILLER::refillZoneFromCache(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), and ROUTER_TOOL::updateSizesAfterRouterEvent().

SetName()

void DRC_CONSTRAINT::SetName ( const wxString & aName )

inline

Definition at line 202 of file drc_rule.h.

References m_name.

Referenced by DRC_ENGINE::EvalRules().

SetOption()

void DRC_CONSTRAINT::SetOption ( OPTIONS option )

inline

Definition at line 225 of file drc_rule.h.

References m_options.

Referenced by DRC_RULES_PARSER::parseConstraint().

SetOptionsFromOther()

void DRC_CONSTRAINT::SetOptionsFromOther ( const DRC_CONSTRAINT & aOther )

inline

Definition at line 234 of file drc_rule.h.

References DRC_CONSTRAINT(), and m_options.

Referenced by DRC_ENGINE::EvalRules().

SetParentRule()

void DRC_CONSTRAINT::SetParentRule ( DRC_RULE * aParentRule )

inline

Definition at line 199 of file drc_rule.h.

References m_parentRule.

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

ToProto()

void DRC_CONSTRAINT::ToProto

(

kiapi::board::CustomRuleConstraint &

aProto

)

const

Definition at line 376 of file drc_rule.cpp.

References ASSERTION_CONSTRAINT, DISALLOW_CONSTRAINT, DRC_DISALLOW_FOOTPRINTS, DRC_DISALLOW_THROUGH_VIAS, flag, GetOption(), m_DisallowFlags, m_name, m_Test, m_Type, m_Value, m_ZoneConnection, NUM_OPTIONS, ToProtoEnum(), and ZONE_CONNECTION_CONSTRAINT.

Referenced by API_HANDLER_PCB::handleGetCustomDesignRules().

Value()

MINOPTMAX< int > & DRC_CONSTRAINT::Value ( )

inline

Definition at line 197 of file drc_rule.h.

References m_Value.

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(), ZONE_FILLER::buildThermalSpokes(), BOARD_DESIGN_SETTINGS::GetBiggestClearanceValue(), DRC_ENGINE::GetCachedOwnClearance(), PCB_VIA::GetDrillConstraint(), PCB_VIA::GetMinAnnulus(), PCB_TRACK::GetWidthConstraint(), PCB_VIA::GetWidthConstraint(), DRC_ENGINE::InitializeClearanceCache(), DRC_ENGINE::loadImplicitRules(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_CREEPAGE::testCreepage(), and PCB_CONTROL::UpdateMessagePanel().

Member Data Documentation

m_DisallowFlags

int DRC_CONSTRAINT::m_DisallowFlags

Definition at line 241 of file drc_rule.h.

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

m_ImplicitMin

bool DRC_CONSTRAINT::m_ImplicitMin

Definition at line 244 of file drc_rule.h.

Referenced by DRC_CONSTRAINT(), and DRC_ENGINE::EvalRules().

m_name

wxString DRC_CONSTRAINT::m_name

private

Definition at line 247 of file drc_rule.h.

Referenced by DRC_CONSTRAINT(), GetName(), SetName(), and ToProto().

m_options

std::bitset<static_cast<int>( OPTIONS::NUM_OPTIONS )> DRC_CONSTRAINT::m_options

private

Definition at line 249 of file drc_rule.h.

Referenced by ClearOption(), GetOption(), SetOption(), and SetOptionsFromOther().

m_parentRule

DRC_RULE* DRC_CONSTRAINT::m_parentRule

private

Definition at line 248 of file drc_rule.h.

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

m_Test

DRC_RULE_CONDITION* DRC_CONSTRAINT::m_Test

Definition at line 243 of file drc_rule.h.

Referenced by DRC_RULE_LOADER::createConstraintData(), DRC_CONSTRAINT(), DRC_RULE_LOADER::LoadRule(), DRC_RULES_PARSER::parseConstraint(), and ToProto().

m_Type

DRC_CONSTRAINT_T DRC_CONSTRAINT::m_Type

Definition at line 239 of file drc_rule.h.

Referenced by DRC_ENGINE::compileRules(), DRC_CONSTRAINT(), DRC_ENGINE::EvalRules(), DRC_RULE_LOADER::findConstraint(), DRC_ENGINE::GetItemsMatchingRule(), IsNull(), DRC_PANEL_MATCHER::MatchRule(), DRC_RULES_PARSER::parseConstraint(), and ToProto().

m_Value

MINOPTMAX<int> DRC_CONSTRAINT::m_Value

Definition at line 240 of file drc_rule.h.

Referenced by DRC_CONSTRAINT(), DRC_ENGINE::EvalClearanceBatch(), DRC_ENGINE::EvalRules(), PAD::GetSolderMaskExpansion(), PCB_SHAPE::GetSolderMaskExpansion(), PCB_TRACK::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), GetValue(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::InspectDRCError(), DRC_RULES_PARSER::parseConstraint(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), BOARD_INSPECTION_TOOL::reportClearance(), reportMax(), reportMin(), reportOpt(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), ToProto(), PCB_CONTROL::UpdateMessagePanel(), ROUTER_TOOL::updateSizesAfterRouterEvent(), and Value().

m_ZoneConnection

ZONE_CONNECTION DRC_CONSTRAINT::m_ZoneConnection

Definition at line 242 of file drc_rule.h.

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

---

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

• drc_rule.h
• drc_rule.cpp