KiCad PCB EDA Suite
DANGLING_END_ITEM Class Reference

Class DANGLING_END_ITEM is a helper class used to store the state of schematic items that can be connected to other schematic items. More...

#include <sch_item_struct.h>

Public Member Functions

 DANGLING_END_ITEM (DANGLING_END_T aType, const EDA_ITEM *aItem, const wxPoint &aPosition)
 
 DANGLING_END_ITEM (DANGLING_END_T aType, const EDA_ITEM *aItem, const wxPoint &aPosition, const EDA_ITEM *aParent)
 
wxPoint GetPosition () const
 
const EDA_ITEMGetItem () const
 
const EDA_ITEMGetParent () const
 
DANGLING_END_T GetType () const
 

Private Attributes

const 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

Class DANGLING_END_ITEM is a helper class used to store the state of schematic items that can be connected to other schematic items.

Definition at line 68 of file sch_item_struct.h.

Constructor & Destructor Documentation

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

Definition at line 84 of file sch_item_struct.h.

85  {
86  m_item = aItem;
87  m_type = aType;
88  m_pos = aPosition;
89  m_parent = aItem;
90  }
DANGLING_END_T m_type
The type of connection of m_item.
const EDA_ITEM * m_item
A pointer to the connectable object.
wxPoint m_pos
The position of the connection point.
const EDA_ITEM * m_parent
A pointer to the parent object (in the case of pins)
DANGLING_END_ITEM::DANGLING_END_ITEM ( DANGLING_END_T  aType,
const EDA_ITEM aItem,
const wxPoint aPosition,
const EDA_ITEM aParent 
)
inline

Definition at line 92 of file sch_item_struct.h.

94  {
95  m_item = aItem;
96  m_type = aType;
97  m_pos = aPosition;
98  m_parent = aParent;
99  }
DANGLING_END_T m_type
The type of connection of m_item.
const EDA_ITEM * m_item
A pointer to the connectable object.
wxPoint m_pos
The position of the connection point.
const EDA_ITEM * m_parent
A pointer to the parent object (in the case of pins)

Member Function Documentation

const EDA_ITEM* DANGLING_END_ITEM::GetItem ( ) const
inline

Definition at line 102 of file sch_item_struct.h.

References m_item.

Referenced by SCH_TEXT::UpdateDanglingState().

102 { return m_item; }
const EDA_ITEM * m_item
A pointer to the connectable object.
const EDA_ITEM* DANGLING_END_ITEM::GetParent ( ) const
inline

Definition at line 103 of file sch_item_struct.h.

References m_parent.

103 { return m_parent; }
const EDA_ITEM * m_parent
A pointer to the parent object (in the case of pins)
wxPoint DANGLING_END_ITEM::GetPosition ( ) const
inline

Definition at line 101 of file sch_item_struct.h.

References m_pos.

Referenced by SCH_ITEM::GetNetListItem(), and SCH_TEXT::UpdateDanglingState().

101 { return m_pos; }
wxPoint m_pos
The position of the connection point.
DANGLING_END_T DANGLING_END_ITEM::GetType ( ) const
inline

Definition at line 104 of file sch_item_struct.h.

References m_type.

Referenced by SCH_TEXT::UpdateDanglingState().

104 { return m_type; }
DANGLING_END_T m_type
The type of connection of m_item.

Member Data Documentation

const EDA_ITEM* DANGLING_END_ITEM::m_item
private

A pointer to the connectable object.

Definition at line 72 of file sch_item_struct.h.

Referenced by GetItem().

const EDA_ITEM* DANGLING_END_ITEM::m_parent
private

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

Definition at line 81 of file sch_item_struct.h.

Referenced by GetParent().

wxPoint DANGLING_END_ITEM::m_pos
private

The position of the connection point.

Definition at line 75 of file sch_item_struct.h.

Referenced by GetPosition().

DANGLING_END_T DANGLING_END_ITEM::m_type
private

The type of connection of m_item.

Definition at line 78 of file sch_item_struct.h.

Referenced by GetType().


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