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) const
bool	operator!= (const DANGLING_END_ITEM &aB) const
bool	operator< (const DANGLING_END_ITEM &rhs) const
wxPoint	GetPosition () const
EDA_ITEM *	GetItem () const
const EDA_ITEM *	GetParent () const
DANGLING_END_T	GetType () const

Private Attributes
EDA_ITEM *	m_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_ITEM *	m_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 83 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 86 of file sch_item.h.

    {
        m_item = aItem;
        m_type = aType;
        m_pos = aPosition;
        m_parent = aItem;
    }

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

    {
        m_item = aItem;
        m_type = aType;
        m_pos = aPosition;
        m_parent = aParent;
    }

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

{ return m_item; }

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

{ return m_parent; }

References m_parent.

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

GetPosition()

wxPoint DANGLING_END_ITEM::GetPosition ( ) const

inline

Definition at line 125 of file sch_item.h.

{ return m_pos; }

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

{ return m_type; }

References m_type.

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

operator!=()

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

inline

Definition at line 111 of file sch_item.h.

    {
        return GetItem() != aB.GetItem()
                || GetPosition() != aB.GetPosition()
                || GetType() != aB.GetType()
                || GetParent() != aB.GetParent();;
    }

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

operator<()

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

inline

Definition at line 119 of file sch_item.h.

    {
        return( m_pos.x < rhs.m_pos.x || ( m_pos.x == rhs.m_pos.x && m_pos.y < rhs.m_pos.y )
                || ( m_pos == rhs.m_pos && m_item < rhs.m_item ) );
    }

References m_item, and m_pos.

operator==()

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

inline

Definition at line 103 of file sch_item.h.

    {
        return GetItem() == aB.GetItem()
            && GetPosition() == aB.GetPosition()
            && GetType() == aB.GetType()
            && GetParent() == aB.GetParent();
    }

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 132 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 141 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 135 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 138 of file sch_item.h.

Referenced by DANGLING_END_ITEM(), and GetType().

---

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

• sch_item.h