ERC_SCH_PIN_CONTEXT Class Reference

A class used to associate a SCH_PIN with its owning SCH_SHEET_PATH, in order to handle ERC checks across connected common hierarchical schematics/. More...

#include <erc_sch_pin_context.h>

Public Member Functions
	ERC_SCH_PIN_CONTEXT ()=default
	ERC_SCH_PIN_CONTEXT (SCH_PIN *pin, const SCH_SHEET_PATH &sheet)
	ERC_SCH_PIN_CONTEXT (const ERC_SCH_PIN_CONTEXT &other)=default
ERC_SCH_PIN_CONTEXT &	operator= (const ERC_SCH_PIN_CONTEXT &other)=default
	~ERC_SCH_PIN_CONTEXT ()=default
SCH_PIN *	Pin () const
	Get the SCH_PIN for this context.
const SCH_SHEET_PATH &	Sheet () const
	Get the SCH_SHEET_PATH context for the paired SCH_PIN.
bool	operator== (const ERC_SCH_PIN_CONTEXT &other) const
	Compare the exact sheet instance and pin UUID.
bool	operator< (const ERC_SCH_PIN_CONTEXT &other) const
	Order by sheet instance and pin UUID, with null pins preceding live pins.

Protected Attributes
SCH_PIN *	m_pin = nullptr
SCH_SHEET_PATH	m_sheet

Detailed Description

A class used to associate a SCH_PIN with its owning SCH_SHEET_PATH, in order to handle ERC checks across connected common hierarchical schematics/.

Definition at line 35 of file erc_sch_pin_context.h.

Constructor & Destructor Documentation

ERC_SCH_PIN_CONTEXT() [1/3]

ERC_SCH_PIN_CONTEXT::ERC_SCH_PIN_CONTEXT ( )

default

Referenced by ERC_SCH_PIN_CONTEXT(), operator<(), operator=(), operator==(), and ~ERC_SCH_PIN_CONTEXT().

ERC_SCH_PIN_CONTEXT() [2/3]

ERC_SCH_PIN_CONTEXT::ERC_SCH_PIN_CONTEXT ( SCH_PIN * pin, const SCH_SHEET_PATH & sheet )

inline

Definition at line 40 of file erc_sch_pin_context.h.

References m_pin, m_sheet, and pin.

ERC_SCH_PIN_CONTEXT() [3/3]

ERC_SCH_PIN_CONTEXT::ERC_SCH_PIN_CONTEXT ( const ERC_SCH_PIN_CONTEXT & other )

default

References ERC_SCH_PIN_CONTEXT().

~ERC_SCH_PIN_CONTEXT()

ERC_SCH_PIN_CONTEXT::~ERC_SCH_PIN_CONTEXT ( )

default

References ERC_SCH_PIN_CONTEXT().

Member Function Documentation

operator<()

bool ERC_SCH_PIN_CONTEXT::operator<

(

const ERC_SCH_PIN_CONTEXT &

other

)

const

Order by sheet instance and pin UUID, with null pins preceding live pins.

Definition at line 53 of file erc_sch_pin_context.cpp.

References ERC_SCH_PIN_CONTEXT(), m_pin, m_sheet, EDA_ITEM::m_Uuid, and SCH_SHEET_PATH::PathRef().

operator=()

ERC_SCH_PIN_CONTEXT & ERC_SCH_PIN_CONTEXT::operator= ( const ERC_SCH_PIN_CONTEXT & other )

default

References ERC_SCH_PIN_CONTEXT().

operator==()

bool ERC_SCH_PIN_CONTEXT::operator==

(

const ERC_SCH_PIN_CONTEXT &

other

)

const

Compare the exact sheet instance and pin UUID.

Definition at line 41 of file erc_sch_pin_context.cpp.

References ERC_SCH_PIN_CONTEXT(), m_pin, m_sheet, EDA_ITEM::m_Uuid, and SCH_SHEET_PATH::PathRef().

Pin()

SCH_PIN * ERC_SCH_PIN_CONTEXT::Pin

(

)

const

Get the SCH_PIN for this context.

Definition at line 29 of file erc_sch_pin_context.cpp.

References m_pin.

Referenced by ERC_TESTER::TestPinToPin().

Sheet()

const SCH_SHEET_PATH & ERC_SCH_PIN_CONTEXT::Sheet

(

)

const

Get the SCH_SHEET_PATH context for the paired SCH_PIN.

Definition at line 35 of file erc_sch_pin_context.cpp.

References m_sheet.

Referenced by ERC_TESTER::TestPinToPin().

Member Data Documentation

m_pin

SCH_PIN* ERC_SCH_PIN_CONTEXT::m_pin = nullptr

protected

Definition at line 72 of file erc_sch_pin_context.h.

Referenced by ERC_SCH_PIN_CONTEXT(), operator<(), operator==(), and Pin().

m_sheet

SCH_SHEET_PATH ERC_SCH_PIN_CONTEXT::m_sheet

protected

Definition at line 73 of file erc_sch_pin_context.h.

Referenced by ERC_SCH_PIN_CONTEXT(), operator<(), operator==(), and Sheet().

---

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

• erc_sch_pin_context.h
• erc_sch_pin_context.cpp