KiCad PCB EDA Suite
COMPONENT Class Reference

Class 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 wxString &aTimeStamp)
 
virtual ~COMPONENT ()
 
void AddNet (const wxString &aPinName, const wxString &aNetName)
 
unsigned GetNetCount () const
 
const COMPONENT_NETGetNet (unsigned aIndex) const
 
const COMPONENT_NETGetNet (const wxString &aPinName)
 
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 SetFPID (const LIB_ID &aFPID)
 
void SetAltFPID (const LIB_ID &aFPID)
 
const LIB_IDGetFPID () const
 
const LIB_IDGetAltFPID () const
 
const wxString & GetTimeStamp () const
 
void SetFootprintFilters (const wxArrayString &aFilterList)
 
const wxArrayString & GetFootprintFilters () const
 
MODULEGetModule (bool aRelease=false)
 
void SetModule (MODULE *aModule)
 
bool IsLibSource (const wxString &aLibrary, const wxString &aName) const
 
bool FootprintChanged () const
 
void Format (OUTPUTFORMATTER *aOut, int aNestLevel, int aCtl)
 

Private Attributes

COMPONENT_NETS m_nets
 
wxArrayString m_footprintFilters
 Footprint filters 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...
 
wxString m_timeStamp
 The component full time stamp found in netlist. 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...
 
bool m_footprintChanged
 Set to true if m_fpid was changed when the footprint link file was read. More...
 

Static Private Attributes

static COMPONENT_NET m_emptyNet
 

Detailed Description

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

Definition at line 83 of file pcb_netlist.h.

Constructor & Destructor Documentation

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

Definition at line 116 of file pcb_netlist.h.

120  {
121  m_fpid = aFPID;
122  m_reference = aReference;
123  m_value = aValue;
124  m_timeStamp = aTimeStamp;
125  m_footprintChanged = false;
126  }
wxString m_timeStamp
The component full time stamp found in netlist.
Definition: pcb_netlist.h:91
bool m_footprintChanged
Set to true if m_fpid was changed when the footprint link file was read.
Definition: pcb_netlist.h:111
LIB_ID m_fpid
The LIB_ID of the footprint assigned to the component.
Definition: pcb_netlist.h:100
wxString m_value
The component value found in netlist.
Definition: pcb_netlist.h:88
wxString m_reference
The component reference designator found in netlist.
Definition: pcb_netlist.h:87
virtual COMPONENT::~COMPONENT ( )
inlinevirtual

Definition at line 128 of file pcb_netlist.h.

128 { };

Member Function Documentation

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

Definition at line 130 of file pcb_netlist.h.

Referenced by KICAD_NETLIST_PARSER::parseNet().

131  {
132  m_nets.push_back( COMPONENT_NET( aPinName, aNetName ) );
133  }
COMPONENT_NETS m_nets
Definition: pcb_netlist.h:85
Class COMPONENT_NET is used to store the component pin name to net name associations stored in a netl...
Definition: pcb_netlist.h:48
bool COMPONENT::FootprintChanged ( ) const
inline

Definition at line 189 of file pcb_netlist.h.

References m_footprintChanged.

189 { return m_footprintChanged; }
bool m_footprintChanged
Set to true if m_fpid was changed when the footprint link file was read.
Definition: pcb_netlist.h:111
void COMPONENT::Format ( OUTPUTFORMATTER aOut,
int  aNestLevel,
int  aCtl 
)

Definition at line 76 of file pcb_netlist.cpp.

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

77 {
78  int nl = aNestLevel;
79 
80  aOut->Print( nl, "(ref %s ", aOut->Quotew( m_reference ).c_str() );
81  aOut->Print( 0, "(fpid %s)\n", aOut->Quotew( m_fpid.Format() ).c_str() );
82 
83  if( ! ( aCtl & CTL_OMIT_EXTRA ) )
84  {
85  aOut->Print( nl+1, "(value %s)\n", aOut->Quotew( m_value ).c_str() );
86  aOut->Print( nl+1, "(name %s)\n", aOut->Quotew( m_name ).c_str() );
87  aOut->Print( nl+1, "(library %s)\n", aOut->Quotew( m_library ).c_str() );
88  aOut->Print( nl+1, "(timestamp %s)\n", aOut->Quotew( m_timeStamp ).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 }
wxString m_name
The name of the component in m_library used when it was placed on the schematic.. ...
Definition: pcb_netlist.h:94
wxString m_library
The name of the component library where m_name was found.
Definition: pcb_netlist.h:97
wxArrayString m_footprintFilters
Footprint filters found in netlist.
Definition: pcb_netlist.h:86
COMPONENT_NETS m_nets
Definition: pcb_netlist.h:85
wxString m_timeStamp
The component full time stamp found in netlist.
Definition: pcb_netlist.h:91
#define CTL_OMIT_FILTERS
Definition: pcb_netlist.h:342
std::string Quotew(const wxString &aWrapee)
Definition: richio.cpp:486
#define CTL_OMIT_NETS
Omit pads net names (useless in library)
LIB_ID m_fpid
The LIB_ID of the footprint assigned to the component.
Definition: pcb_netlist.h:100
wxString m_value
The component value found in netlist.
Definition: pcb_netlist.h:88
UTF8 Format() const
Function Format.
Definition: lib_id.cpp:263
wxString m_reference
The component reference designator found in netlist.
Definition: pcb_netlist.h:87
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
#define CTL_OMIT_EXTRA
Definition: pcb_netlist.h:340
const LIB_ID& COMPONENT::GetAltFPID ( ) const
inline

Definition at line 166 of file pcb_netlist.h.

References m_altFpid.

Referenced by CVPCB_MAINFRAME::ReadNetListAndLinkFiles().

166 { 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:105
const wxArrayString& COMPONENT::GetFootprintFilters ( ) const
inline

Definition at line 175 of file pcb_netlist.h.

References m_footprintFilters.

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

175 { return m_footprintFilters; }
wxArrayString m_footprintFilters
Footprint filters found in netlist.
Definition: pcb_netlist.h:86
const wxString& COMPONENT::GetLibrary ( ) const
inline

Definition at line 147 of file pcb_netlist.h.

References m_library.

147 { return m_library; }
wxString m_library
The name of the component library where m_name was found.
Definition: pcb_netlist.h:97
MODULE* COMPONENT::GetModule ( bool  aRelease = false)
inline

Definition at line 177 of file pcb_netlist.h.

Referenced by BOARD_NETLIST_UPDATER::addNewComponent(), BOARD_NETLIST_UPDATER::replaceComponent(), and BOARD::ReplaceNetlist().

178  {
179  return ( aRelease ) ? m_footprint.release() : m_footprint.get();
180  }
std::unique_ptr< MODULE > m_footprint
The MODULE loaded for m_fpid.
Definition: pcb_netlist.h:108
const wxString& COMPONENT::GetName ( ) const
inline

Definition at line 144 of file pcb_netlist.h.

References m_name.

144 { 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:94
const COMPONENT_NET& COMPONENT::GetNet ( unsigned  aIndex) const
inline
const COMPONENT_NET & COMPONENT::GetNet ( const wxString &  aPinName)

Definition at line 64 of file pcb_netlist.cpp.

References m_emptyNet, and m_nets.

65 {
66  for( unsigned i = 0; i < m_nets.size(); i++ )
67  {
68  if( m_nets[i].GetPinName() == aPinName )
69  return m_nets[i];
70  }
71 
72  return m_emptyNet;
73 }
static COMPONENT_NET m_emptyNet
Definition: pcb_netlist.h:113
COMPONENT_NETS m_nets
Definition: pcb_netlist.h:85
unsigned COMPONENT::GetNetCount ( ) const
inline

Definition at line 135 of file pcb_netlist.h.

Referenced by BOARD::ReplaceNetlist(), FOOTPRINTS_LISTBOX::SetFootprints(), and BOARD_NETLIST_UPDATER::testConnectivity().

135 { return m_nets.size(); }
COMPONENT_NETS m_nets
Definition: pcb_netlist.h:85
const wxString& COMPONENT::GetTimeStamp ( ) const
inline

Definition at line 168 of file pcb_netlist.h.

References m_timeStamp.

Referenced by BOARD_NETLIST_UPDATER::addNewComponent(), BOARD::ReplaceNetlist(), BOARD_NETLIST_UPDATER::updateComponentParameters(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

168 { return m_timeStamp; }
wxString m_timeStamp
The component full time stamp found in netlist.
Definition: pcb_netlist.h:91
const wxString& COMPONENT::GetValue ( ) const
inline
bool COMPONENT::IsLibSource ( const wxString &  aLibrary,
const wxString &  aName 
) const
inline

Definition at line 184 of file pcb_netlist.h.

References m_name.

Referenced by KICAD_NETLIST_PARSER::parseLibPartList().

185  {
186  return aLibrary == m_library && aName == m_name;
187  }
wxString m_name
The name of the component in m_library used when it was placed on the schematic.. ...
Definition: pcb_netlist.h:94
wxString m_library
The name of the component library where m_name was found.
Definition: pcb_netlist.h:97
void COMPONENT::SetAltFPID ( const LIB_ID aFPID)
inline

Definition at line 159 of file pcb_netlist.h.

Referenced by CMP_READER::Load().

160  {
161  m_altFpid = aFPID;
162  }
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:105
void COMPONENT::SetFootprintFilters ( const wxArrayString &  aFilterList)
inline

Definition at line 170 of file pcb_netlist.h.

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

171  {
172  m_footprintFilters = aFilterList;
173  }
wxArrayString m_footprintFilters
Footprint filters found in netlist.
Definition: pcb_netlist.h:86
void COMPONENT::SetFPID ( const LIB_ID aFPID)
inline

Definition at line 153 of file pcb_netlist.h.

References LIB_ID::empty().

Referenced by CVPCB_MAINFRAME::DelAssociations(), CMP_READER::Load(), CVPCB_MAINFRAME::ReadNetListAndLinkFiles(), CVPCB_MAINFRAME::ReadSchematicNetlist(), and CVPCB_MAINFRAME::SetNewPkg().

154  {
155  m_footprintChanged = !m_fpid.empty() && (m_fpid != aFPID);
156  m_fpid = aFPID;
157  }
bool empty() const
Function empty.
Definition: lib_id.h:199
bool m_footprintChanged
Set to true if m_fpid was changed when the footprint link file was read.
Definition: pcb_netlist.h:111
LIB_ID m_fpid
The LIB_ID of the footprint assigned to the component.
Definition: pcb_netlist.h:100
void COMPONENT::SetLibrary ( const wxString &  aLibrary)
inline

Definition at line 146 of file pcb_netlist.h.

Referenced by KICAD_NETLIST_PARSER::parseComponent().

146 { m_library = aLibrary; }
wxString m_library
The name of the component library where m_name was found.
Definition: pcb_netlist.h:97
void COMPONENT::SetModule ( MODULE aModule)

Definition at line 47 of file pcb_netlist.cpp.

References m_footprint, m_fpid, m_reference, m_timeStamp, m_value, MODULE::SetFPID(), MODULE::SetPath(), MODULE::SetReference(), and MODULE::SetValue().

Referenced by PCB_EDIT_FRAME::LoadFootprints().

48 {
49  m_footprint.reset( aModule );
50 
51  if( aModule == NULL )
52  return;
53 
54  aModule->SetReference( m_reference );
55  aModule->SetValue( m_value );
56  aModule->SetFPID( m_fpid );
57  aModule->SetPath( m_timeStamp );
58 }
wxString m_timeStamp
The component full time stamp found in netlist.
Definition: pcb_netlist.h:91
void SetReference(const wxString &aReference)
Function SetReference.
Definition: class_module.h:422
LIB_ID m_fpid
The LIB_ID of the footprint assigned to the component.
Definition: pcb_netlist.h:100
wxString m_value
The component value found in netlist.
Definition: pcb_netlist.h:88
void SetValue(const wxString &aValue)
Function SetValue.
Definition: class_module.h:449
wxString m_reference
The component reference designator found in netlist.
Definition: pcb_netlist.h:87
std::unique_ptr< MODULE > m_footprint
The MODULE loaded for m_fpid.
Definition: pcb_netlist.h:108
void SetFPID(const LIB_ID &aFPID)
Definition: class_module.h:153
void SetPath(const wxString &aPath)
Definition: class_module.h:162
void COMPONENT::SetName ( const wxString &  aName)
inline

Definition at line 143 of file pcb_netlist.h.

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

143 { 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:94
void COMPONENT::SortPins ( )
inline

Definition at line 141 of file pcb_netlist.h.

141 { sort( m_nets.begin(), m_nets.end() ); }
COMPONENT_NETS m_nets
Definition: pcb_netlist.h:85

Member Data Documentation

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 105 of file pcb_netlist.h.

Referenced by GetAltFPID().

COMPONENT_NET COMPONENT::m_emptyNet
staticprivate

Definition at line 113 of file pcb_netlist.h.

Referenced by GetNet().

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

The MODULE loaded for m_fpid.

Definition at line 108 of file pcb_netlist.h.

Referenced by SetModule().

bool COMPONENT::m_footprintChanged
private

Set to true if m_fpid was changed when the footprint link file was read.

Definition at line 111 of file pcb_netlist.h.

Referenced by FootprintChanged().

wxArrayString COMPONENT::m_footprintFilters
private

Footprint filters found in netlist.

Definition at line 86 of file pcb_netlist.h.

Referenced by Format(), and GetFootprintFilters().

LIB_ID COMPONENT::m_fpid
private

The LIB_ID of the footprint assigned to the component.

Definition at line 100 of file pcb_netlist.h.

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

wxString COMPONENT::m_library
private

The name of the component library where m_name was found.

Definition at line 97 of file pcb_netlist.h.

Referenced by Format(), and GetLibrary().

wxString COMPONENT::m_name
private

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

Definition at line 94 of file pcb_netlist.h.

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

COMPONENT_NETS COMPONENT::m_nets
private

Definition at line 85 of file pcb_netlist.h.

Referenced by Format(), and GetNet().

wxString COMPONENT::m_reference
private

The component reference designator found in netlist.

Definition at line 87 of file pcb_netlist.h.

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

wxString COMPONENT::m_timeStamp
private

The component full time stamp found in netlist.

Definition at line 91 of file pcb_netlist.h.

Referenced by Format(), GetTimeStamp(), and SetModule().

wxString COMPONENT::m_value
private

The component value found in netlist.

Definition at line 88 of file pcb_netlist.h.

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


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