KiCad PCB EDA Suite
Loading...
Searching...
No Matches
DANGLING_END_ITEM Class Reference

Helper class used to store the state of schematic items that can be connected to other schematic items. More...

#include <sch_item.h>

Public Member Functions

 DANGLING_END_ITEM (DANGLING_END_T aType, EDA_ITEM *aItem, const VECTOR2I &aPosition)
 
 DANGLING_END_ITEM (DANGLING_END_T aType, EDA_ITEM *aItem, const VECTOR2I &aPosition, const EDA_ITEM *aParent)
 
bool operator== (const DANGLING_END_ITEM &aB) const
 
bool operator< (const DANGLING_END_ITEM &rhs) const
 
VECTOR2I GetPosition () const
 
EDA_ITEMGetItem () const
 
const EDA_ITEMGetParent () const
 
DANGLING_END_T GetType () const
 

Private Attributes

EDA_ITEMm_item
 A pointer to the connectable object.
 
VECTOR2I m_pos
 The position of the connection point.
 
DANGLING_END_T m_type
 The type of connection of m_item.
 
const EDA_ITEMm_parent
 A pointer to the parent object (in the case of pins).
 

Detailed Description

Helper class used to store the state of schematic items that can be connected to other schematic items.

Definition at line 95 of file sch_item.h.

Constructor & Destructor Documentation

◆ DANGLING_END_ITEM() [1/2]

DANGLING_END_ITEM::DANGLING_END_ITEM ( DANGLING_END_T  aType,
EDA_ITEM aItem,
const VECTOR2I aPosition 
)
inline

Definition at line 98 of file sch_item.h.

References m_item, m_parent, m_pos, and m_type.

◆ DANGLING_END_ITEM() [2/2]

DANGLING_END_ITEM::DANGLING_END_ITEM ( DANGLING_END_T  aType,
EDA_ITEM aItem,
const VECTOR2I aPosition,
const EDA_ITEM aParent 
)
inline

Definition at line 106 of file sch_item.h.

References m_item, m_parent, m_pos, and m_type.

Member Function Documentation

◆ GetItem()

◆ GetParent()

const EDA_ITEM * DANGLING_END_ITEM::GetParent ( ) const
inline

Definition at line 131 of file sch_item.h.

References m_parent.

Referenced by operator<<(), operator==(), and SCH_SYMBOL::UpdateDanglingState().

◆ GetPosition()

VECTOR2I DANGLING_END_ITEM::GetPosition ( ) const
inline

◆ GetType()

◆ operator<()

bool DANGLING_END_ITEM::operator< ( const DANGLING_END_ITEM rhs) const
inline

Definition at line 123 of file sch_item.h.

References m_item, m_pos, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ operator==()

bool DANGLING_END_ITEM::operator== ( const DANGLING_END_ITEM aB) const
inline

Definition at line 115 of file sch_item.h.

References GetItem(), GetParent(), GetPosition(), and GetType().

Member Data Documentation

◆ m_item

EDA_ITEM* DANGLING_END_ITEM::m_item
private

A pointer to the connectable object.

Definition at line 135 of file sch_item.h.

Referenced by DANGLING_END_ITEM(), GetItem(), and operator<().

◆ m_parent

const EDA_ITEM* DANGLING_END_ITEM::m_parent
private

A pointer to the parent object (in the case of pins).

Definition at line 138 of file sch_item.h.

Referenced by DANGLING_END_ITEM(), and GetParent().

◆ m_pos

VECTOR2I DANGLING_END_ITEM::m_pos
private

The position of the connection point.

Definition at line 136 of file sch_item.h.

Referenced by DANGLING_END_ITEM(), GetPosition(), and operator<().

◆ m_type

DANGLING_END_T DANGLING_END_ITEM::m_type
private

The type of connection of m_item.

Definition at line 137 of file sch_item.h.

Referenced by DANGLING_END_ITEM(), and GetType().


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