KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SCH_CONNECTIVITY::NAME_KEY Struct Reference

The graph node of one name in one scope. More...

#include <conn_keys.h>

Public Member Functions

bool operator== (const NAME_KEY &aOther) const
 

Public Attributes

SCOPE scope = SCOPE::SHEET
 
INST_ID inst = INVALID_ID
 The sheet instance, or the child instance of a sheet pin for PORT.
 
NAME_ID text = INVALID_ID
 The resolved name.
 
KIND kind = KIND::SIGNAL
 The record kind. Only PORT compares it.
 

Detailed Description

The graph node of one name in one scope.

Records that emit equal name keys join.

Equality depends on the scope. GLOBAL ignores inst and kind. SHEET compares inst and ignores kind. PORT compares inst and kind. SESSION_KEYS::InternNode() normalizes the ignored fields before it interns a key.

Definition at line 109 of file conn_keys.h.

Member Function Documentation

◆ operator==()

bool SCH_CONNECTIVITY::NAME_KEY::operator== ( const NAME_KEY & aOther) const
inline

Definition at line 116 of file conn_keys.h.

References inst, kind, scope, and text.

Member Data Documentation

◆ inst

INST_ID SCH_CONNECTIVITY::NAME_KEY::inst = INVALID_ID

The sheet instance, or the child instance of a sheet pin for PORT.

Definition at line 112 of file conn_keys.h.

Referenced by SCH_CONNECTIVITY::SESSION_KEYS::Less(), operator==(), and SCH_CONNECTIVITY::PUBLICATION::PrepareRows().

◆ kind

KIND SCH_CONNECTIVITY::NAME_KEY::kind = KIND::SIGNAL

The record kind. Only PORT compares it.

Definition at line 114 of file conn_keys.h.

Referenced by SCH_CONNECTIVITY::SESSION_KEYS::Less(), and operator==().

◆ scope

SCOPE SCH_CONNECTIVITY::NAME_KEY::scope = SCOPE::SHEET

◆ text

NAME_ID SCH_CONNECTIVITY::NAME_KEY::text = INVALID_ID

The resolved name.

Definition at line 113 of file conn_keys.h.

Referenced by SCH_CONNECTIVITY::SESSION_KEYS::Less(), operator==(), and SCH_CONNECTIVITY::PUBLICATION::PrepareRows().


The documentation for this struct was generated from the following file: