KiCad PCB EDA Suite
|
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD. More...
#include <pcb_netlist.h>
Public Member Functions | |
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) |
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) |
Private Attributes | |
COMPONENTS | m_components |
NETLIST_GROUPS | m_groups |
bool | m_findByTimeStamp |
bool | m_replaceFootprints |
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD.
Definition at line 273 of file pcb_netlist.h.
|
inline |
Definition at line 276 of file pcb_netlist.h.
void NETLIST::AddComponent | ( | COMPONENT * | aComponent | ) |
Add aComponent to the NETLIST.
Definition at line 162 of file pcb_netlist.cpp.
References m_components.
Referenced by LEGACY_NETLIST_READER::loadComponent(), and KICAD_NETLIST_PARSER::parseComponent().
void NETLIST::AddGroup | ( | NETLIST_GROUP * | aGroup | ) |
aGroup | is the NETLIST_GROUP to save to the NETLIST. |
Definition at line 168 of file pcb_netlist.cpp.
References m_groups.
Referenced by KICAD_NETLIST_PARSER::parseGroup().
bool NETLIST::AnyFootprintsLinked | ( | ) | const |
Definition at line 276 of file pcb_netlist.cpp.
References empty(), and m_components.
Referenced by CVPCB_MAINFRAME::readNetListAndFpFiles().
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 288 of file pcb_netlist.cpp.
References GetComponentByUuid(), group, m_groups, and COMPONENT::SetGroup().
Referenced by KICAD_NETLIST_PARSER::Parse().
|
inline |
Remove all components from the netlist.
Definition at line 290 of file pcb_netlist.h.
References m_components.
Referenced by CVPCB_MAINFRAME::readSchematicNetlist().
void NETLIST::Format | ( | const char * | aDocName, |
OUTPUTFORMATTER * | aOut, | ||
int | aNestLevel, | ||
int | aCtl = 0 |
||
) |
Definition at line 147 of file pcb_netlist.cpp.
References m_components, and OUTPUTFORMATTER::Print().
Referenced by FormatCvpcbNetlist().
|
inline |
Definition at line 380 of file pcb_netlist.h.
References CTL_FOR_CVPCB, and Format().
Referenced by CVPCB_MAINFRAME::SaveFootprintAssociation().
|
inline |
Return the COMPONENT at aIndex.
aIndex | the index in m_components to fetch. |
Definition at line 303 of file pcb_netlist.h.
References m_components.
Referenced by CVPCB_MAINFRAME::AssociateFootprint(), CVPCB_MAINFRAME::AutomaticFootprintMatching(), TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), CVPCB_MAINFRAME::GetComponentIndices(), CVPCB_MAINFRAME::GetSelectedComponent(), PCB_EDIT_FRAME::LoadFootprints(), KICAD_NETLIST_READER::LoadNetlist(), KICAD_NETLIST_PARSER::parseLibPartList(), CVPCB_MAINFRAME::readNetListAndFpFiles(), CVPCB_MAINFRAME::readSchematicNetlist(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), and BOARD_NETLIST_UPDATER::UpdateNetlist().
Return a COMPONENT by aPath.
Definition at line 202 of file pcb_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 185 of file pcb_netlist.cpp.
References m_components.
Referenced by CMP_READER::Load(), LEGACY_NETLIST_READER::loadFootprintFilters(), KICAD_NETLIST_PARSER::parseNet(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), and BOARD_NETLIST_UPDATER::UpdateNetlist().
Return a COMPONENT by aUuid.
Definition at line 228 of file pcb_netlist.cpp.
References m_components.
Referenced by ApplyGroupMembership().
|
inline |
Definition at line 295 of file pcb_netlist.h.
References m_components.
Referenced by CVPCB_MAINFRAME::AutomaticFootprintMatching(), TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), CVPCB_MAINFRAME::GetComponentIndices(), CVPCB_MAINFRAME::GetSelectedComponent(), PCB_EDIT_FRAME::LoadFootprints(), KICAD_NETLIST_READER::LoadNetlist(), KICAD_NETLIST_PARSER::parseLibPartList(), CVPCB_MAINFRAME::readNetListAndFpFiles(), CVPCB_MAINFRAME::readSchematicNetlist(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), and BOARD_NETLIST_UPDATER::UpdateNetlist().
NETLIST_GROUP * NETLIST::GetGroupByUuid | ( | const KIID & | aUuid | ) |
Return a NETLIST_GROUP by aUuid.
aUuid | is the KIID of the NETLIST_GROUP. |
Definition at line 173 of file pcb_netlist.cpp.
References group, and m_groups.
Referenced by BOARD_NETLIST_UPDATER::updateGroups().
|
inline |
Definition at line 369 of file pcb_netlist.h.
References m_replaceFootprints.
Referenced by PCB_EDIT_FRAME::LoadFootprints().
|
inline |
Definition at line 285 of file pcb_netlist.h.
References m_components.
Referenced by CVPCB_MAINFRAME::AssociateFootprint(), CVPCB_MAINFRAME::AutomaticFootprintMatching(), CVPCB_MAINFRAME::GetComponentIndices(), PCB_EDIT_FRAME::LoadFootprints(), and CVPCB_MAINFRAME::SendComponentSelectionToSch().
|
inline |
Definition at line 366 of file pcb_netlist.h.
References m_findByTimeStamp.
Referenced by PCB_EDIT_FRAME::LoadFootprints().
|
inline |
Definition at line 365 of file pcb_netlist.h.
References m_findByTimeStamp.
Referenced by DIALOG_UPDATE_PCB::PerformUpdate().
|
inline |
Definition at line 368 of file pcb_netlist.h.
References m_replaceFootprints.
Referenced by DIALOG_UPDATE_PCB::PerformUpdate().
void NETLIST::SortByFPID | ( | ) |
Definition at line 255 of file pcb_netlist.cpp.
References ByFPID(), and m_components.
Referenced by PCB_EDIT_FRAME::LoadFootprints().
void NETLIST::SortByReference | ( | ) |
Definition at line 270 of file pcb_netlist.cpp.
References m_components.
Referenced by DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), and CVPCB_MAINFRAME::readSchematicNetlist().
|
private |
Definition at line 386 of file pcb_netlist.h.
Referenced by AddComponent(), AnyFootprintsLinked(), Clear(), Format(), GetComponent(), GetComponentByPath(), GetComponentByReference(), GetComponentByUuid(), GetCount(), IsEmpty(), SortByFPID(), and SortByReference().
|
private |
Definition at line 390 of file pcb_netlist.h.
Referenced by IsFindByTimeStamp(), and SetFindByTimeStamp().
|
private |
Definition at line 387 of file pcb_netlist.h.
Referenced by AddGroup(), ApplyGroupMembership(), and GetGroupByUuid().
|
private |
Definition at line 391 of file pcb_netlist.h.
Referenced by GetReplaceFootprints(), and SetReplaceFootprints().