KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
EDA_GROUP Class Referenceabstract

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

#include <eda_group.h>

Inheritance diagram for EDA_GROUP:
PCB_GROUP SCH_GROUP PCB_GENERATOR PCB_GENERATOR_POLY PCB_TUNING_PATTERN PCB_VIA_STACK PCB_VIA_STITCH BASELINE_ACCESSOR

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.
 
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
 

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().

Referenced by PCB_VIA_STACK::addMember(), CADSTAR_PCB_ARCHIVE_LOADER::addToGroup(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), PCB_GENERATOR::DeepClone(), PCB_GROUP::DeepClone(), SCH_GROUP::DeepClone(), PCB_GROUP::DeepDuplicate(), SCH_GROUP::DeepDuplicate(), PCB_GROUP::DeserializeGroup(), SCH_GROUP::DeserializeGroup(), SCH_DRAWING_TOOLS::DrawSheet(), PCB_VIA_STITCH::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), BOARD::ExchangeFootprint(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), CADSTAR_PCB_ARCHIVE_LOADER::loadGroups(), GENERATOR_TOOL::MakeViaStackFromSelection(), FOOTPRINT::operator=(), SCH_COMMIT::pushSchEdit(), SPRINT_LAYOUT_PARSER::resolveGroups(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_VIA_STITCH::Update(), PCB_EDIT_FRAME::UpdateDesignBlockFromSelection(), SCH_EDIT_FRAME::UpdateDesignBlockFromSelection(), and BOARD_NETLIST_UPDATER::updateFootprintGroup().

◆ 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.

Parameters
aContaineris a protobuf message to be unpacked and deserialized.
aCommitis 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.

◆ GetDesignBlockLibId()

const LIB_ID & EDA_GROUP::GetDesignBlockLibId ( ) const
inline

Definition at line 88 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 64 of file eda_group.h.

References m_items.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), collectGroupBoardItems(), collectGroupFootprints(), MULTICHANNEL_TOOL::copyRuleAreaContents(), EDIT_TOOL::DeleteItems(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), PCB_SELECTION_TOOL::itemPassesFilter(), FOOTPRINT::operator=(), PCB_VIA_STACK::Regenerate(), BOARD_INSPECTION_TOOL::reportClearance(), PCB_VIA_STACK::reuseMembers(), SCH_IO_KICAD_SEXPR::saveGroup(), PCB_GROUP::Serialize(), testGroupEqual(), and BOARD_NETLIST_UPDATER::updateFootprintGroup().

◆ GetItems() [2/2]

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

Definition at line 65 of file eda_group.h.

References m_items.

◆ GetName()

wxString EDA_GROUP::GetName ( ) const
inline

Definition at line 61 of file eda_group.h.

References m_name.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), createBoard(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_GROUP::Matches(), SCH_GROUP::Matches(), PCB_GROUP_DESC::PCB_GROUP_DESC(), SCH_IO_KICAD_SEXPR::saveGroup(), SCH_GROUP_DESC::SCH_GROUP_DESC(), PCB_GROUP::Serialize(), SCH_GROUP::Serialize(), testGroupEqual(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), and BOARD_NETLIST_UPDATER::updateGroups().

◆ HasDesignBlockLink()

bool EDA_GROUP::HasDesignBlockLink ( ) const
inline

Definition at line 85 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 87 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 62 of file eda_group.h.

References m_name.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), createBoard(), CADSTAR_PCB_ARCHIVE_LOADER::createUniqueGroupID(), PCB_GROUP::DeserializeGroup(), SCH_GROUP::DeserializeGroup(), SCH_DRAWING_TOOLS::DrawSheet(), CADSTAR_PCB_ARCHIVE_LOADER::loadGroups(), PCB_GROUP_DESC::PCB_GROUP_DESC(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_GROUP_DESC::SCH_GROUP_DESC(), PCB_EDIT_FRAME::UpdateDesignBlockFromSelection(), SCH_EDIT_FRAME::UpdateDesignBlockFromSelection(), and BOARD_NETLIST_UPDATER::updateFootprintGroup().

Member Data Documentation

◆ m_designBlockLibId

LIB_ID EDA_GROUP::m_designBlockLibId
protected

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

Referenced by AddItem(), PCB_GENERATOR::DeepClone(), PCB_GROUP::DeepClone(), SCH_GROUP::DeepClone(), PCB_GROUP::DeepDuplicate(), SCH_GROUP::DeepDuplicate(), 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 92 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: