realAscot/kicad-source
1
0
Fork 0
mirror of https://gitlab.com/kicad/code/kicad.git synced 2025-09-14 02:03:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

multichannel tool: formatting and comments

Browse Source
This commit is contained in:
Mike Williams 2025-08-19 13:57:08 -04:00
parent 4df013cf13
commit 3151d97010
2 changed files with 42 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
pcbnew/tools/multichannel_tool.cpp
View File

@ -304,7 +304,7 @@ const SHAPE_LINE_CHAIN MULTICHANNEL_TOOL::buildRAOutline( std::set<FOOTPRINT*>&
}
void MULTICHANNEL_TOOL::QuerySheetsAndComponentClasses()
void MULTICHANNEL_TOOL::GeneratePotentialRuleAreas()
{
using PathAndName = std::pair<wxString, wxString>;
std::set<PathAndName> uniqueSheets;
@ -398,10 +398,11 @@ void MULTICHANNEL_TOOL::FindExistingRuleAreas()
m_areas.m_areas.push_back( area );
wxLogTrace( traceMultichannelTool, wxT("RA '%s', %d footprints\n"), area.m_ruleName, (int) area.m_components.size() );
wxLogTrace( traceMultichannelTool, wxT( "RA '%s', %d footprints\n" ), area.m_ruleName,
(int) area.m_components.size() );
}
wxLogTrace( traceMultichannelTool, wxT("Total RAs found: %d\n"), (int) m_areas.m_areas.size() );
wxLogTrace( traceMultichannelTool, wxT( "Total RAs found: %d\n" ), (int) m_areas.m_areas.size() );
}
@ -579,7 +580,7 @@ int MULTICHANNEL_TOOL::RepeatLayout( const TOOL_EVENT& aEvent, ZONE* aRefZone )
{
if( !targetArea.second.m_doCopy )
{
wxLogTrace( traceMultichannelTool, wxT("skipping copy to RA '%s' (disabled in dialog)\n"),
wxLogTrace( traceMultichannelTool, wxT( "skipping copy to RA '%s' (disabled in dialog)\n" ),
targetArea.first->m_ruleName );
continue;
}
@ -673,7 +674,7 @@ int MULTICHANNEL_TOOL::findRoutingInRuleArea( RULE_AREA* aRuleArea, std::set<BOA
auto reportError = [&]( const wxString& aMessage, int aOffset )
{
wxLogTrace( traceMultichannelTool, wxT( "ERROR: %s"), aMessage );
wxLogTrace( traceMultichannelTool, wxT( "ERROR: %s" ), aMessage );
};
ctx.SetErrorCallback( reportError );
@ -776,7 +777,7 @@ bool MULTICHANNEL_TOOL::copyRuleAreaContents( TMATCH::COMPONENT_MATCHES& aMatche
std::set<BOARD_CONNECTED_ITEM*> refRouting;
std::set<BOARD_CONNECTED_ITEM*> targetRouting;
wxLogTrace( traceMultichannelTool, wxT("copying routing: %d fps\n"), (int) aMatches.size() );
wxLogTrace( traceMultichannelTool, wxT( "copying routing: %d fps\n" ), (int) aMatches.size() );
std::set<int> refc;
std::set<int> targc;
@ -1058,23 +1059,23 @@ bool MULTICHANNEL_TOOL::resolveConnectionTopology( RULE_AREA* aRefArea, RULE_ARE
{
case CONNECTION_GRAPH::ST_OK:
aMatches.m_isOk = true;
aMatches.m_errorMsg = _("OK");
aMatches.m_errorMsg = _( "OK" );
break;
case CONNECTION_GRAPH::ST_EMPTY:
aMatches.m_isOk = false;
aMatches.m_errorMsg = _("One or both of the areas has no components assigned.");
aMatches.m_errorMsg = _( "One or both of the areas has no components assigned." );
break;
case CONNECTION_GRAPH::ST_COMPONENT_COUNT_MISMATCH:
aMatches.m_isOk = false;
aMatches.m_errorMsg = _("Component count mismatch");
aMatches.m_errorMsg = _( "Component count mismatch" );
break;
case CONNECTION_GRAPH::ST_ITERATION_COUNT_EXCEEDED:
aMatches.m_isOk = false;
aMatches.m_errorMsg = _("Iteration count exceeded (timeout)");
aMatches.m_errorMsg = _( "Iteration count exceeded (timeout)" );
break;
case CONNECTION_GRAPH::ST_TOPOLOGY_MISMATCH:
aMatches.m_isOk = false;
aMatches.m_errorMsg = _("Topology mismatch");
aMatches.m_errorMsg = _( "Topology mismatch" );
break;
default:
break;
@ -1122,13 +1123,13 @@ int MULTICHANNEL_TOOL::AutogenerateRuleAreas( const TOOL_EVENT& aEvent )
{
if( Pgm().IsGUI() )
{
QuerySheetsAndComponentClasses();
GeneratePotentialRuleAreas();
if( m_areas.m_areas.size() <= 1 )
{
frame()->ShowInfoBarError( _( "Cannot auto-generate any placement areas because the "
"schematic has only one or no hierarchical sheet(s) or "
"component classes." ),
"schematic has only one or no hierarchical sheets, "
"groups, or component classes." ),
true );
return 0;
}

49
pcbnew/tools/multichannel_tool.h
View File

@ -57,7 +57,9 @@ struct RULE_AREA_COMPAT_DATA
bool m_doCopy = false;
wxString m_errorMsg;
TMATCH::COMPONENT_MATCHES m_matchingComponents;
/// Filled in by copyRuleAreaContents with items that were affected by the copy operation.
std::unordered_set<BOARD_ITEM*> m_affectedItems;
/// Filled in by copyRuleAreaContents with affected items that can be grouped together.
std::unordered_set<BOARD_ITEM*> m_groupableItems;
};
@ -95,44 +97,47 @@ public:
MULTICHANNEL_TOOL();
~MULTICHANNEL_TOOL();
int RepeatLayout( const TOOL_EVENT& aEvent, ZONE* aRefZone );
int RepeatLayout( const TOOL_EVENT& aEvent, RULE_AREA& aRefArea, RULE_AREA& aTargetArea );
int AutogenerateRuleAreas( const TOOL_EVENT& aEvent );
void UpdatePickedPoint( const std::optional<VECTOR2I>& aPoint ) override {};
void UpdatePickedItem( const EDA_ITEM* aItem ) override;
RULE_AREAS_DATA* GetData() { return &m_areas; }
int AutogenerateRuleAreas( const TOOL_EVENT& aEvent );
int RepeatLayout( const TOOL_EVENT& aEvent, ZONE* aRefZone );
int RepeatLayout( const TOOL_EVENT& aEvent, RULE_AREA& aRefArea, RULE_AREA& aTargetArea );
void QuerySheetsAndComponentClasses();
void GeneratePotentialRuleAreas();
void FindExistingRuleAreas();
int CheckRACompatibility( ZONE *aRefZone );
int CheckRACompatibility( ZONE* aRefZone );
private:
void setTransitions() override;
int repeatLayout( const TOOL_EVENT& aEvent );
void setTransitions() override;
int repeatLayout( const TOOL_EVENT& aEvent );
wxString stripComponentIndex( const wxString& aRef ) const;
bool findComponentsInRuleArea( RULE_AREA* aRuleArea, std::set<FOOTPRINT*>& aComponents );
bool findOtherItemsInRuleArea( RULE_AREA* aRuleArea, std::set<BOARD_ITEM*>& aItems );
int findRoutingInRuleArea( RULE_AREA* aRuleArea, std::set<BOARD_CONNECTED_ITEM*>& aOutput,
std::shared_ptr<CONNECTIVITY_DATA> aConnectivity,
const SHAPE_POLY_SET& aRAPoly,
const REPEAT_LAYOUT_OPTIONS& aOpts ) const;
bool findComponentsInRuleArea( RULE_AREA* aRuleArea, std::set<FOOTPRINT*>& aComponents );
bool findOtherItemsInRuleArea( RULE_AREA* aRuleArea, std::set<BOARD_ITEM*>& aItems );
int findRoutingInRuleArea( RULE_AREA* aRuleArea, std::set<BOARD_CONNECTED_ITEM*>& aOutput,
std::shared_ptr<CONNECTIVITY_DATA> aConnectivity, const SHAPE_POLY_SET& aRAPoly,
const REPEAT_LAYOUT_OPTIONS& aOpts ) const;
bool copyRuleAreaContents( TMATCH::COMPONENT_MATCHES& aMatches, BOARD_COMMIT* aCommit, RULE_AREA* aRefArea,
RULE_AREA* aTargetArea, REPEAT_LAYOUT_OPTIONS aOpts,
std::unordered_set<BOARD_ITEM*>& aAffectedItems,
std::unordered_set<BOARD_ITEM*>& aGroupableItems );
const SHAPE_LINE_CHAIN buildRAOutline( std::set<FOOTPRINT*>& aFootprints, int aMargin );
std::set<FOOTPRINT*> queryComponentsInSheet( wxString aSheetName ) const;
std::set<FOOTPRINT*>
queryComponentsInComponentClass( const wxString& aComponentClassName ) const;
std::set<FOOTPRINT*> queryComponentsInSheet( wxString aSheetName ) const;
std::set<FOOTPRINT*> queryComponentsInComponentClass( const wxString& aComponentClassName ) const;
std::set<FOOTPRINT*> queryComponentsInGroup( const wxString& aGroupName ) const;
RULE_AREA* findRAByName( const wxString& aName );
bool resolveConnectionTopology( RULE_AREA* aRefArea, RULE_AREA* aTargetArea,
RULE_AREA_COMPAT_DATA& aMatches );
bool copyRuleAreaContents( TMATCH::COMPONENT_MATCHES& aMatches, BOARD_COMMIT* aCommit, RULE_AREA* aRefArea,
RULE_AREA* aTargetArea, REPEAT_LAYOUT_OPTIONS aOpts,
std::unordered_set<BOARD_ITEM*>& aAffectedItems,
std::unordered_set<BOARD_ITEM*>& aGroupableItems );
void fixupNet( BOARD_CONNECTED_ITEM* aRef, BOARD_CONNECTED_ITEM* aTarget,
TMATCH::COMPONENT_MATCHES& aComponentMatches );
bool pruneExistingGroups( COMMIT& aCommit, const std::unordered_set<BOARD_ITEM*>& aItemsToCheck );
bool pruneExistingGroups( COMMIT& aCommit, const std::unordered_set<BOARD_ITEM*>& aItemsToCheck );
std::unique_ptr<REPORTER> m_reporter;
RULE_AREAS_DATA m_areas;