NETLIST Class Reference

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

Detailed Description

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.

Constructor & Destructor Documentation

NETLIST()

NETLIST::NETLIST ( )

inline

Definition at line 276 of file pcb_netlist.h.

References m_findByTimeStamp, and m_replaceFootprints.

Member Function Documentation

AddComponent()

void NETLIST::AddComponent

(

COMPONENT *

aComponent

)

Add aComponent to the NETLIST.

Note

If aComponent already exists in the NETLIST, aComponent is deleted to prevent memory leaks. An assertion is raised in debug builds.

Parameters

aComponent

is the COMPONENT to save to the NETLIST.

Definition at line 206 of file pcb_netlist.cpp.

References m_components.

AddGroup()

void NETLIST::AddGroup

(

NETLIST_GROUP *

aGroup

)

Note

If aGroup already exists in the NETLIST, aGroup is deleted to prevent memory leaks. An assertion is raised in debug builds.

Parameters

aGroup

is the NETLIST_GROUP to save to the NETLIST.

Definition at line 212 of file pcb_netlist.cpp.

References m_groups.

AnyFootprintsLinked()

bool NETLIST::AnyFootprintsLinked

(

)

const

Returns

true if any component with a footprint link is found.

Definition at line 320 of file pcb_netlist.cpp.

References empty(), and m_components.

ApplyGroupMembership()

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 332 of file pcb_netlist.cpp.

References GetComponentByUuid(), group, m_groups, and COMPONENT::SetGroup().

Clear()

void NETLIST::Clear ( )

inline

Remove all components from the netlist.

Definition at line 290 of file pcb_netlist.h.

References m_components.

Format()

void NETLIST::Format	(	const char *	aDocName,
		OUTPUTFORMATTER *	aOut,
		int	aNestLevel,
		int	aCtl = 0 )

Definition at line 191 of file pcb_netlist.cpp.

References m_components, and OUTPUTFORMATTER::Print().

Referenced by FormatCvpcbNetlist().

FormatCvpcbNetlist()

void NETLIST::FormatCvpcbNetlist ( OUTPUTFORMATTER * aOut )

inline

Definition at line 380 of file pcb_netlist.h.

References CTL_FOR_CVPCB, and Format().

GetComponent()

COMPONENT * NETLIST::GetComponent ( unsigned aIndex )

inline

Return the COMPONENT at aIndex.

Parameters

aIndex

the index in m_components to fetch.

Returns

a pointer to the COMPONENT at Index.

Definition at line 303 of file pcb_netlist.h.

References m_components.

Referenced by TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), PCB_EDIT_FRAME::LoadFootprints(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

GetComponentByPath()

COMPONENT * NETLIST::GetComponentByPath

(

const KIID_PATH &

aPath

)

Return a COMPONENT by aPath.

Parameters

aPath

is the KIID_PATH [ sheetUUID, .., compUUID ] of the COMPONENT.

Returns

a pointer to the COMPONENT that matches aPath if found. Otherwise NULL.

Definition at line 246 of file pcb_netlist.cpp.

References m_components.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

GetComponentByReference()

COMPONENT * NETLIST::GetComponentByReference

(

const wxString &

aReference

)

Return a COMPONENT by aReference.

Parameters

aReference

is the reference designator the COMPONENT.

Returns

a pointer to the COMPONENT that matches aReference if found. Otherwise NULL.

Definition at line 229 of file pcb_netlist.cpp.

References m_components.

Referenced by CMP_READER::Load(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

GetComponentByUuid()

COMPONENT * NETLIST::GetComponentByUuid

(

const KIID &

aUuid

)

Return a COMPONENT by aUuid.

Parameters

aUuid

is the KIID of the COMPONENT.

Returns

a pointer to the COMPONENT that matches aUuid if found. Otherwise NULL.

Definition at line 272 of file pcb_netlist.cpp.

References m_components.

Referenced by ApplyGroupMembership().

GetCount()

unsigned NETLIST::GetCount ( ) const

inline

Returns

the number of components in the netlist.

Definition at line 295 of file pcb_netlist.h.

References m_components.

Referenced by TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), PCB_EDIT_FRAME::LoadFootprints(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

GetGroupByUuid()

NETLIST_GROUP * NETLIST::GetGroupByUuid

(

const KIID &

aUuid

)

Return a NETLIST_GROUP by aUuid.

Parameters

aUuid

is the KIID of the NETLIST_GROUP.

Returns

a pointer to the NETLIST_GROUP that matches aUuid if found. Otherwise NULL.

Definition at line 217 of file pcb_netlist.cpp.

References group, and m_groups.

Referenced by BOARD_NETLIST_UPDATER::updateGroups().

GetReplaceFootprints()

bool NETLIST::GetReplaceFootprints ( ) const

inline

Definition at line 369 of file pcb_netlist.h.

References m_replaceFootprints.

Referenced by PCB_EDIT_FRAME::LoadFootprints().

IsEmpty()

bool NETLIST::IsEmpty ( ) const

inline

Returns

true if there are no components in the netlist.

Definition at line 285 of file pcb_netlist.h.

References m_components.

Referenced by PCB_EDIT_FRAME::LoadFootprints().

IsFindByTimeStamp()

bool NETLIST::IsFindByTimeStamp ( ) const

inline

Definition at line 366 of file pcb_netlist.h.

References m_findByTimeStamp.

Referenced by PCB_EDIT_FRAME::LoadFootprints().

SetFindByTimeStamp()

void NETLIST::SetFindByTimeStamp ( bool aFindByTimeStamp )

inline

Definition at line 365 of file pcb_netlist.h.

References m_findByTimeStamp.

SetReplaceFootprints()

void NETLIST::SetReplaceFootprints ( bool aReplace )

inline

Definition at line 368 of file pcb_netlist.h.

References m_replaceFootprints.

SortByFPID()

void NETLIST::SortByFPID

(

)

Definition at line 299 of file pcb_netlist.cpp.

References ByFPID(), and m_components.

Referenced by PCB_EDIT_FRAME::LoadFootprints().

SortByReference()

void NETLIST::SortByReference

(

)

Definition at line 314 of file pcb_netlist.cpp.

References m_components.

Member Data Documentation

m_components

COMPONENTS NETLIST::m_components

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().

m_findByTimeStamp

bool NETLIST::m_findByTimeStamp

private

Definition at line 390 of file pcb_netlist.h.

Referenced by IsFindByTimeStamp(), NETLIST(), and SetFindByTimeStamp().

m_groups

NETLIST_GROUPS NETLIST::m_groups

private

Definition at line 387 of file pcb_netlist.h.

Referenced by AddGroup(), ApplyGroupMembership(), and GetGroupByUuid().

m_replaceFootprints

bool NETLIST::m_replaceFootprints

private

Definition at line 391 of file pcb_netlist.h.

Referenced by GetReplaceFootprints(), NETLIST(), and SetReplaceFootprints().

---

The documentation for this class was generated from the following files:

• pcb_netlist.h
• pcb_netlist.cpp