|
KiCad PCB EDA Suite
|
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD. More...
#include <netlist.h>
Public Member Functions | |
| NETLIST () | |
| virtual | ~NETLIST ()=default |
| bool | IsEmpty () const |
| void | Clear () |
| Remove all components from the netlist. | |
| unsigned | GetCount () const |
| COMPONENT * | GetComponent (unsigned aIndex) |
| Return the COMPONENT at aIndex. | |
| void | AddComponent (COMPONENT *aComponent) |
| Add aComponent to the NETLIST. | |
| void | AddGroup (NETLIST_GROUP *aGroup) |
| NETLIST_GROUP * | GetGroupByUuid (const KIID &aUuid) |
| Return a NETLIST_GROUP by aUuid. | |
| void | ApplyGroupMembership () |
| After groups and components are parsed, apply the group memberships to the internal components based on the group member UUIDs. | |
| COMPONENT * | GetComponentByReference (const wxString &aReference) |
| Return a COMPONENT by aReference. | |
| COMPONENT * | GetComponentByPath (const KIID_PATH &aPath) |
| Return a COMPONENT by aPath. | |
| COMPONENT * | GetComponentByUuid (const KIID &aUuid) |
| Return a COMPONENT by aUuid. | |
| void | SortByFPID () |
| void | SortByReference () |
| void | SetFindByTimeStamp (bool aFindByTimeStamp) |
| bool | IsFindByTimeStamp () const |
| void | SetReplaceFootprints (bool aReplace) |
| bool | GetReplaceFootprints () const |
| bool | AnyFootprintsLinked () const |
| void | Format (const char *aDocName, OUTPUTFORMATTER *aOut, int aNestLevel, int aCtl=0) |
| void | FormatCvpcbNetlist (OUTPUTFORMATTER *aOut) |
| NETLIST () | |
| bool | IsEmpty () const |
| void | Clear () |
| Remove all components from the netlist. | |
| unsigned | GetCount () const |
| COMPONENT * | GetComponent (unsigned aIndex) |
| Return the COMPONENT at aIndex. | |
| void | AddComponent (COMPONENT *aComponent) |
| Add aComponent to the NETLIST. | |
| void | AddGroup (NETLIST_GROUP *aGroup) |
| void | SetNetChainFor (const wxString &aNet, const wxString &aNetChain) |
| void | AddSignalTerminalPin (const wxString &aNetChain, const wxString &aRef, const wxString &aPin) |
| const std::vector< std::pair< wxString, wxString > > & | GetNetChainTerminals (const wxString &aNetChain) const |
| const std::map< wxString, std::vector< std::pair< wxString, wxString > > > & | GetNetChainTerminalPins () const |
| wxString | GetNetChainFor (const wxString &aNet) const |
| void | SetSignalNetClass (const wxString &aNetChain, const wxString &aNetClass) |
| wxString | GetSignalNetClass (const wxString &aNetChain) const |
| const std::map< wxString, wxString > & | GetNetChainNetClasses () const |
| void | SetSignalColor (const wxString &aNetChain, const wxString &aColor) |
| Stored as a #RRGGBB or #RRGGBBAA string; empty means "no override". | |
| wxString | GetSignalColor (const wxString &aNetChain) const |
| const std::map< wxString, wxString > & | GetNetChainColors () const |
| void | SetSignalChainClass (const wxString &aNetChain, const wxString &aClass) |
| Net chain class assignment carried through the netlist for downstream tools. | |
| wxString | GetSignalChainClass (const wxString &aNetChain) const |
| const std::map< wxString, wxString > & | GetSignalChainClasses () const |
| NETLIST_GROUP * | GetGroupByUuid (const KIID &aUuid) |
| Return a NETLIST_GROUP by aUuid. | |
| void | ApplyGroupMembership () |
| After groups and components are parsed, apply the group memberships to the internal components based on the group member UUIDs. | |
| COMPONENT * | GetComponentByReference (const wxString &aReference) |
| Return a COMPONENT by aReference. | |
| COMPONENT * | GetComponentByPath (const KIID_PATH &aPath) |
| Return a COMPONENT by aPath. | |
| COMPONENT * | GetComponentByUuid (const KIID &aUuid) |
| Return a COMPONENT by aUuid. | |
| void | SortByFPID () |
| void | SortByReference () |
| void | SetFindByTimeStamp (bool aFindByTimeStamp) |
| bool | IsFindByTimeStamp () const |
| void | SetReplaceFootprints (bool aReplace) |
| bool | GetReplaceFootprints () const |
| bool | AnyFootprintsLinked () const |
| void | Format (const char *aDocName, OUTPUTFORMATTER *aOut, int aNestLevel, int aCtl=0) |
| void | FormatCvpcbNetlist (OUTPUTFORMATTER *aOut) |
| const std::vector< wxString > & | GetVariantNames () const |
| void | AddVariant (const wxString &aName, const wxString &aDescription=wxEmptyString) |
| Add a variant name to the netlist. | |
| wxString | GetVariantDescription (const wxString &aVariantName) const |
| const std::map< wxString, wxString > & | GetVariantDescriptions () const |
Protected Attributes | |
| boost::ptr_vector< COMPONENT > | m_components |
| boost::ptr_vector< NETLIST_GROUP > | m_groups |
| bool | m_findByTimeStamp |
| bool | m_replaceFootprints |
Private Attributes | |
| std::map< wxString, wxString > | m_netSignals |
| std::map< wxString, std::vector< std::pair< wxString, wxString > > > | m_netChainTerminals |
| std::map< wxString, wxString > | m_netChainNetClasses |
| std::map< wxString, wxString > | m_netChainColors |
| std::map< wxString, wxString > | m_signalChainClasses |
| std::vector< wxString > | m_variantNames |
| std::map< wxString, wxString > | m_variantDescriptions |
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD.
Definition at line 272 of file common/netlist_reader/netlist.h.
|
inline |
Definition at line 275 of file common/netlist_reader/netlist.h.
References m_findByTimeStamp, and m_replaceFootprints.
|
virtualdefault |
|
inline |
Definition at line 301 of file pcb_netlist.h.
References m_findByTimeStamp, and m_replaceFootprints.
| void NETLIST::AddComponent | ( | COMPONENT * | aComponent | ) |
Add aComponent to the NETLIST.
Definition at line 158 of file common/netlist_reader/netlist.cpp.
References m_components.
| void NETLIST::AddComponent | ( | COMPONENT * | aComponent | ) |
| void NETLIST::AddGroup | ( | NETLIST_GROUP * | aGroup | ) |
| aGroup | is the NETLIST_GROUP to save to the NETLIST. |
Definition at line 164 of file common/netlist_reader/netlist.cpp.
References m_groups.
| void NETLIST::AddGroup | ( | NETLIST_GROUP * | aGroup | ) |
| aGroup | is the NETLIST_GROUP to save to the NETLIST. |
|
inline |
Definition at line 364 of file pcb_netlist.h.
References m_netChainTerminals.
|
inline |
Add a variant name to the netlist.
Definition at line 507 of file pcb_netlist.h.
References m_variantDescriptions, and m_variantNames.
| bool NETLIST::AnyFootprintsLinked | ( | ) | const |
Definition at line 272 of file common/netlist_reader/netlist.cpp.
References empty(), and m_components.
| bool NETLIST::AnyFootprintsLinked | ( | ) | const |
| void NETLIST::ApplyGroupMembership | ( | ) |
After groups and components are parsed, apply the group memberships to the internal components based on the group member UUIDs.
Definition at line 284 of file common/netlist_reader/netlist.cpp.
References GetComponentByUuid(), group, m_groups, and COMPONENT::SetGroup().
| void NETLIST::ApplyGroupMembership | ( | ) |
After groups and components are parsed, apply the group memberships to the internal components based on the group member UUIDs.
|
inline |
Remove all components from the netlist.
Definition at line 291 of file common/netlist_reader/netlist.h.
References m_components, and m_groups.
|
inline |
Remove all components from the netlist.
Definition at line 315 of file pcb_netlist.h.
References m_components, m_groups, m_netChainColors, m_netChainNetClasses, m_netChainTerminals, m_netSignals, m_signalChainClasses, m_variantDescriptions, and m_variantNames.
| void NETLIST::Format | ( | const char * | aDocName, |
| OUTPUTFORMATTER * | aOut, | ||
| int | aNestLevel, | ||
| int | aCtl = 0 ) |
Definition at line 143 of file common/netlist_reader/netlist.cpp.
References m_components, and OUTPUTFORMATTER::Print().
Referenced by FormatCvpcbNetlist().
| void NETLIST::Format | ( | const char * | aDocName, |
| OUTPUTFORMATTER * | aOut, | ||
| int | aNestLevel, | ||
| int | aCtl = 0 ) |
|
inline |
Definition at line 385 of file common/netlist_reader/netlist.h.
References CTL_FOR_CVPCB, and Format().
|
inline |
Definition at line 494 of file pcb_netlist.h.
References CTL_FOR_CVPCB, and Format().
|
inline |
Return the COMPONENT at aIndex.
| aIndex | the index in m_components to fetch. |
Definition at line 308 of file common/netlist_reader/netlist.h.
References m_components.
Referenced by BOOST_AUTO_TEST_CASE(), TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), LoadNetlistFootprints(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), and BOARD_NETLIST_UPDATER::UpdateNetlist().
|
inline |
Return the COMPONENT at aIndex.
| aIndex | the index in m_components to fetch. |
Definition at line 339 of file pcb_netlist.h.
References m_components.
Return a COMPONENT by aPath.
Definition at line 198 of file common/netlist_reader/netlist.cpp.
References m_components.
Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().
| COMPONENT * NETLIST::GetComponentByReference | ( | const wxString & | aReference | ) |
Return a COMPONENT by aReference.
| aReference | is the reference designator the COMPONENT. |
Definition at line 181 of file common/netlist_reader/netlist.cpp.
References m_components.
Referenced by BOOST_AUTO_TEST_CASE(), CMP_READER::Load(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), and BOARD_NETLIST_UPDATER::UpdateNetlist().
| COMPONENT * NETLIST::GetComponentByReference | ( | const wxString & | aReference | ) |
Return a COMPONENT by aUuid.
Definition at line 224 of file common/netlist_reader/netlist.cpp.
References m_components.
Referenced by ApplyGroupMembership().
|
inline |
Definition at line 300 of file common/netlist_reader/netlist.h.
References m_components.
Referenced by BOOST_AUTO_TEST_CASE(), TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), LoadNetlistFootprints(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), and BOARD_NETLIST_UPDATER::UpdateNetlist().
|
inline |
Definition at line 331 of file pcb_netlist.h.
References m_components.
| NETLIST_GROUP * NETLIST::GetGroupByUuid | ( | const KIID & | aUuid | ) |
Return a NETLIST_GROUP by aUuid.
| aUuid | is the KIID of the NETLIST_GROUP. |
Definition at line 169 of file common/netlist_reader/netlist.cpp.
References group, and m_groups.
Referenced by BOARD_NETLIST_UPDATER::updateGroups().
| NETLIST_GROUP * NETLIST::GetGroupByUuid | ( | const KIID & | aUuid | ) |
Return a NETLIST_GROUP by aUuid.
| aUuid | is the KIID of the NETLIST_GROUP. |
|
inline |
Definition at line 415 of file pcb_netlist.h.
References m_netChainColors.
Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().
|
inline |
Definition at line 381 of file pcb_netlist.h.
References m_netSignals.
Referenced by BOARD_NETLIST_UPDATER::ApplyChainAssignments().
|
inline |
Definition at line 398 of file pcb_netlist.h.
References m_netChainNetClasses.
Referenced by BOARD_NETLIST_UPDATER::ApplyChainNetclasses().
|
inline |
Definition at line 376 of file pcb_netlist.h.
References m_netChainTerminals.
Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().
|
inline |
Definition at line 369 of file pcb_netlist.h.
References empty(), and m_netChainTerminals.
|
inline |
Definition at line 374 of file common/netlist_reader/netlist.h.
References m_replaceFootprints.
Referenced by LoadNetlistFootprints().
|
inline |
Definition at line 483 of file pcb_netlist.h.
References m_replaceFootprints.
|
inline |
Definition at line 426 of file pcb_netlist.h.
References m_signalChainClasses.
|
inline |
Definition at line 432 of file pcb_netlist.h.
References m_signalChainClasses.
Referenced by BOARD_NETLIST_UPDATER::ApplyChainNetclasses().
|
inline |
Definition at line 409 of file pcb_netlist.h.
References m_netChainColors.
|
inline |
Definition at line 392 of file pcb_netlist.h.
References m_netChainNetClasses.
|
inline |
Definition at line 536 of file pcb_netlist.h.
References m_variantDescriptions, and m_variantNames.
Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().
|
inline |
Definition at line 563 of file pcb_netlist.h.
References m_variantDescriptions.
|
inline |
Definition at line 502 of file pcb_netlist.h.
References m_variantNames.
Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().
|
inline |
Definition at line 286 of file common/netlist_reader/netlist.h.
References m_components.
Referenced by LoadNetlistFootprints().
|
inline |
Definition at line 310 of file pcb_netlist.h.
References m_components.
|
inline |
Definition at line 371 of file common/netlist_reader/netlist.h.
References m_findByTimeStamp.
Referenced by LoadNetlistFootprints().
|
inline |
Definition at line 480 of file pcb_netlist.h.
References m_findByTimeStamp.
|
inline |
Definition at line 370 of file common/netlist_reader/netlist.h.
References m_findByTimeStamp.
|
inline |
Definition at line 479 of file pcb_netlist.h.
References m_findByTimeStamp.
|
inline |
Definition at line 359 of file pcb_netlist.h.
References m_netSignals.
|
inline |
Definition at line 373 of file common/netlist_reader/netlist.h.
References m_replaceFootprints.
|
inline |
Definition at line 482 of file pcb_netlist.h.
References m_replaceFootprints.
|
inline |
Net chain class assignment carried through the netlist for downstream tools.
Definition at line 421 of file pcb_netlist.h.
References m_signalChainClasses.
|
inline |
Stored as a #RRGGBB or #RRGGBBAA string; empty means "no override".
Definition at line 404 of file pcb_netlist.h.
References m_netChainColors.
|
inline |
Definition at line 387 of file pcb_netlist.h.
References m_netChainNetClasses.
| void NETLIST::SortByFPID | ( | ) |
Definition at line 251 of file common/netlist_reader/netlist.cpp.
References ByFPID(), and m_components.
Referenced by LoadNetlistFootprints().
| void NETLIST::SortByFPID | ( | ) |
| void NETLIST::SortByReference | ( | ) |
Definition at line 266 of file common/netlist_reader/netlist.cpp.
References m_components.
| void NETLIST::SortByReference | ( | ) |
|
protected |
Definition at line 391 of file common/netlist_reader/netlist.h.
Referenced by AddComponent(), AnyFootprintsLinked(), Clear(), Format(), GetComponent(), GetComponentByPath(), GetComponentByReference(), GetComponentByUuid(), GetCount(), IsEmpty(), SortByFPID(), and SortByReference().
|
protected |
Definition at line 394 of file common/netlist_reader/netlist.h.
Referenced by IsFindByTimeStamp(), NETLIST(), and SetFindByTimeStamp().
|
protected |
Definition at line 392 of file common/netlist_reader/netlist.h.
Referenced by AddGroup(), ApplyGroupMembership(), Clear(), and GetGroupByUuid().
|
private |
Definition at line 574 of file pcb_netlist.h.
Referenced by Clear(), GetNetChainColors(), GetSignalColor(), and SetSignalColor().
|
private |
Definition at line 573 of file pcb_netlist.h.
Referenced by Clear(), GetNetChainNetClasses(), GetSignalNetClass(), and SetSignalNetClass().
|
private |
Definition at line 572 of file pcb_netlist.h.
Referenced by AddSignalTerminalPin(), Clear(), GetNetChainTerminalPins(), and GetNetChainTerminals().
|
private |
Definition at line 571 of file pcb_netlist.h.
Referenced by Clear(), GetNetChainFor(), and SetNetChainFor().
|
protected |
Definition at line 395 of file common/netlist_reader/netlist.h.
Referenced by GetReplaceFootprints(), NETLIST(), and SetReplaceFootprints().
|
private |
Definition at line 575 of file pcb_netlist.h.
Referenced by Clear(), GetSignalChainClass(), GetSignalChainClasses(), and SetSignalChainClass().
|
private |
Definition at line 578 of file pcb_netlist.h.
Referenced by AddVariant(), Clear(), GetVariantDescription(), and GetVariantDescriptions().
|
private |
Definition at line 577 of file pcb_netlist.h.
Referenced by AddVariant(), Clear(), GetVariantDescription(), and GetVariantNames().