KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
COMPONENT_NET Class Reference

Used to store the component pin name to net name (and pin function) associations stored in a netlist. More...

#include <netlist.h>

Public Member Functions

 COMPONENT_NET ()
 
 COMPONENT_NET (const wxString &aPinName, const wxString &aNetName, const wxString &aPinFunction, const wxString &aPinType)
 
const wxString & GetPinName () const
 
const wxString & GetNetName () const
 
const wxString & GetPinFunction () const
 
const wxString & GetPinType () const
 
bool IsValid () const
 
bool operator< (const COMPONENT_NET &aNet) const
 
int Format (OUTPUTFORMATTER *aOut, int aNestLevel, int aCtl)
 
 COMPONENT_NET ()
 
 COMPONENT_NET (const wxString &aPinName, const wxString &aNetName, const wxString &aPinFunction, const wxString &aPinType)
 
const wxString & GetPinName () const
 
const wxString & GetNetName () const
 
const wxString & GetPinFunction () const
 
const wxString & GetPinType () const
 
bool IsValid () const
 
bool operator< (const COMPONENT_NET &aNet) const
 
int Format (OUTPUTFORMATTER *aOut, int aNestLevel, int aCtl)
 

Private Attributes

wxString m_pinName
 
wxString m_netName
 
wxString m_pinFunction
 
wxString m_pinType
 

Detailed Description

Used to store the component pin name to net name (and pin function) associations stored in a netlist.

Definition at line 46 of file common/netlist_reader/netlist.h.

Constructor & Destructor Documentation

◆ COMPONENT_NET() [1/4]

COMPONENT_NET::COMPONENT_NET ( )
inline

Definition at line 49 of file common/netlist_reader/netlist.h.

Referenced by operator<().

◆ COMPONENT_NET() [2/4]

COMPONENT_NET::COMPONENT_NET ( const wxString & aPinName,
const wxString & aNetName,
const wxString & aPinFunction,
const wxString & aPinType )
inline

Definition at line 51 of file common/netlist_reader/netlist.h.

References m_netName, m_pinFunction, m_pinName, and m_pinType.

◆ COMPONENT_NET() [3/4]

COMPONENT_NET::COMPONENT_NET ( )
inline

Definition at line 49 of file pcb_netlist.h.

◆ COMPONENT_NET() [4/4]

COMPONENT_NET::COMPONENT_NET ( const wxString & aPinName,
const wxString & aNetName,
const wxString & aPinFunction,
const wxString & aPinType )
inline

Definition at line 51 of file pcb_netlist.h.

References m_netName, m_pinFunction, m_pinName, and m_pinType.

Member Function Documentation

◆ Format() [1/2]

int COMPONENT_NET::Format ( OUTPUTFORMATTER * aOut,
int aNestLevel,
int aCtl )

Definition at line 33 of file common/netlist_reader/netlist.cpp.

References m_netName, m_pinName, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

◆ Format() [2/2]

int COMPONENT_NET::Format ( OUTPUTFORMATTER * aOut,
int aNestLevel,
int aCtl )

References m_netName, m_pinFunction, m_pinName, and m_pinType.

◆ GetNetName() [1/2]

const wxString & COMPONENT_NET::GetNetName ( ) const
inline

Definition at line 61 of file common/netlist_reader/netlist.h.

References m_netName.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_NETLIST_UPDATER::updateCopperZoneNets().

◆ GetNetName() [2/2]

const wxString & COMPONENT_NET::GetNetName ( ) const
inline

Definition at line 61 of file pcb_netlist.h.

References m_netName.

◆ GetPinFunction() [1/2]

const wxString & COMPONENT_NET::GetPinFunction ( ) const
inline

Definition at line 62 of file common/netlist_reader/netlist.h.

References m_pinFunction.

Referenced by TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), FOOTPRINT_VIEWER_FRAME::displayFootprint(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), DISPLAY_FOOTPRINTS_FRAME::ReloadFootprint(), and BOARD_NETLIST_UPDATER::updateComponentPadConnections().

◆ GetPinFunction() [2/2]

const wxString & COMPONENT_NET::GetPinFunction ( ) const
inline

Definition at line 62 of file pcb_netlist.h.

References m_pinFunction.

◆ GetPinName() [1/2]

const wxString & COMPONENT_NET::GetPinName ( ) const
inline

Definition at line 60 of file common/netlist_reader/netlist.h.

References m_pinName.

Referenced by BOOST_AUTO_TEST_CASE(), TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), BOARD_NETLIST_UPDATER::testConnectivity(), and DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist().

◆ GetPinName() [2/2]

const wxString & COMPONENT_NET::GetPinName ( ) const
inline

Definition at line 60 of file pcb_netlist.h.

References m_pinName.

◆ GetPinType() [1/2]

const wxString & COMPONENT_NET::GetPinType ( ) const
inline

Definition at line 63 of file common/netlist_reader/netlist.h.

References m_pinType.

Referenced by TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), and BOARD_NETLIST_UPDATER::updateComponentPadConnections().

◆ GetPinType() [2/2]

const wxString & COMPONENT_NET::GetPinType ( ) const
inline

Definition at line 63 of file pcb_netlist.h.

References m_pinType.

◆ IsValid() [1/2]

bool COMPONENT_NET::IsValid ( ) const
inline

Definition at line 65 of file common/netlist_reader/netlist.h.

References m_pinName.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOARD_NETLIST_UPDATER::updateComponentPadConnections().

◆ IsValid() [2/2]

bool COMPONENT_NET::IsValid ( ) const
inline

Definition at line 65 of file pcb_netlist.h.

References m_pinName.

◆ operator<() [1/2]

bool COMPONENT_NET::operator< ( const COMPONENT_NET & aNet) const
inline

Definition at line 67 of file common/netlist_reader/netlist.h.

References COMPONENT_NET(), and m_pinName.

◆ operator<() [2/2]

bool COMPONENT_NET::operator< ( const COMPONENT_NET & aNet) const
inline

Definition at line 67 of file pcb_netlist.h.

References COMPONENT_NET(), and m_pinName.

Member Data Documentation

◆ m_netName

wxString COMPONENT_NET::m_netName
private

Definition at line 76 of file common/netlist_reader/netlist.h.

Referenced by COMPONENT_NET(), Format(), and GetNetName().

◆ m_pinFunction

wxString COMPONENT_NET::m_pinFunction
private

Definition at line 77 of file common/netlist_reader/netlist.h.

Referenced by COMPONENT_NET(), Format(), and GetPinFunction().

◆ m_pinName

wxString COMPONENT_NET::m_pinName
private

Definition at line 75 of file common/netlist_reader/netlist.h.

Referenced by COMPONENT_NET(), Format(), GetPinName(), IsValid(), and operator<().

◆ m_pinType

wxString COMPONENT_NET::m_pinType
private

Definition at line 78 of file common/netlist_reader/netlist.h.

Referenced by COMPONENT_NET(), Format(), and GetPinType().

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