40#include <wx/datetime.h>
183 switch( footprint->GetSide() )
207 if( track->GetNetCode() == otherTrack->GetNetCode() )
218 auto trackShapeA = track->GetEffectiveShape( layer );
219 auto trackShapeB = otherTrack->GetEffectiveShape( layer );
243 std::vector<DRILL_LINE_ITEM> drills;
274 for(
int j = 0; j < polySet.
HoleCount( i ); ++j )
283 for(
PAD*
pad : footprint->Pads() )
285 if( !
pad->HasHole() )
288 std::shared_ptr<SHAPE_SEGMENT> hole =
pad->GetEffectiveHoleShape();
293 const SEG& seg = hole->GetSeg();
294 double width = hole->GetWidth();
295 double area = seg.
Length() * width;
297 area +=
M_PI * 0.25 * width * width;
307 double drill =
via->GetDrillValue();
327 int minPadClearanceOuter = netSettings->GetDefaultNetclass()->GetClearance();
335 frontShapesForArea.
Append( frontA );
338 backShapesForArea.
Append( backA );
342 for(
PAD*
pad : fp->Pads() )
344 if( !
pad->HasHole() )
349 pad->TransformShapeToPolygon( frontShapesForArea,
F_Cu,
350 std::min( minPadClearanceOuter,
pad->GetOwnClearance(
F_Cu ) ),
352 pad->TransformShapeToPolygon( backShapesForArea,
B_Cu,
353 std::min( minPadClearanceOuter,
pad->GetOwnClearance(
B_Cu ) ),
443 return wxString::Format( wxT(
"%i" ), aCount );
447static void appendTable(
const std::vector<std::vector<wxString>>& aRows,
bool aUseFirstColAsLabel, wxString& aOut )
452 size_t columnCount = 0;
454 for(
const std::vector<wxString>& row : aRows )
456 if( row.size() > columnCount )
457 columnCount = row.size();
460 if( columnCount == 0 )
463 std::vector<int> widths( columnCount, 0 );
465 for(
const std::vector<wxString>& row : aRows )
467 for(
size_t col = 0; col < columnCount; ++col )
469 if( col >= row.size() )
472 int cellWidth =
static_cast<int>( row[col].length() );
474 if( cellWidth > widths[col] )
475 widths[col] = cellWidth;
480 [&](
const std::vector<wxString>& row,
bool treatFirstAsLabel )
482 if( treatFirstAsLabel && aUseFirstColAsLabel )
485 wxString firstColumn;
488 firstColumn = row[0];
490 formatted.Printf( wxS(
"|%-*s |" ), widths[0], firstColumn );
493 for(
size_t col = 1; col < columnCount; ++col )
496 if( col < row.size() )
499 formatted.Printf( wxS(
" %*s |" ), widths[col], value );
507 for(
size_t col = 0; col < columnCount; ++col )
510 if( col < row.size() )
514 formatted.Printf( wxS(
" %*s |" ), widths[col], value );
522 appendDataRow( aRows.front(),
false );
526 for(
size_t col = 0; col < columnCount; ++col )
528 int dashCount = widths[col] + 2;
535 for(
int i = 0; i < dashCount; ++i )
536 dashes << wxS(
"-" );
538 aOut << dashes << wxS(
"|" );
543 for(
size_t rowIdx = 1; rowIdx < aRows.size(); ++rowIdx )
544 appendDataRow( aRows[rowIdx],
true );
550 if( aValue == std::numeric_limits<int>::max() )
551 return _(
"unknown" );
558 const UNITS_PROVIDER& aUnitsProvider,
const wxString& aProjectName,
559 const wxString& aBoardName )
563 report <<
_(
"PCB statistics report\n=====================" ) << wxS(
"\n" );
564 report << wxS(
"- " ) <<
_(
"Date" ) << wxS(
": " ) << wxDateTime::Now().Format() << wxS(
"\n" );
565 report << wxS(
"- " ) <<
_(
"Project" ) << wxS(
": " ) << aProjectName << wxS(
"\n" );
566 report << wxS(
"- " ) <<
_(
"Board name" ) << wxS(
": " ) << aBoardName << wxS(
"\n\n" );
568 report <<
_(
"Board" ) << wxS(
"\n-----\n" );
574 report << wxS(
"- " ) <<
_(
"Height" ) << wxS(
": " )
576 report << wxS(
"- " ) <<
_(
"Area" ) << wxS(
": " )
581 report << wxS(
"- " ) <<
_(
"Dimensions" ) << wxS(
": " ) <<
_(
"unknown" ) << wxS(
"\n" );
582 report << wxS(
"- " ) <<
_(
"Area" ) << wxS(
": " ) <<
_(
"unknown" ) << wxS(
"\n" );
585 report << wxS(
"- " ) <<
_(
"Front copper area" ) << wxS(
": " )
587 report << wxS(
"- " ) <<
_(
"Back copper area" ) << wxS(
": " )
590 report << wxS(
"- " ) <<
_(
"Min track clearance" ) << wxS(
": " )
593 report << wxS(
"- " ) <<
_(
"Min track width" ) << wxS(
": " )
596 report << wxS(
"- " ) <<
_(
"Min drill diameter" ) << wxS(
": " )
599 report << wxS(
"- " ) <<
_(
"Board stackup thickness" ) << wxS(
": " )
603 report << wxS(
"- " ) <<
_(
"Front footprint area" ) << wxS(
": " )
605 report << wxS(
"- " ) <<
_(
"Back footprint area" ) << wxS(
": " )
608 report << wxS(
"- " ) <<
_(
"Front component density" ) << wxS(
": " );
613 report <<
_(
"unknown" );
615 report << wxS(
"\n" );
617 report << wxS(
"- " ) <<
_(
"Back component density" ) << wxS(
": " );
622 report <<
_(
"unknown" );
624 report << wxS(
"\n" );
626 report <<
_(
"Pads" ) << wxS(
"\n----\n" );
629 report << wxS(
"- " ) << padEntry.
title << wxS(
" " ) << padEntry.
quantity << wxS(
"\n" );
632 report << wxS(
"- " ) << propEntry.
title << wxS(
" " ) << propEntry.
quantity << wxS(
"\n" );
634 report << wxS(
"\n" );
635 report <<
_(
"Vias" ) << wxS(
"\n----\n" );
638 report << wxS(
"- " ) << viaEntry.
title << wxS(
" " ) << viaEntry.
quantity << wxS(
"\n" );
640 report << wxS(
"\n" );
641 report <<
_(
"Components" ) << wxS(
"\n----------\n\n" );
643 std::vector<std::vector<wxString>> componentRows;
644 std::vector<wxString> header;
645 header.push_back( wxString() );
646 header.push_back(
_(
"Front Side" ) );
647 header.push_back(
_(
"Back Side" ) );
648 header.push_back(
_(
"Total" ) );
649 componentRows.push_back( std::move( header ) );
656 std::vector<wxString> row;
657 row.push_back( fpEntry.
title );
661 componentRows.push_back( std::move( row ) );
667 std::vector<wxString> totalRow;
668 totalRow.push_back(
_(
"Total:" ) );
671 totalRow.push_back(
formatCount( frontTotal + backTotal ) );
672 componentRows.push_back( std::move( totalRow ) );
676 report << wxS(
"\n" );
677 report <<
_(
"Drill holes" ) << wxS(
"\n-----------\n\n" );
679 std::vector<std::vector<wxString>> drillRows;
680 std::vector<wxString> drillHeader;
681 drillHeader.push_back(
_(
"Count" ) );
682 drillHeader.push_back(
_(
"Shape" ) );
683 drillHeader.push_back(
_(
"X Size" ) );
684 drillHeader.push_back(
_(
"Y Size" ) );
685 drillHeader.push_back(
_(
"Plated" ) );
686 drillHeader.push_back(
_(
"Via/Pad" ) );
687 drillHeader.push_back(
_(
"Start Layer" ) );
688 drillHeader.push_back(
_(
"Stop Layer" ) );
689 drillRows.push_back( std::move( drillHeader ) );
695 switch( drill.
shape )
699 default: shapeStr =
_(
"???" );
break;
702 wxString platedStr = drill.
isPlated ?
_(
"PTH" ) :
_(
"NPTH" );
703 wxString itemStr = drill.
isPad ?
_(
"Pad" ) :
_(
"Via" );
705 wxString startLayerStr;
706 wxString stopLayerStr;
709 startLayerStr =
_(
"N/A" );
713 startLayerStr =
_(
"N/A" );
716 stopLayerStr =
_(
"N/A" );
720 stopLayerStr =
_(
"N/A" );
722 std::vector<wxString> row;
724 row.push_back( shapeStr );
727 row.push_back( platedStr );
728 row.push_back( itemStr );
729 row.push_back( startLayerStr );
730 row.push_back( stopLayerStr );
731 drillRows.push_back( std::move( row ) );
741 const UNITS_PROVIDER& aUnitsProvider,
const wxString& aProjectName,
742 const wxString& aBoardName )
744 const auto formatMinimum = [&aUnitsProvider](
int aValue ) -> nlohmann::json
746 if( aValue == std::numeric_limits<int>::max() )
747 return nlohmann::json();
752 nlohmann::ordered_json root;
754 nlohmann::ordered_json metadata;
757 metadata[
"project"] = aProjectName;
758 metadata[
"board_name"] = aBoardName;
759 root[
"metadata"] = metadata;
761 nlohmann::ordered_json board;
774 board[
"width"] = nlohmann::json();
775 board[
"height"] = nlohmann::json();
776 board[
"area"] = nlohmann::json();
777 board[
"front_component_density"] = nlohmann::json();
778 board[
"back_component_density"] = nlohmann::json();
786 board[
"min_track_width"] = formatMinimum( aData.
minTrackWidth );
787 board[
"min_drill_diameter"] = formatMinimum( aData.
minDrillSize );
801 board[
"front_footprint_density"] = nlohmann::json();
802 board[
"back_footprint_density"] = nlohmann::json();
805 root[
"board"] = board;
807 nlohmann::ordered_json pads = nlohmann::ordered_json::object();
817 nlohmann::ordered_json vias = nlohmann::ordered_json::object();
826 nlohmann::ordered_json components = nlohmann::ordered_json::object();
830 nlohmann::ordered_json component;
834 components[fpEntry.
jsonKey] = component;
840 nlohmann::ordered_json totals;
841 totals[
"front"] = frontTotal;
842 totals[
"back"] = backTotal;
843 totals[
"total"] = frontTotal + backTotal;
844 components[
"total"] = totals;
846 root[
"components"] = components;
848 nlohmann::ordered_json drillHoles = nlohmann::ordered_json::array();
852 nlohmann::ordered_json drillJson;
856 switch( drill.
shape )
860 default: shapeStr =
_(
"???" );
break;
863 wxString sourceStr = drill.
isPad ?
_(
"Pad" ) :
_(
"Via" );
864 wxString startLayerStr =
_(
"N/A" );
865 wxString stopLayerStr =
_(
"N/A" );
873 drillJson[
"count"] = drill.
m_Qty;
874 drillJson[
"shape"] = shapeStr;
877 drillJson[
"plated"] = drill.
isPlated;
878 drillJson[
"source"] = sourceStr;
879 drillJson[
"start_layer"] = startLayerStr;
880 drillJson[
"stop_layer"] = stopLayerStr;
881 drillHoles.push_back( std::move( drillJson ) );
884 root[
"drill_holes"] = drillHoles;
886 std::string jsonText = root.dump( 2 );
887 return wxString::FromUTF8( jsonText.c_str() );
constexpr int ARC_LOW_DEF
void CollectDrillLineItems(BOARD *board, std::vector< DRILL_LINE_ITEM > &out)
static void updatePadCounts(FOOTPRINT *aFootprint, BOARD_STATISTICS_DATA &aData)
wxString FormatBoardStatisticsJson(const BOARD_STATISTICS_DATA &aData, BOARD *aBoard, const UNITS_PROVIDER &aUnitsProvider, const wxString &aProjectName, const wxString &aBoardName)
void ComputeBoardStatistics(BOARD *aBoard, const BOARD_STATISTICS_OPTIONS &aOptions, BOARD_STATISTICS_DATA &aData)
static wxString formatCount(int aCount)
wxString FormatBoardStatisticsReport(const BOARD_STATISTICS_DATA &aData, BOARD *aBoard, const UNITS_PROVIDER &aUnitsProvider, const wxString &aProjectName, const wxString &aBoardName)
wxString FormatBoardStatisticsMinimum(int aValue, const UNITS_PROVIDER &aUnitsProvider)
Format a minimum distance, or "unknown" when no qualifying measurement was found.
void InitializeBoardStatisticsData(BOARD_STATISTICS_DATA &aData)
static void appendTable(const std::vector< std::vector< wxString > > &aRows, bool aUseFirstColAsLabel, wxString &aOut)
wxString GetBuildVersion()
Get the full KiCad version string.
std::shared_ptr< NET_SETTINGS > m_NetSettings
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Test to see if this object is on the given layer.
virtual void TransformShapeToPolySet(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, KIGFX::RENDER_SETTINGS *aRenderSettings=nullptr) const
Convert the item shape to a polyset.
int BuildBoardThicknessFromStackup() const
Information pertinent to a Pcbnew printed circuit board.
BOARD_STACKUP GetStackupOrDefault() const
const FOOTPRINTS & Footprints() const
const TRACKS & Tracks() const
bool GetBoardPolygonOutlines(SHAPE_POLY_SET &aOutlines, bool aInferOutlineIfNecessary, OUTLINE_ERROR_HANDLER *aErrorHandler=nullptr, bool aAllowUseArcsInPolygons=false, bool aIncludeNPTHAsOutlines=false)
Extract the board outlines and build a closed polygon from lines, arcs and circle items on edge cut l...
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction, RECURSE_MODE aMode) const override
Invoke a function on all children.
BOARD_DESIGN_SETTINGS & GetDesignSettings()
constexpr size_type GetWidth() const
constexpr size_type GetHeight() const
KICAD_T Type() const
Returns the type of object.
LSET is a set of PCB_LAYER_IDs.
static const LSET & AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
LSEQ CuStack() const
Return a sequence of copper layers in starting from the front/top and extending to the back/bottom.
int Length() const
Return the length (this).
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
double Area(bool aAbsolute=true) const
Return the area of this chain.
Represent a set of closed polygons.
double Area()
Return the area of this poly set.
int HoleCount(int aOutline) const
Returns the number of holes in a given outline.
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline)
void Simplify()
Simplify the polyset (merges overlapping polys, eliminates degeneracy/self-intersections)
SHAPE_LINE_CHAIN & Outline(int aIndex)
Return the reference to aIndex-th outline in the set.
SHAPE_LINE_CHAIN & Hole(int aOutline, int aHole)
Return the reference to aHole-th hole in the aIndex-th outline.
int OutlineCount() const
Return the number of outlines in the set.
void BooleanSubtract(const SHAPE_POLY_SET &b)
Perform boolean polyset difference.
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
void TransformCircleToPolygon(SHAPE_LINE_CHAIN &aBuffer, const VECTOR2I &aCenter, int aRadius, int aError, ERROR_LOC aErrorLoc, int aMinSegCount=0)
Convert a circle to a polygon, using multiple straight lines.
Some functions to handle hotkeys in KiCad.
PCB_LAYER_ID
A quick note on layer IDs:
@ NPTH
like PAD_PTH, but not plated mechanical use only, no connection allowed
@ NON_COMPONENT
Pad with no hole that does not connect to a physical component, but rather provides a connection poin...
@ SMD
Smd pad, appears on the solder paste layer (default)
@ PTH
Plated through hole pad.
@ CONN
Like smd, does not appear on the solder paste layer (default) Note: also has a special attribute in G...
@ PRESSFIT
a PTH with a hole diameter with tight tolerances for press fit pin
@ CASTELLATED
a pad with a castellated through hole
bool collide(T aObject, U aAnotherObject, int aLayer, int aMinDistance)
Used by SHAPE_INDEX to implement Query().
wxString GetISO8601CurrentDateTime()
int minClearanceTrackToTrack
std::vector< BOARD_STATISTICS_INFO_ENTRY< PAD_ATTRIB > > padEntries
double backFootprintCourtyardArea
double frontFootprintDensity
std::vector< BOARD_STATISTICS_FP_ENTRY > footprintEntries
std::vector< BOARD_STATISTICS_INFO_ENTRY< VIATYPE > > viaEntries
double backFootprintDensity
double frontFootprintCourtyardArea
std::vector< BOARD_STATISTICS_INFO_ENTRY< PAD_PROP > > padPropertyEntries
std::vector< DRILL_LINE_ITEM > drillEntries
bool subtractHolesFromCopperAreas
bool subtractHolesFromBoardArea
bool excludeFootprintsWithoutPads
static wxString formatted(LIB_SYMBOL &aSymbol)
Serialize one symbol the way the library writer would.
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
@ PCB_REFERENCE_IMAGE_T
class PCB_REFERENCE_IMAGE, bitmap on a layer
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
@ PCB_PAD_T
class PAD, a pad in a footprint
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
VECTOR2< int32_t > VECTOR2I