eda_group.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef EDA_GROUP_H
#define EDA_GROUP_H
 
#include <commit.h>
#include <eda_item.h>
#include <lib_id.h>
#include <lset.h>
#include <unordered_set>
 
namespace KIGFX
{
class VIEW;
}

class EDA_GROUP
{
public:
    virtual EDA_ITEM* AsEdaItem() = 0;
    virtual ~EDA_GROUP() = default;

    virtual bool DeserializeGroup( const google::protobuf::Any& aContainer, COMMIT* aCommit ) = 0;
 
    wxString GetName() const { return m_name; }
    void     SetName( const wxString& aName ) { m_name = aName; }
 
    std::unordered_set<EDA_ITEM*>& GetItems() { return m_items; }
    const std::unordered_set<EDA_ITEM*>& GetItems() const { return m_items; }

    bool ContainsItem( const EDA_ITEM* aItem ) const;

    void AddItem( EDA_ITEM* aItem );

    void RemoveItem( EDA_ITEM* aItem );
    void RemoveAll();
 
    std::vector<KIID> GetGroupMemberIds() const;
 
    bool HasDesignBlockLink() const { return m_designBlockLibId.IsValid(); }
 
    void SetDesignBlockLibId( const LIB_ID& aLibId ) { m_designBlockLibId = aLibId; }
    const LIB_ID& GetDesignBlockLibId() const { return m_designBlockLibId; }
 
protected:
    std::unordered_set<EDA_ITEM*> m_items;             // Members of the group (no ownership)
    wxString                      m_name;              // Optional group name
    LIB_ID                        m_designBlockLibId;  // Optional link to a design block
};
 
#endif // CLASS_PCB_GROUP_H_