KiCad PCB EDA Suite
COMPONENT Class Reference

COMPONENT is used to store components and all of their related information found in a netlist. More...

#include <pcb_netlist.h>

Public Member Functions

 COMPONENT (const LIB_ID &aFPID, const wxString &aReference, const wxString &aValue, const KIID_PATH &aPath)
 
virtual ~COMPONENT ()
 
void AddNet (const wxString &aPinName, const wxString &aNetName, const wxString &aPinFunction)
 
unsigned GetNetCount () const
 
const COMPONENT_NETGetNet (unsigned aIndex) const
 
const COMPONENT_NETGetNet (const wxString &aPinName) const
 
void SortPins ()
 
void SetName (const wxString &aName)
 
const wxString & GetName () const
 
void SetLibrary (const wxString &aLibrary)
 
const wxString & GetLibrary () const
 
const wxString & GetReference () const
 
const wxString & GetValue () const
 
void SetProperties (std::map< wxString, wxString > &aProps)
 
const std::map< wxString, wxString > & GetProperties () const
 
void SetFPID (const LIB_ID &aFPID)
 
const LIB_IDGetFPID () const
 
void SetAltFPID (const LIB_ID &aFPID)
 
const LIB_IDGetAltFPID () const
 
const KIID_PATHGetPath () const
 
void SetFootprintFilters (const wxArrayString &aFilters)
 
const wxArrayString & GetFootprintFilters () const
 
void SetPinCount (int aPinCount)
 
int GetPinCount () const
 
MODULEGetModule (bool aRelease=false)
 
void SetModule (MODULE *aModule)
 
bool IsLibSource (const wxString &aLibrary, const wxString &aName) const
 
void Format (OUTPUTFORMATTER *aOut, int aNestLevel, int aCtl)
 

Private Attributes

COMPONENT_NETS m_nets
 list of nets shared by the component pins More...
 
wxArrayString m_footprintFilters
 Footprint filters found in netlist. More...
 
int m_pinCount
 Number of pins found in netlist. More...
 
wxString m_reference
 The component reference designator found in netlist. More...
 
wxString m_value
 The component value found in netlist. More...
 
KIID_PATH m_path
 A fully specified path to the component: [ sheetUUID, sheetUUID, .., componentUUID ]. More...
 
wxString m_name
 The name of the component in m_library used when it was placed on the schematic.. More...
 
wxString m_library
 The name of the component library where m_name was found. More...
 
LIB_ID m_fpid
 The LIB_ID of the footprint assigned to the component. More...
 
LIB_ID m_altFpid
 The alt LIB_ID of the footprint, when there are 2 different assigned footprints, One from the netlist, the other from the .cmp file. More...
 
std::unique_ptr< MODULEm_footprint
 The MODULE loaded for m_fpid. More...
 
std::map< wxString, wxString > m_properties
 Component-specific properties found in the netlist. More...
 

Static Private Attributes

static COMPONENT_NET m_emptyNet
 

Detailed Description

COMPONENT is used to store components and all of their related information found in a netlist.

Definition at line 80 of file pcb_netlist.h.

Constructor & Destructor Documentation

◆ COMPONENT()

COMPONENT::COMPONENT ( const LIB_ID aFPID,
const wxString &  aReference,
const wxString &  aValue,
const KIID_PATH aPath 
)
inline

Definition at line 114 of file pcb_netlist.h.

118  {
119  m_fpid = aFPID;
120  m_reference = aReference;
121  m_value = aValue;
122  m_pinCount = 0;
123  m_path = aPath;
124  }
KIID_PATH m_path
A fully specified path to the component: [ sheetUUID, sheetUUID, .., componentUUID ].
Definition: pcb_netlist.h:89
LIB_ID m_fpid
The LIB_ID of the footprint assigned to the component.
Definition: pcb_netlist.h:98
wxString m_value
The component value found in netlist.
Definition: pcb_netlist.h:86
wxString m_reference
The component reference designator found in netlist.
Definition: pcb_netlist.h:85
int m_pinCount
Number of pins found in netlist.
Definition: pcb_netlist.h:84

References m_fpid, m_path, m_pinCount, m_reference, and m_value.

◆ ~COMPONENT()

virtual COMPONENT::~COMPONENT ( )
inlinevirtual

Definition at line 126 of file pcb_netlist.h.

126 { };

Member Function Documentation

◆ AddNet()

void COMPONENT::AddNet ( const wxString &  aPinName,
const wxString &  aNetName,
const wxString &  aPinFunction 
)
inline

Definition at line 128 of file pcb_netlist.h.

129  {
130  m_nets.push_back( COMPONENT_NET( aPinName, aNetName, aPinFunction ) );
131  }
COMPONENT_NETS m_nets
list of nets shared by the component pins
Definition: pcb_netlist.h:82
COMPONENT_NET is used to store the component pin name to net name (and pin function) associations sto...
Definition: pcb_netlist.h:44

References m_nets.

Referenced by PCB_EDIT_FRAME::KiwayMailIn(), LEGACY_NETLIST_READER::loadNet(), and KICAD_NETLIST_PARSER::parseNet().

◆ Format()

void COMPONENT::Format ( OUTPUTFORMATTER aOut,
int  aNestLevel,
int  aCtl 
)

Definition at line 70 of file pcb_netlist.cpp.

71 {
72  int nl = aNestLevel;
73 
74  aOut->Print( nl, "(ref %s ", aOut->Quotew( m_reference ).c_str() );
75  aOut->Print( 0, "(fpid %s)\n", aOut->Quotew( m_fpid.Format() ).c_str() );
76 
77  if( ! ( aCtl & CTL_OMIT_EXTRA ) )
78  {
79  aOut->Print( nl+1, "(value %s)\n", aOut->Quotew( m_value ).c_str() );
80  aOut->Print( nl+1, "(name %s)\n", aOut->Quotew( m_name ).c_str() );
81  aOut->Print( nl+1, "(library %s)\n", aOut->Quotew( m_library ).c_str() );
82 
83  wxString path;
84 
85  for( const KIID& pathStep : m_path )
86  path += '/' + pathStep.AsString();
87 
88  aOut->Print( nl+1, "(timestamp %s)\n", aOut->Quotew( path ).c_str() );
89  }
90 
91  if( !( aCtl & CTL_OMIT_FILTERS ) && m_footprintFilters.GetCount() )
92  {
93  aOut->Print( nl+1, "(fp_filters" );
94 
95  for( unsigned i = 0; i < m_footprintFilters.GetCount(); ++i )
96  aOut->Print( 0, " %s", aOut->Quotew( m_footprintFilters[i] ).c_str() );
97 
98  aOut->Print( 0, ")\n" );
99  }
100 
101  if( !( aCtl & CTL_OMIT_NETS ) && m_nets.size() )
102  {
103  int llen = aOut->Print( nl+1, "(nets " );
104 
105  for( unsigned i = 0; i < m_nets.size(); ++i )
106  {
107  if( llen > 80 )
108  {
109  aOut->Print( 0, "\n" );
110  llen = aOut->Print( nl+1, " " );
111  }
112 
113  llen += m_nets[i].Format( aOut, 0, aCtl );
114  }
115 
116  aOut->Print( 0, ")\n" );
117  }
118 
119  aOut->Print( nl, ")\n" ); // </ref>
120 }
KIID_PATH m_path
A fully specified path to the component: [ sheetUUID, sheetUUID, .., componentUUID ].
Definition: pcb_netlist.h:89
wxString m_name
The name of the component in m_library used when it was placed on the schematic..
Definition: pcb_netlist.h:92
wxString m_library
The name of the component library where m_name was found.
Definition: pcb_netlist.h:95
wxArrayString m_footprintFilters
Footprint filters found in netlist.
Definition: pcb_netlist.h:83
COMPONENT_NETS m_nets
list of nets shared by the component pins
Definition: pcb_netlist.h:82
Definition: common.h:68
#define CTL_OMIT_FILTERS
Definition: pcb_netlist.h:283
std::string Quotew(const wxString &aWrapee)
Definition: richio.cpp:472
#define CTL_OMIT_NETS
Omit pads net names (useless in library)
UTF8 Format() const
Definition: lib_id.cpp:237
LIB_ID m_fpid
The LIB_ID of the footprint assigned to the component.
Definition: pcb_netlist.h:98
wxString m_value
The component value found in netlist.
Definition: pcb_netlist.h:86
wxString m_reference
The component reference designator found in netlist.
Definition: pcb_netlist.h:85
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
#define CTL_OMIT_EXTRA
Definition: pcb_netlist.h:281

References CTL_OMIT_EXTRA, CTL_OMIT_FILTERS, CTL_OMIT_NETS, LIB_ID::Format(), m_footprintFilters, m_fpid, m_library, m_name, m_nets, m_path, m_reference, m_value, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

◆ GetAltFPID()

const LIB_ID& COMPONENT::GetAltFPID ( ) const
inline

Definition at line 160 of file pcb_netlist.h.

160 { return m_altFpid; }
LIB_ID m_altFpid
The alt LIB_ID of the footprint, when there are 2 different assigned footprints, One from the netlist...
Definition: pcb_netlist.h:103

References m_altFpid.

Referenced by CVPCB_MAINFRAME::ReadNetListAndFpFiles().

◆ GetFootprintFilters()

const wxArrayString& COMPONENT::GetFootprintFilters ( ) const
inline

Definition at line 165 of file pcb_netlist.h.

165 { return m_footprintFilters; }
wxArrayString m_footprintFilters
Footprint filters found in netlist.
Definition: pcb_netlist.h:83

References m_footprintFilters.

Referenced by CVPCB_MAINFRAME::AutomaticFootprintMatching(), CVPCB_MAINFRAME::DisplayStatus(), and FOOTPRINTS_LISTBOX::SetFootprints().

◆ GetFPID()

◆ GetLibrary()

const wxString& COMPONENT::GetLibrary ( ) const
inline

Definition at line 145 of file pcb_netlist.h.

145 { return m_library; }
wxString m_library
The name of the component library where m_name was found.
Definition: pcb_netlist.h:95

References m_library.

◆ GetModule()

MODULE* COMPONENT::GetModule ( bool  aRelease = false)
inline

Definition at line 170 of file pcb_netlist.h.

171  {
172  return ( aRelease ) ? m_footprint.release() : m_footprint.get();
173  }
std::unique_ptr< MODULE > m_footprint
The MODULE loaded for m_fpid.
Definition: pcb_netlist.h:106

References m_footprint.

◆ GetName()

const wxString& COMPONENT::GetName ( void  ) const
inline

Definition at line 142 of file pcb_netlist.h.

142 { return m_name; }
wxString m_name
The name of the component in m_library used when it was placed on the schematic..
Definition: pcb_netlist.h:92

References m_name.

◆ GetNet() [1/2]

const COMPONENT_NET& COMPONENT::GetNet ( unsigned  aIndex) const
inline

◆ GetNet() [2/2]

const COMPONENT_NET & COMPONENT::GetNet ( const wxString &  aPinName) const

Definition at line 58 of file pcb_netlist.cpp.

59 {
60  for( const COMPONENT_NET& net : m_nets )
61  {
62  if( net.GetPinName() == aPinName )
63  return net;
64  }
65 
66  return m_emptyNet;
67 }
static COMPONENT_NET m_emptyNet
Definition: pcb_netlist.h:111
COMPONENT_NETS m_nets
list of nets shared by the component pins
Definition: pcb_netlist.h:82
COMPONENT_NET is used to store the component pin name to net name (and pin function) associations sto...
Definition: pcb_netlist.h:44

References m_emptyNet, and m_nets.

◆ GetNetCount()

unsigned COMPONENT::GetNetCount ( ) const
inline

Definition at line 133 of file pcb_netlist.h.

133 { return m_nets.size(); }
COMPONENT_NETS m_nets
list of nets shared by the component pins
Definition: pcb_netlist.h:82

References m_nets.

Referenced by TEST_NETLISTS_FIXTURE::compareNetlists(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_LVS::testFootprints(), and BOARD_NETLIST_UPDATER::updateCopperZoneNets().

◆ GetPath()

const KIID_PATH& COMPONENT::GetPath ( ) const
inline

Definition at line 162 of file pcb_netlist.h.

162 { return m_path; }
KIID_PATH m_path
A fully specified path to the component: [ sheetUUID, sheetUUID, .., componentUUID ].
Definition: pcb_netlist.h:89

References m_path.

Referenced by CVPCB_MAINFRAME::AssociateFootprint(), TEST_NETLISTS_FIXTURE::compareNetlists(), PCB_EDIT_FRAME::LoadFootprints(), BOARD_NETLIST_UPDATER::updateComponentParameters(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ GetPinCount()

int COMPONENT::GetPinCount ( ) const
inline

Definition at line 168 of file pcb_netlist.h.

168 { return m_pinCount; }
int m_pinCount
Number of pins found in netlist.
Definition: pcb_netlist.h:84

References m_pinCount.

Referenced by CVPCB_MAINFRAME::DisplayStatus(), and FOOTPRINTS_LISTBOX::SetFootprints().

◆ GetProperties()

const std::map<wxString, wxString>& COMPONENT::GetProperties ( ) const
inline

Definition at line 154 of file pcb_netlist.h.

154 { return m_properties; }
std::map< wxString, wxString > m_properties
Component-specific properties found in the netlist.
Definition: pcb_netlist.h:109

References m_properties.

Referenced by BOARD_NETLIST_UPDATER::deleteUnusedComponents(), BOARD_NETLIST_UPDATER::updateComponentParameters(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ GetReference()

◆ GetValue()

const wxString& COMPONENT::GetValue ( ) const
inline

◆ IsLibSource()

bool COMPONENT::IsLibSource ( const wxString &  aLibrary,
const wxString &  aName 
) const
inline

Definition at line 177 of file pcb_netlist.h.

178  {
179  return aLibrary == m_library && aName == m_name;
180  }
wxString m_name
The name of the component in m_library used when it was placed on the schematic..
Definition: pcb_netlist.h:92
wxString m_library
The name of the component library where m_name was found.
Definition: pcb_netlist.h:95

References m_library, and m_name.

Referenced by KICAD_NETLIST_PARSER::parseLibPartList().

◆ SetAltFPID()

void COMPONENT::SetAltFPID ( const LIB_ID aFPID)
inline

Definition at line 159 of file pcb_netlist.h.

159 { m_altFpid = aFPID; }
LIB_ID m_altFpid
The alt LIB_ID of the footprint, when there are 2 different assigned footprints, One from the netlist...
Definition: pcb_netlist.h:103

References m_altFpid.

Referenced by CMP_READER::Load().

◆ SetFootprintFilters()

void COMPONENT::SetFootprintFilters ( const wxArrayString &  aFilters)
inline

Definition at line 164 of file pcb_netlist.h.

164 { m_footprintFilters = aFilters; }
wxArrayString m_footprintFilters
Footprint filters found in netlist.
Definition: pcb_netlist.h:83

References m_footprintFilters.

Referenced by LEGACY_NETLIST_READER::loadFootprintFilters(), and KICAD_NETLIST_PARSER::parseLibPartList().

◆ SetFPID()

void COMPONENT::SetFPID ( const LIB_ID aFPID)
inline

Definition at line 156 of file pcb_netlist.h.

156 { m_fpid = aFPID; }
LIB_ID m_fpid
The LIB_ID of the footprint assigned to the component.
Definition: pcb_netlist.h:98

References m_fpid.

Referenced by CVPCB_MAINFRAME::AssociateFootprint(), CMP_READER::Load(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), and CVPCB_MAINFRAME::ReadSchematicNetlist().

◆ SetLibrary()

void COMPONENT::SetLibrary ( const wxString &  aLibrary)
inline

Definition at line 144 of file pcb_netlist.h.

144 { m_library = aLibrary; }
wxString m_library
The name of the component library where m_name was found.
Definition: pcb_netlist.h:95

References m_library.

Referenced by KICAD_NETLIST_PARSER::parseComponent().

◆ SetModule()

void COMPONENT::SetModule ( MODULE aModule)

Definition at line 40 of file pcb_netlist.cpp.

41 {
42  m_footprint.reset( aModule );
43 
44  if( aModule == NULL )
45  return;
46 
47  aModule->SetReference( m_reference );
48  aModule->SetValue( m_value );
49  aModule->SetFPID( m_fpid );
50  aModule->SetPath( m_path );
51  aModule->SetProperties( m_properties );
52 }
KIID_PATH m_path
A fully specified path to the component: [ sheetUUID, sheetUUID, .., componentUUID ].
Definition: pcb_netlist.h:89
#define NULL
void SetReference(const wxString &aReference)
Function SetReference.
Definition: class_module.h:461
std::map< wxString, wxString > m_properties
Component-specific properties found in the netlist.
Definition: pcb_netlist.h:109
LIB_ID m_fpid
The LIB_ID of the footprint assigned to the component.
Definition: pcb_netlist.h:98
void SetProperties(const std::map< wxString, wxString > &aProps)
Definition: class_module.h:499
wxString m_value
The component value found in netlist.
Definition: pcb_netlist.h:86
void SetValue(const wxString &aValue)
Function SetValue.
Definition: class_module.h:485
wxString m_reference
The component reference designator found in netlist.
Definition: pcb_netlist.h:85
void SetPath(const KIID_PATH &aPath)
Definition: class_module.h:238
std::unique_ptr< MODULE > m_footprint
The MODULE loaded for m_fpid.
Definition: pcb_netlist.h:106
void SetFPID(const LIB_ID &aFPID)
Definition: class_module.h:229

References m_footprint, m_fpid, m_path, m_properties, m_reference, m_value, NULL, MODULE::SetFPID(), MODULE::SetPath(), MODULE::SetProperties(), MODULE::SetReference(), and MODULE::SetValue().

Referenced by PCB_EDIT_FRAME::LoadFootprints().

◆ SetName()

void COMPONENT::SetName ( const wxString &  aName)
inline

Definition at line 141 of file pcb_netlist.h.

141 { m_name = aName;}
wxString m_name
The name of the component in m_library used when it was placed on the schematic..
Definition: pcb_netlist.h:92

References m_name.

Referenced by LEGACY_NETLIST_READER::loadComponent(), and KICAD_NETLIST_PARSER::parseComponent().

◆ SetPinCount()

void COMPONENT::SetPinCount ( int  aPinCount)
inline

Definition at line 167 of file pcb_netlist.h.

167 { m_pinCount = aPinCount; }
int m_pinCount
Number of pins found in netlist.
Definition: pcb_netlist.h:84

References m_pinCount.

Referenced by KICAD_NETLIST_PARSER::parseLibPartList().

◆ SetProperties()

void COMPONENT::SetProperties ( std::map< wxString, wxString > &  aProps)
inline

Definition at line 150 of file pcb_netlist.h.

151  {
152  m_properties = std::move( aProps );
153  }
std::map< wxString, wxString > m_properties
Component-specific properties found in the netlist.
Definition: pcb_netlist.h:109

References m_properties.

Referenced by KICAD_NETLIST_PARSER::parseComponent().

◆ SortPins()

void COMPONENT::SortPins ( )
inline

Definition at line 139 of file pcb_netlist.h.

139 { sort( m_nets.begin(), m_nets.end() ); }
COMPONENT_NETS m_nets
list of nets shared by the component pins
Definition: pcb_netlist.h:82

References m_nets.

Member Data Documentation

◆ m_altFpid

LIB_ID COMPONENT::m_altFpid
private

The alt LIB_ID of the footprint, when there are 2 different assigned footprints, One from the netlist, the other from the .cmp file.

this one is a copy of the netlist footprint assignment

Definition at line 103 of file pcb_netlist.h.

Referenced by GetAltFPID(), and SetAltFPID().

◆ m_emptyNet

COMPONENT_NET COMPONENT::m_emptyNet
staticprivate

Definition at line 111 of file pcb_netlist.h.

Referenced by GetNet().

◆ m_footprint

std::unique_ptr< MODULE > COMPONENT::m_footprint
private

The MODULE loaded for m_fpid.

Definition at line 106 of file pcb_netlist.h.

Referenced by GetModule(), and SetModule().

◆ m_footprintFilters

wxArrayString COMPONENT::m_footprintFilters
private

Footprint filters found in netlist.

Definition at line 83 of file pcb_netlist.h.

Referenced by Format(), GetFootprintFilters(), and SetFootprintFilters().

◆ m_fpid

LIB_ID COMPONENT::m_fpid
private

The LIB_ID of the footprint assigned to the component.

Definition at line 98 of file pcb_netlist.h.

Referenced by COMPONENT(), Format(), GetFPID(), SetFPID(), and SetModule().

◆ m_library

wxString COMPONENT::m_library
private

The name of the component library where m_name was found.

Definition at line 95 of file pcb_netlist.h.

Referenced by Format(), GetLibrary(), IsLibSource(), and SetLibrary().

◆ m_name

wxString COMPONENT::m_name
private

The name of the component in m_library used when it was placed on the schematic..

Definition at line 92 of file pcb_netlist.h.

Referenced by Format(), GetName(), IsLibSource(), and SetName().

◆ m_nets

COMPONENT_NETS COMPONENT::m_nets
private

list of nets shared by the component pins

Definition at line 82 of file pcb_netlist.h.

Referenced by AddNet(), Format(), GetNet(), GetNetCount(), and SortPins().

◆ m_path

KIID_PATH COMPONENT::m_path
private

A fully specified path to the component: [ sheetUUID, sheetUUID, .., componentUUID ].

Definition at line 89 of file pcb_netlist.h.

Referenced by COMPONENT(), Format(), GetPath(), and SetModule().

◆ m_pinCount

int COMPONENT::m_pinCount
private

Number of pins found in netlist.

Definition at line 84 of file pcb_netlist.h.

Referenced by COMPONENT(), GetPinCount(), and SetPinCount().

◆ m_properties

std::map<wxString, wxString> COMPONENT::m_properties
private

Component-specific properties found in the netlist.

Definition at line 109 of file pcb_netlist.h.

Referenced by GetProperties(), SetModule(), and SetProperties().

◆ m_reference

wxString COMPONENT::m_reference
private

The component reference designator found in netlist.

Definition at line 85 of file pcb_netlist.h.

Referenced by COMPONENT(), Format(), GetReference(), and SetModule().

◆ m_value

wxString COMPONENT::m_value
private

The component value found in netlist.

Definition at line 86 of file pcb_netlist.h.

Referenced by COMPONENT(), Format(), GetValue(), and SetModule().


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