KiCad PCB EDA Suite
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 wxPoint &aPosition)
 
 DANGLING_END_ITEM (DANGLING_END_T aType, EDA_ITEM *aItem, const wxPoint &aPosition, const EDA_ITEM *aParent)
 
bool operator== (const DANGLING_END_ITEM &aB)
 
bool operator!= (const DANGLING_END_ITEM &aB)
 
bool operator< (const DANGLING_END_ITEM &rhs) const
 
const wxPoint 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. More...
 
wxPoint m_pos
 The position of the connection point. More...
 
DANGLING_END_T m_type
 The type of connection of m_item. More...
 
const EDA_ITEMm_parent
 A pointer to the parent object (in the case of pins) More...
 

Detailed Description

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

Definition at line 84 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 wxPoint aPosition 
)
inline

Definition at line 100 of file sch_item.h.

101  {
102  m_item = aItem;
103  m_type = aType;
104  m_pos = aPosition;
105  m_parent = aItem;
106  }
DANGLING_END_T m_type
The type of connection of m_item.
Definition: sch_item.h:94
EDA_ITEM * m_item
A pointer to the connectable object.
Definition: sch_item.h:88
wxPoint m_pos
The position of the connection point.
Definition: sch_item.h:91
const EDA_ITEM * m_parent
A pointer to the parent object (in the case of pins)
Definition: sch_item.h:97

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 wxPoint aPosition,
const EDA_ITEM aParent 
)
inline

Definition at line 108 of file sch_item.h.

110  {
111  m_item = aItem;
112  m_type = aType;
113  m_pos = aPosition;
114  m_parent = aParent;
115  }
DANGLING_END_T m_type
The type of connection of m_item.
Definition: sch_item.h:94
EDA_ITEM * m_item
A pointer to the connectable object.
Definition: sch_item.h:88
wxPoint m_pos
The position of the connection point.
Definition: sch_item.h:91
const EDA_ITEM * m_parent
A pointer to the parent object (in the case of pins)
Definition: sch_item.h:97

References m_item, m_parent, m_pos, and m_type.

Member Function Documentation

◆ GetItem()

EDA_ITEM* DANGLING_END_ITEM::GetItem ( ) const
inline

Definition at line 140 of file sch_item.h.

140 { return m_item; }
EDA_ITEM * m_item
A pointer to the connectable object.
Definition: sch_item.h:88

References m_item.

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

◆ GetParent()

const EDA_ITEM* DANGLING_END_ITEM::GetParent ( void  ) const
inline

Definition at line 141 of file sch_item.h.

141 { return m_parent; }
const EDA_ITEM * m_parent
A pointer to the parent object (in the case of pins)
Definition: sch_item.h:97

References m_parent.

Referenced by operator!=(), operator<<(), and operator==().

◆ GetPosition()

const wxPoint DANGLING_END_ITEM::GetPosition ( ) const
inline

Definition at line 139 of file sch_item.h.

139 { return m_pos; }
wxPoint m_pos
The position of the connection point.
Definition: sch_item.h:91

References m_pos.

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

◆ GetType()

DANGLING_END_T DANGLING_END_ITEM::GetType ( ) const
inline

Definition at line 142 of file sch_item.h.

142 { return m_type; }
DANGLING_END_T m_type
The type of connection of m_item.
Definition: sch_item.h:94

References m_type.

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

◆ operator!=()

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

Definition at line 125 of file sch_item.h.

126  {
127  return GetItem() != aB.GetItem()
128  || GetPosition() != aB.GetPosition()
129  || GetType() != aB.GetType()
130  || GetParent() != aB.GetParent();;
131  }
const EDA_ITEM * GetParent() const
Definition: sch_item.h:141
const wxPoint GetPosition() const
Definition: sch_item.h:139
EDA_ITEM * GetItem() const
Definition: sch_item.h:140
DANGLING_END_T GetType() const
Definition: sch_item.h:142

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

◆ operator<()

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

Definition at line 133 of file sch_item.h.

134  {
135  return( m_pos.x < rhs.m_pos.x || ( m_pos.x == rhs.m_pos.x && m_pos.y < rhs.m_pos.y )
136  || ( m_pos == rhs.m_pos && m_item < rhs.m_item ) );
137  }
EDA_ITEM * m_item
A pointer to the connectable object.
Definition: sch_item.h:88
wxPoint m_pos
The position of the connection point.
Definition: sch_item.h:91

References m_item, m_pos, wxPoint::x, and wxPoint::y.

◆ operator==()

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

Definition at line 117 of file sch_item.h.

118  {
119  return GetItem() == aB.GetItem()
120  && GetPosition() == aB.GetPosition()
121  && GetType() == aB.GetType()
122  && GetParent() == aB.GetParent();
123  }
const EDA_ITEM * GetParent() const
Definition: sch_item.h:141
const wxPoint GetPosition() const
Definition: sch_item.h:139
EDA_ITEM * GetItem() const
Definition: sch_item.h:140
DANGLING_END_T GetType() const
Definition: sch_item.h:142

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 88 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 97 of file sch_item.h.

Referenced by DANGLING_END_ITEM(), and GetParent().

◆ m_pos

wxPoint DANGLING_END_ITEM::m_pos
private

The position of the connection point.

Definition at line 91 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 94 of file sch_item.h.

Referenced by DANGLING_END_ITEM(), and GetType().


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