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 ()=default

virtual bool	DeserializeGroup (const google::protobuf::Any &aContainer, COMMIT *aCommit)=0
	Deserializes the given protobuf message into this group.

virtual void	FinalizeGroupDeserialization ()

wxString	GetName () const

void	SetName (const wxString &aName)

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

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

bool	ContainsItem (const EDA_ITEM *aItem) const
	Test if an item is a direct or nested member of this group.

void	AddItem (EDA_ITEM *aItem)
	Add item to group.

void	RemoveItem (EDA_ITEM *aItem)
	Remove item from group.

void	RemoveAll ()

std::vector< KIID >	GetGroupMemberIds () const

bool	HasDesignBlockLink () const

void	SetDesignBlockLibId (const LIB_ID &aLibId)

const LIB_ID &	GetDesignBlockLibId () const

Protected Attributes
std::unordered_set< EDA_ITEM * >	m_items

wxString	m_name

LIB_ID	m_designBlockLibId

std::unordered_set< EDA_ITEM * >	m_deserializedItems

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 42 of file eda_group.h.

Constructor & Destructor Documentation

◆ ~EDA_GROUP()

virtual EDA_GROUP::~EDA_GROUP ( )

virtualdefault

Member Function Documentation

◆ AddItem()

void EDA_GROUP::AddItem ( EDA_ITEM * aItem )

Add item to group.

Does not take ownership of item.

Definition at line 58 of file eda_group.cpp.

References AsEdaItem(), EDA_ITEM::GetParentGroup(), group, m_items, and EDA_ITEM::SetParentGroup().

◆ AsEdaItem()

virtual EDA_ITEM * EDA_GROUP::AsEdaItem ( )

pure virtual

Implemented in PCB_GROUP, and SCH_GROUP.

Referenced by AddItem(), GROUP_TOOL::AddToGroup(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_FIXTURE_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), EDIT_TOOL::DeleteItems(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), EDIT_TOOL::doMoveSelection(), BOARD::ExchangeFootprint(), VIA_STITCH_TOOL::ExcludeStitchVia(), PCB_PROPERTIES_PANEL::filterOutReadOnlyGenChildren(), MULTICHANNEL_TOOL::GeneratePotentialRuleAreas(), PCB_SELECTION_TOOL::Main(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), PCB_SELECTION_TOOL::unrouteSegment(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), PCB_GROUP::WithinScope(), and SCH_GROUP::WithinScope().

◆ ContainsItem()

bool EDA_GROUP::ContainsItem ( const EDA_ITEM * aItem ) const

Test if an item is a direct or nested member of this group.

Definition at line 26 of file eda_group.cpp.

References group.

◆ DeserializeGroup()

virtual bool EDA_GROUP::DeserializeGroup	(	const google::protobuf::Any &	aContainer,
		COMMIT *	aCommit )

pure virtual

Deserializes the given protobuf message into this group.

Groups may contain references to items in the current commit that are not yet present in the board or schematic. When necessary, items in the provided commit are used when populating the items contained in the group.

NB: this routine only adds members to the group's m_deserializedItems list. They must be added to the proper members list (m_items) by FinalizeGroupDeserialization() once the group has passed all the sanity checks and will be kept). Otherwise we can end up with dangling parentGroup pointers in the member items if the group ends up being thrown away.

Parameters

aContainer	is a protobuf message to be unpacked and deserialized.
aCommit	is an active commit which may contain new items that belong in the group.

Returns: true if unpacking and deserialization succeeded.

Implemented in PCB_GROUP, and SCH_GROUP.

◆ FinalizeGroupDeserialization()

virtual void EDA_GROUP::FinalizeGroupDeserialization ( )

inlinevirtual

Definition at line 66 of file eda_group.h.

References AddItem(), and m_deserializedItems.

Referenced by API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), and API_HANDLER_SCH::handleCreateUpdateItemsInternal().

◆ GetDesignBlockLibId()

const LIB_ID & EDA_GROUP::GetDesignBlockLibId ( ) const

inline

Definition at line 102 of file eda_group.h.

References m_designBlockLibId.

Referenced by PCB_IO_KICAD_SEXPR::format(), SCH_IO_KICAD_SEXPR::saveGroup(), PCB_GROUP::Serialize(), and PCB_EDIT_FRAME::UpdateDesignBlockFromSelection().

◆ GetGroupMemberIds()

std::vector< KIID > EDA_GROUP::GetGroupMemberIds ( ) const

Definition at line 95 of file eda_group.cpp.

References m_items.

◆ GetItems() [1/2]

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

inline

Definition at line 78 of file eda_group.h.

References m_items.

◆ GetItems() [2/2]

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

inline

Definition at line 79 of file eda_group.h.

References m_items.

◆ GetName()

wxString EDA_GROUP::GetName ( ) const

inline

◆ HasDesignBlockLink()

bool EDA_GROUP::HasDesignBlockLink ( ) const

inline

Definition at line 99 of file eda_group.h.

References m_designBlockLibId.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), PCB_IO_KICAD_SEXPR::format(), PCB_SELECTION_TOOL::Init(), SCH_IO_KICAD_SEXPR::saveGroup(), and PCB_GROUP::Serialize().

◆ RemoveAll()

void EDA_GROUP::RemoveAll ( )

Definition at line 86 of file eda_group.cpp.

References m_items.

Referenced by PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_EDIT_FRAME::UpdateDesignBlockFromSelection(), SCH_EDIT_FRAME::UpdateDesignBlockFromSelection(), and BOARD_NETLIST_UPDATER::updateFootprintGroup().

◆ RemoveItem()

void EDA_GROUP::RemoveItem ( EDA_ITEM * aItem )

Remove item from group.

Definition at line 77 of file eda_group.cpp.

References m_items, and EDA_ITEM::SetParentGroup().

Referenced by BOARD::ExchangeFootprint(), PCB_CONTROL::Paste(), BOARD_COMMIT::Push(), PCB_VIA_STACK::Regenerate(), PCB_VIA_STITCH::Update(), and BOARD_NETLIST_UPDATER::updateFootprintGroup().

◆ SetDesignBlockLibId()

void EDA_GROUP::SetDesignBlockLibId ( const LIB_ID & aLibId )

inline

Definition at line 101 of file eda_group.h.

References m_designBlockLibId.

Referenced by PCB_GROUP::DeserializeGroup(), SCH_DRAWING_TOOLS::DrawSheet(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_EDIT_FRAME::UpdateDesignBlockFromSelection(), and SCH_EDIT_FRAME::UpdateDesignBlockFromSelection().

◆ SetName()

void EDA_GROUP::SetName ( const wxString & aName )

inline

Definition at line 76 of file eda_group.h.

References m_name.

Member Data Documentation

◆ m_deserializedItems

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

protected

Definition at line 109 of file eda_group.h.

Referenced by PCB_TUNING_PATTERN::Deserialize(), PCB_VIA_STACK::Deserialize(), PCB_VIA_STITCH::Deserialize(), PCB_GROUP::DeserializeGroup(), SCH_GROUP::DeserializeGroup(), and FinalizeGroupDeserialization().

◆ m_designBlockLibId

LIB_ID EDA_GROUP::m_designBlockLibId

protected

Definition at line 107 of file eda_group.h.

Referenced by GetDesignBlockLibId(), HasDesignBlockLink(), SetDesignBlockLibId(), and SCH_GROUP::swapData().

◆ m_items

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

protected

Definition at line 105 of file eda_group.h.

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

◆ m_name

wxString EDA_GROUP::m_name

protected

Definition at line 106 of file eda_group.h.

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~EDA_GROUP()

Member Function Documentation

◆ AddItem()

◆ AsEdaItem()

◆ ContainsItem()

◆ DeserializeGroup()

◆ FinalizeGroupDeserialization()

◆ GetDesignBlockLibId()

◆ GetGroupMemberIds()

◆ GetItems() [1/2]

◆ GetItems() [2/2]

◆ GetName()

◆ HasDesignBlockLink()

◆ RemoveAll()

◆ RemoveItem()

◆ SetDesignBlockLibId()

◆ SetName()

Member Data Documentation

◆ m_deserializedItems

◆ m_designBlockLibId

◆ m_items

◆ m_name