EDA_GROUP Class Reference

A set of EDA_ITEMs (i.e., without duplicates). More...

#include <eda_group.h>

Inheritance diagram for EDA_GROUP:

Public Member Functions
virtual EDA_ITEM *	AsEdaItem ()=0
virtual	~EDA_GROUP ()
wxString	GetName () const
void	SetName (const wxString &aName)
std::unordered_set< EDA_ITEM * > &	GetItems ()
const std::unordered_set< EDA_ITEM * > &	GetItems () const
virtual bool	AddItem (EDA_ITEM *aItem)=0
	Add item to group.
virtual bool	RemoveItem (EDA_ITEM *aItem)=0
	Remove item from group.
virtual void	RemoveAll ()=0
virtual EDA_GROUP *	DeepClone () const =0
virtual EDA_GROUP *	DeepDuplicate () const =0

Protected Attributes
std::unordered_set< EDA_ITEM * >	m_items
	Check if the proposed type can be added to a group.
wxString	m_name

Detailed Description

A set of EDA_ITEMs (i.e., without duplicates).

The group parent is always board/sheet, not logical parent group. The group is transparent container - e.g., its position is derived from the position of its members. A selection containing a group implicitly contains its members. However other operations on sets of items, like committing, updating the view, etc the set is explicit.

Definition at line 44 of file eda_group.h.

Constructor & Destructor Documentation

~EDA_GROUP()

EDA_GROUP::~EDA_GROUP ( )

virtual

Definition at line 4 of file eda_group.cpp.

Member Function Documentation

AddItem()

virtual bool EDA_GROUP::AddItem ( EDA_ITEM *  aItem )

pure virtual

Add item to group.

Does not take ownership of item.

Returns

true if item was added (false if item belongs to a different group).

Implemented in SCH_GROUP, and PCB_GROUP.

Referenced by BOARD_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), and DIALOG_GROUP_PROPERTIES::TransferDataFromWindow().

AsEdaItem()

virtual EDA_ITEM * EDA_GROUP::AsEdaItem ( )

pure virtual

Implemented in SCH_GROUP, and PCB_GROUP.

Referenced by DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_GROUP_PROPERTIES::DoAddMember(), BOARD_EDITOR_CONTROL::modifyLockSelected(), BOARD_COMMIT::Push(), BOARD::Remove(), FOOTPRINT::Remove(), PCB_SELECTION_TOOL::Selectable(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), PCB_GROUP::WithinScope(), and SCH_GROUP::WithinScope().

DeepClone()

virtual EDA_GROUP * EDA_GROUP::DeepClone ( ) const

pure virtual

Implemented in SCH_GROUP, PCB_GENERATOR, and PCB_GROUP.

DeepDuplicate()

virtual EDA_GROUP * EDA_GROUP::DeepDuplicate ( ) const

pure virtual

Implemented in SCH_GROUP, and PCB_GROUP.

GetItems() [1/2]

std::unordered_set< EDA_ITEM * > & EDA_GROUP::GetItems ( )

inline

Definition at line 53 of file eda_group.h.

References m_items.

Referenced by EDIT_TOOL::DeleteItems(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), FOOTPRINT::FOOTPRINT(), PCB_IO_KICAD_SEXPR::format(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), BOARD_INSPECTION_TOOL::InspectClearance(), FOOTPRINT::operator=(), DRAWING_TOOL::PlaceTuningPattern(), PCB_TUNING_PATTERN::Remove(), and testGroupEqual().

GetItems() [2/2]

const std::unordered_set< EDA_ITEM * > & EDA_GROUP::GetItems ( ) const

inline

Definition at line 55 of file eda_group.h.

References m_items.

GetName()

wxString EDA_GROUP::GetName ( ) const

inline

Definition at line 50 of file eda_group.h.

References m_name.

Referenced by createBoard(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), PCB_GROUP_DESC::PCB_GROUP_DESC(), SCH_GROUP_DESC::SCH_GROUP_DESC(), and testGroupEqual().

RemoveAll()

virtual void EDA_GROUP::RemoveAll ( )

pure virtual

Implemented in SCH_GROUP, and PCB_GROUP.

Referenced by DIALOG_GROUP_PROPERTIES::TransferDataFromWindow().

RemoveItem()

virtual bool EDA_GROUP::RemoveItem ( EDA_ITEM *  aItem )

pure virtual

Remove item from group.

Returns

true if item was removed (false if item was not in the group).

Implemented in SCH_GROUP, and PCB_GROUP.

Referenced by SCH_GROUP::AddItem(), PCB_GROUP::AddItem(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_CONTROL::Paste(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::Remove(), and FOOTPRINT::Remove().

SetName()

void EDA_GROUP::SetName ( const wxString &  aName )

inline

Definition at line 51 of file eda_group.h.

References m_name.

Referenced by createBoard(), CADSTAR_PCB_ARCHIVE_LOADER::createUniqueGroupID(), CADSTAR_PCB_ARCHIVE_LOADER::loadGroups(), PCB_GROUP_DESC::PCB_GROUP_DESC(), SCH_GROUP_DESC::SCH_GROUP_DESC(), and DIALOG_GROUP_PROPERTIES::TransferDataFromWindow().

Member Data Documentation

m_items

std::unordered_set<EDA_ITEM*> EDA_GROUP::m_items

protected

Check if the proposed type can be added to a group.

Parameters

aType

KICAD_T type to check

Returns

true if the type can belong to a group, false otherwise

Definition at line 91 of file eda_group.h.

Referenced by SCH_GROUP::AddItem(), PCB_GROUP::AddItem(), SCH_GROUP::DeepClone(), PCB_GENERATOR::DeepClone(), PCB_GROUP::DeepClone(), SCH_GROUP::DeepDuplicate(), PCB_GROUP::DeepDuplicate(), PCB_GROUP::Flip(), PCB_GROUP::GetBoardItems(), SCH_GROUP::GetBoundingBox(), PCB_GROUP::GetBoundingBox(), PCB_GROUP::GetEffectiveShape(), SCH_GROUP::GetItemDescription(), PCB_GROUP::GetItemDescription(), GetItems(), PCB_GROUP::GetLayerSet(), SCH_GROUP::GetMsgPanelInfo(), PCB_GROUP::GetMsgPanelInfo(), SCH_GROUP::GetSchItems(), PCB_GROUP::IsOnLayer(), PCB_GROUP::Mirror(), SCH_GROUP::MirrorHorizontally(), SCH_GROUP::MirrorVertically(), SCH_GROUP::Move(), PCB_GROUP::Move(), PCB_GROUP::operator==(), SCH_GROUP::operator==(), SCH_GROUP::RemoveAll(), PCB_GROUP::RemoveAll(), SCH_GROUP::RemoveItem(), PCB_GROUP::RemoveItem(), SCH_GROUP::Rotate(), PCB_GROUP::Rotate(), SCH_GROUP::RunOnChildren(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), PCB_GROUP::Similarity(), and SCH_GROUP::Similarity().

m_name

wxString EDA_GROUP::m_name

protected

Definition at line 92 of file eda_group.h.

Referenced by SCH_GROUP::GetItemDescription(), PCB_GROUP::GetItemDescription(), SCH_GROUP::GetMsgPanelInfo(), PCB_GROUP::GetMsgPanelInfo(), GetName(), PCB_TUNING_PATTERN::PCB_TUNING_PATTERN(), and SetName().

---

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

• eda_group.h
• eda_group.cpp