KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
RULE_AREA Struct Reference

#include <multichannel_tool.h>

Public Member Functions

bool ScansContents () const
 True when the contents are scanned from the area rather than taken from an exact item list.
 

Public Attributes

PLACEMENT_SOURCE_T m_sourceType = PLACEMENT_SOURCE_T::SHEETNAME
 
bool m_fromSelection = false
 The reference of a plain selection, copied as given with its footprint area deciding what else comes along.
 
ZONE * m_zone = nullptr
 
std::set< FOOTPRINT * > m_components
 
std::unordered_set< EDA_ITEM * > m_designBlockItems
 
PCB_GROUP * m_group = nullptr
 
bool m_generateEnabled = false
 
wxString m_sheetPath
 
wxString m_sheetName
 
wxString m_ruleName
 
wxString m_componentClass
 
wxString m_groupName
 
VECTOR2I m_center
 

Detailed Description

Definition at line 63 of file multichannel_tool.h.

Member Function Documentation

◆ ScansContents()

bool RULE_AREA::ScansContents ( ) const
inline

True when the contents are scanned from the area rather than taken from an exact item list.

Definition at line 81 of file multichannel_tool.h.

References DESIGN_BLOCK, m_fromSelection, and m_sourceType.

Referenced by MULTICHANNEL_TOOL::copyRuleAreaContents().

Member Data Documentation

◆ m_center

VECTOR2I RULE_AREA::m_center

Definition at line 78 of file multichannel_tool.h.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), MULTICHANNEL_TOOL::DiscoverRepeatCandidates(), MULTICHANNEL_TOOL::FindExistingRuleAreas(), and repeatedOutline().

◆ m_componentClass

wxString RULE_AREA::m_componentClass

Definition at line 76 of file multichannel_tool.h.

Referenced by MULTICHANNEL_TOOL::AutogenerateRuleAreas(), DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS::DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS(), MULTICHANNEL_TOOL::FindExistingRuleAreas(), and MULTICHANNEL_TOOL::GeneratePotentialRuleAreas().

◆ m_components

std::set<FOOTPRINT*> RULE_AREA::m_components

Definition at line 69 of file multichannel_tool.h.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), MULTICHANNEL_TOOL::applySelectionRepeat(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), MULTICHANNEL_TOOL::DiscoverRepeatCandidates(), MULTICHANNEL_TOOL::FindExistingRuleAreas(), MULTICHANNEL_TOOL::findMatches(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), MULTICHANNEL_TOOL::GeneratePotentialRuleAreas(), MULTICHANNEL_TOOL::HighlightRepeatAreas(), DIALOG_MULTICHANNEL_REPEAT_LAYOUT::readWindow(), MULTICHANNEL_TOOL::RepeatLayout(), MULTICHANNEL_TOOL::resolveConnectionTopology(), DIALOG_MULTICHANNEL_REPEAT_LAYOUT::TransferDataToWindow(), MULTICHANNEL_TOOL::UpdateLinkedLayouts(), and MULTICHANNEL_TOOL::updateSelectionCore().

◆ m_designBlockItems

std::unordered_set<EDA_ITEM*> RULE_AREA::m_designBlockItems

Definition at line 70 of file multichannel_tool.h.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), MULTICHANNEL_TOOL::applySelectionRepeat(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), MULTICHANNEL_TOOL::findComponentsInRuleArea(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), MULTICHANNEL_TOOL::findRoutingInRuleArea(), and MULTICHANNEL_TOOL::updateSelectionCore().

◆ m_fromSelection

bool RULE_AREA::m_fromSelection = false

The reference of a plain selection, copied as given with its footprint area deciding what else comes along.

Definition at line 67 of file multichannel_tool.h.

Referenced by MULTICHANNEL_TOOL::copyRuleAreaContents(), MULTICHANNEL_TOOL::DiscoverRepeatCandidates(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), MULTICHANNEL_TOOL::findRoutingInRuleArea(), and ScansContents().

◆ m_generateEnabled

bool RULE_AREA::m_generateEnabled = false

Definition at line 72 of file multichannel_tool.h.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), checkGroupChannelRepeatLayout(), DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS::DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS(), and MULTICHANNEL_TOOL::GeneratePotentialRuleAreas().

◆ m_group

PCB_GROUP* RULE_AREA::m_group = nullptr

Definition at line 71 of file multichannel_tool.h.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), MULTICHANNEL_TOOL::applySelectionRepeat(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), MULTICHANNEL_TOOL::DiscoverRepeatCandidates(), MULTICHANNEL_TOOL::FindExistingRuleAreas(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), and MULTICHANNEL_TOOL::RepeatLayout().

◆ m_groupName

wxString RULE_AREA::m_groupName

Definition at line 77 of file multichannel_tool.h.

Referenced by MULTICHANNEL_TOOL::AutogenerateRuleAreas(), DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS::DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS(), MULTICHANNEL_TOOL::FindExistingRuleAreas(), and MULTICHANNEL_TOOL::GeneratePotentialRuleAreas().

◆ m_ruleName

wxString RULE_AREA::m_ruleName

Definition at line 75 of file multichannel_tool.h.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), MULTICHANNEL_TOOL::FindExistingRuleAreas(), and MULTICHANNEL_TOOL::UpdateLinkedLayouts().

◆ m_sheetName

wxString RULE_AREA::m_sheetName

Definition at line 74 of file multichannel_tool.h.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS::DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS(), and MULTICHANNEL_TOOL::GeneratePotentialRuleAreas().

◆ m_sheetPath

wxString RULE_AREA::m_sheetPath

Definition at line 73 of file multichannel_tool.h.

Referenced by MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS::DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS(), MULTICHANNEL_TOOL::FindExistingRuleAreas(), and MULTICHANNEL_TOOL::GeneratePotentialRuleAreas().

◆ m_sourceType

PLACEMENT_SOURCE_T RULE_AREA::m_sourceType = PLACEMENT_SOURCE_T::SHEETNAME

Definition at line 65 of file multichannel_tool.h.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS::DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS(), MULTICHANNEL_TOOL::DiscoverRepeatCandidates(), MULTICHANNEL_TOOL::findComponentsInRuleArea(), MULTICHANNEL_TOOL::FindExistingRuleAreas(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), MULTICHANNEL_TOOL::findRoutingInRuleArea(), MULTICHANNEL_TOOL::GeneratePotentialRuleAreas(), linkedChannelGroup(), MULTICHANNEL_TOOL::RepeatLayout(), MULTICHANNEL_TOOL::resolveConnectionTopology(), and ScansContents().

◆ m_zone

ZONE* RULE_AREA::m_zone = nullptr

Definition at line 68 of file multichannel_tool.h.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), MULTICHANNEL_TOOL::applySelectionRepeat(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), checkGroupChannelRepeatLayout(), MULTICHANNEL_TOOL::CheckRACompatibility(), MULTICHANNEL_TOOL::copyRuleAreaContents(), countZonesByNameInRuleArea(), countZonesByNamePrefixInRuleArea(), MULTICHANNEL_TOOL::DiscoverRepeatCandidates(), MULTICHANNEL_TOOL::findComponentsInRuleArea(), MULTICHANNEL_TOOL::FindExistingRuleAreas(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), MULTICHANNEL_TOOL::findRoutingInRuleArea(), linkedChannelGroup(), repeatedOutline(), MULTICHANNEL_TOOL::RepeatLayout(), DIALOG_MULTICHANNEL_REPEAT_LAYOUT::TransferDataToWindow(), MULTICHANNEL_TOOL::UpdateLinkedLayouts(), and MULTICHANNEL_TOOL::updateSelectionCore().

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