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 ()
	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
	Test two pin contexts for equality based on the deterministic hash.
bool	operator< (const ERC_SCH_PIN_CONTEXT &other) const
	Provide a deterministic ordering for item contexts based on hash value.

Protected Member Functions
void	rehash ()
	Calculate the deterministic hash for this context.

Protected Attributes
SCH_PIN *	m_pin
SCH_SHEET_PATH	m_sheet
size_t	m_hash

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 39 of file erc_sch_pin_context.h.

Constructor & Destructor Documentation

ERC_SCH_PIN_CONTEXT() [1/3]

ERC_SCH_PIN_CONTEXT::ERC_SCH_PIN_CONTEXT ( )

inline

Definition at line 42 of file erc_sch_pin_context.h.

References m_hash, m_pin, and m_sheet.

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 48 of file erc_sch_pin_context.h.

References m_pin, m_sheet, pin, and rehash().

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

Provide a deterministic ordering for item contexts based on hash value.

Definition at line 53 of file erc_sch_pin_context.cpp.

References ERC_SCH_PIN_CONTEXT(), and m_hash.

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

Test two pin contexts for equality based on the deterministic hash.

Definition at line 47 of file erc_sch_pin_context.cpp.

References ERC_SCH_PIN_CONTEXT(), and m_hash.

Pin()

SCH_PIN * ERC_SCH_PIN_CONTEXT::Pin

(

)

const

Get the SCH_PIN for this context.

Definition at line 35 of file erc_sch_pin_context.cpp.

References m_pin.

Referenced by ERC_TESTER::TestPinToPin().

rehash()

void ERC_SCH_PIN_CONTEXT::rehash ( )

protected

Calculate the deterministic hash for this context.

Definition at line 59 of file erc_sch_pin_context.cpp.

References hash_combine(), m_hash, m_pin, and m_sheet.

Referenced by ERC_SCH_PIN_CONTEXT().

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 41 of file erc_sch_pin_context.cpp.

References m_sheet.

Referenced by ERC_TESTER::TestPinToPin().

Member Data Documentation

m_hash

size_t ERC_SCH_PIN_CONTEXT::m_hash

protected

Definition at line 89 of file erc_sch_pin_context.h.

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

m_pin

SCH_PIN* ERC_SCH_PIN_CONTEXT::m_pin

protected

Definition at line 87 of file erc_sch_pin_context.h.

Referenced by ERC_SCH_PIN_CONTEXT(), ERC_SCH_PIN_CONTEXT(), Pin(), and rehash().

m_sheet

SCH_SHEET_PATH ERC_SCH_PIN_CONTEXT::m_sheet

protected

Definition at line 88 of file erc_sch_pin_context.h.

Referenced by ERC_SCH_PIN_CONTEXT(), ERC_SCH_PIN_CONTEXT(), rehash(), and Sheet().

---

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

• erc_sch_pin_context.h
• erc_sch_pin_context.cpp