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

A specialisation of the RC_TREE_MODEL class to enable ERC errors / warnings to be resolved in a specific sheet path context. More...

#include <erc_item.h>

Inheritance diagram for ERC_TREE_MODEL:
RC_TREE_MODEL

Public Member Functions

 ERC_TREE_MODEL (EDA_DRAW_FRAME *aParentFrame, wxDataViewCtrl *aView)
 
 ~ERC_TREE_MODEL ()
 
void GetValue (wxVariant &aVariant, wxDataViewItem const &aItem, unsigned int aCol) const override
 Override of RC_TREE_MODEL::GetValue which returns item descriptions in a specific SCH_SHEET_PATH context, if a context is available on the given SCH_MARKER or ERC_ITEM targets.
 
const wxDataViewCtrl * GetView () const
 
void Update (std::shared_ptr< RC_ITEMS_PROVIDER > aProvider, int aSeverities)
 
void ExpandAll ()
 
void PrevMarker ()
 
void NextMarker ()
 
void SelectMarker (const MARKER_BASE *aMarker)
 
void CenterMarker (const MARKER_BASE *aMarker)
 
bool IsContainer (wxDataViewItem const &aItem) const override
 
wxDataViewItem GetParent (wxDataViewItem const &aItem) const override
 
unsigned int GetChildren (wxDataViewItem const &aItem, wxDataViewItemArray &aChildren) const override
 
unsigned int GetColumnCount () const override
 
wxString GetColumnType (unsigned int aCol) const override
 
bool HasContainerColumns (wxDataViewItem const &aItem) const override
 
bool HasValue (const wxDataViewItem &item, unsigned col) const override
 
bool SetValue (wxVariant const &aVariant, wxDataViewItem const &aItem, unsigned int aCol) override
 Called by the wxDataView to edit an item's content.
 
bool GetAttr (wxDataViewItem const &aItem, unsigned int aCol, wxDataViewItemAttr &aAttr) const override
 Called by the wxDataView to fetch an item's formatting.
 
void ValueChanged (RC_TREE_NODE *aNode)
 
void DeleteCurrentItem (bool aDeep)
 
void DeleteItems (bool aCurrentOnly, bool aIncludeExclusions, bool aDeep)
 Delete the current item or all items.
 

Static Public Member Functions

static wxDataViewItem ToItem (RC_TREE_NODE const *aNode)
 
static RC_TREE_NODE * ToNode (wxDataViewItem aItem)
 
static KIID ToUUID (wxDataViewItem aItem)
 

Protected Member Functions

void rebuildModel (std::shared_ptr< RC_ITEMS_PROVIDER > aProvider, int aSeverities)
 

Protected Attributes

EDA_DRAW_FRAME * m_editFrame
 
wxDataViewCtrl * m_view
 
int m_severities
 
std::shared_ptr< RC_ITEMS_PROVIDER > m_rcItemsProvider
 
std::vector< RC_TREE_NODE * > m_tree
 

Detailed Description

A specialisation of the RC_TREE_MODEL class to enable ERC errors / warnings to be resolved in a specific sheet path context.

This allows the displayed ERC descriptions in the ERC dialog to reflect component references on a per-sheet basis in hierarchical schematics.

See also
RC_TREE_MODEL

Definition at line 37 of file erc_item.h.

Constructor & Destructor Documentation

◆ ERC_TREE_MODEL()

ERC_TREE_MODEL::ERC_TREE_MODEL ( EDA_DRAW_FRAME * aParentFrame,
wxDataViewCtrl * aView )
inline

Definition at line 40 of file erc_item.h.

References RC_TREE_MODEL::RC_TREE_MODEL().

◆ ~ERC_TREE_MODEL()

ERC_TREE_MODEL::~ERC_TREE_MODEL ( )
inline

Definition at line 45 of file erc_item.h.

Member Function Documentation

◆ CenterMarker()

void RC_TREE_MODEL::CenterMarker ( const MARKER_BASE * aMarker)
inherited

Definition at line 754 of file rc_item.cpp.

References m_tree, m_view, and ToItem().

◆ DeleteCurrentItem()

void RC_TREE_MODEL::DeleteCurrentItem ( bool aDeep)
inherited

Definition at line 567 of file rc_item.cpp.

References DeleteItems().

Referenced by DIALOG_DRC::OnDRCItemRClick(), and DIALOG_ERC::OnERCItemRClick().

◆ DeleteItems()

void RC_TREE_MODEL::DeleteItems ( bool aCurrentOnly,
bool aIncludeExclusions,
bool aDeep )
inherited

Delete the current item or all items.

If all, aIncludeExclusions determines whether or not exclusions are also deleted.

Keep a vector of elements to free after wxWidgets is definitely done accessing them

Definition at line 573 of file rc_item.cpp.

References MARKER_BASE::GetSeverity(), RC_TREE_NODE::m_RcItem, m_rcItemsProvider, m_tree, m_view, RPT_SEVERITY_EXCLUSION, ToItem(), and ToNode().

Referenced by DeleteCurrentItem().

◆ ExpandAll()

void RC_TREE_MODEL::ExpandAll ( )
inherited

Definition at line 367 of file rc_item.cpp.

References m_tree, m_view, and ToItem().

Referenced by rebuildModel().

◆ GetAttr()

bool RC_TREE_MODEL::GetAttr ( wxDataViewItem const & aItem,
unsigned int aCol,
wxDataViewItemAttr & aAttr ) const
overrideinherited

Called by the wxDataView to fetch an item's formatting.

Return true if the item has non-default attributes.

Definition at line 476 of file rc_item.cpp.

References KIGFX::COLOR4D::GetBrightness(), RC_ITEM::GetParent(), MARKER_BASE::GetSeverity(), RC_TREE_NODE::m_RcItem, RC_TREE_NODE::m_Type, m_view, RC_TREE_NODE::MARKER, RPT_SEVERITY_EXCLUSION, and ToNode().

◆ GetChildren()

unsigned int RC_TREE_MODEL::GetChildren ( wxDataViewItem const & aItem,
wxDataViewItemArray & aChildren ) const
overrideinherited

Definition at line 389 of file rc_item.cpp.

References RC_TREE_NODE::m_Children, m_tree, ToItem(), and ToNode().

◆ GetColumnCount()

unsigned int RC_TREE_MODEL::GetColumnCount ( ) const
inlineoverrideinherited

Definition at line 278 of file rc_item.h.

◆ GetColumnType()

wxString RC_TREE_MODEL::GetColumnType ( unsigned int aCol) const
inlineoverrideinherited

Definition at line 279 of file rc_item.h.

◆ GetParent()

wxDataViewItem RC_TREE_MODEL::GetParent ( wxDataViewItem const & aItem) const
overrideinherited

Definition at line 383 of file rc_item.cpp.

References ToItem(), and ToNode().

◆ GetValue()

void ERC_TREE_MODEL::GetValue ( wxVariant & aVariant,
wxDataViewItem const & aItem,
unsigned int aCol ) const
override

Override of RC_TREE_MODEL::GetValue which returns item descriptions in a specific SCH_SHEET_PATH context, if a context is available on the given SCH_MARKER or ERC_ITEM targets.

Definition at line 374 of file erc_item.cpp.

References _, RC_TREE_NODE::AUX_ITEM, RC_TREE_NODE::AUX_ITEM2, RC_TREE_NODE::AUX_ITEM3, RC_TREE_NODE::COMMENT, MARKER_BASE::GetComment(), SCH_EDIT_FRAME::GetCurrentSheet(), EDA_ITEM::GetItemDescription(), MARKER_BASE::GetMarkerType(), SCH_EDIT_FRAME::GetSeverity(), RC_TREE_MODEL::m_editFrame, RC_TREE_NODE::m_RcItem, RC_TREE_NODE::m_Type, RC_TREE_NODE::MAIN_ITEM, RC_TREE_NODE::MARKER, MARKER_BASE::MARKER_DRAWING_SHEET, SCH_EDIT_FRAME::ResolveItem(), RPT_SEVERITY_EXCLUSION, RPT_SEVERITY_WARNING, SCH_EDIT_FRAME::SetCurrentSheet(), RC_TREE_MODEL::ToNode(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

◆ GetView()

const wxDataViewCtrl * RC_TREE_MODEL::GetView ( ) const
inlineinherited

Definition at line 248 of file rc_item.h.

References m_view.

◆ HasContainerColumns()

bool RC_TREE_MODEL::HasContainerColumns ( wxDataViewItem const & aItem) const
inlineoverrideinherited

Definition at line 280 of file rc_item.h.

◆ HasValue()

bool RC_TREE_MODEL::HasValue ( const wxDataViewItem & item,
unsigned col ) const
inlineoverrideinherited

Definition at line 282 of file rc_item.h.

References m_tree.

◆ IsContainer()

bool RC_TREE_MODEL::IsContainer ( wxDataViewItem const & aItem) const
overrideinherited

Definition at line 374 of file rc_item.cpp.

References RC_TREE_NODE::m_Type, RC_TREE_NODE::MARKER, and ToNode().

◆ NextMarker()

void RC_TREE_MODEL::NextMarker ( )
inherited

Definition at line 711 of file rc_item.cpp.

References RC_TREE_NODE::m_Parent, m_tree, RC_TREE_NODE::m_Type, m_view, RC_TREE_NODE::MARKER, ToItem(), and ToNode().

◆ PrevMarker()

void RC_TREE_MODEL::PrevMarker ( )
inherited

Definition at line 690 of file rc_item.cpp.

References RC_TREE_NODE::m_Parent, m_tree, RC_TREE_NODE::m_Type, m_view, RC_TREE_NODE::MARKER, ToItem(), and ToNode().

◆ rebuildModel()

void RC_TREE_MODEL::rebuildModel ( std::shared_ptr< RC_ITEMS_PROVIDER > aProvider,
int aSeverities )
protectedinherited

Definition at line 263 of file rc_item.cpp.

References RC_TREE_NODE::AUX_ITEM, RC_TREE_NODE::AUX_ITEM2, RC_TREE_NODE::AUX_ITEM3, RC_TREE_NODE::COMMENT, ExpandAll(), RC_TREE_NODE::m_Children, RC_TREE_NODE::m_RcItem, m_rcItemsProvider, m_severities, m_tree, m_view, RC_TREE_NODE::MAIN_ITEM, RC_TREE_NODE::MARKER, niluuid, ToItem(), and ToNode().

Referenced by Update().

◆ SelectMarker()

void RC_TREE_MODEL::SelectMarker ( const MARKER_BASE * aMarker)
inherited

Definition at line 739 of file rc_item.cpp.

References m_tree, m_view, and ToItem().

◆ SetValue()

bool RC_TREE_MODEL::SetValue ( wxVariant const & aVariant,
wxDataViewItem const & aItem,
unsigned int aCol )
inlineoverrideinherited

Called by the wxDataView to edit an item's content.

Definition at line 299 of file rc_item.h.

◆ ToItem()

static wxDataViewItem RC_TREE_MODEL::ToItem ( RC_TREE_NODE const * aNode)
inlinestaticinherited

Definition at line 238 of file rc_item.h.

Referenced by CenterMarker(), DeleteItems(), ExpandAll(), GetChildren(), GetParent(), NextMarker(), PrevMarker(), rebuildModel(), SelectMarker(), and ValueChanged().

◆ ToNode()

static RC_TREE_NODE * RC_TREE_MODEL::ToNode ( wxDataViewItem aItem)
inlinestaticinherited

Definition at line 243 of file rc_item.h.

Referenced by DeleteItems(), DIALOG_DRC::ExcludeMarker(), DIALOG_ERC::ExcludeMarker(), GetAttr(), GetChildren(), GetParent(), ERC_TREE_MODEL::GetValue(), GetValue(), IsContainer(), NextMarker(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnERCItemRClick(), DIALOG_ERC::OnERCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), PrevMarker(), rebuildModel(), and ToUUID().

◆ ToUUID()

KIID RC_TREE_MODEL::ToUUID ( wxDataViewItem aItem)
staticinherited

Definition at line 217 of file rc_item.cpp.

References RC_TREE_NODE::AUX_ITEM, RC_TREE_NODE::AUX_ITEM2, RC_TREE_NODE::AUX_ITEM3, RC_TREE_NODE::COMMENT, RC_TREE_NODE::m_RcItem, RC_TREE_NODE::m_Type, RC_TREE_NODE::MAIN_ITEM, RC_TREE_NODE::MARKER, niluuid, and ToNode().

Referenced by DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), and DIALOG_FOOTPRINT_CHECKER::OnSelectItem().

◆ Update()

void RC_TREE_MODEL::Update ( std::shared_ptr< RC_ITEMS_PROVIDER > aProvider,
int aSeverities )
inherited

Definition at line 361 of file rc_item.cpp.

References rebuildModel().

Referenced by DIALOG_DRC::OnDRCItemRClick(), and DIALOG_ERC::OnERCItemRClick().

◆ ValueChanged()

void RC_TREE_MODEL::ValueChanged ( RC_TREE_NODE * aNode)
inherited

Definition at line 518 of file rc_item.cpp.

References RC_TREE_NODE::COMMENT, MARKER_BASE::GetComment(), MARKER_BASE::IsExcluded(), RC_TREE_NODE::m_Children, RC_TREE_NODE::m_Parent, RC_TREE_NODE::m_RcItem, RC_TREE_NODE::m_Type, RC_TREE_NODE::MARKER, ToItem(), and ValueChanged().

Referenced by DIALOG_DRC::OnDRCItemRClick(), DIALOG_ERC::OnERCItemRClick(), and ValueChanged().

Member Data Documentation

◆ m_editFrame

EDA_DRAW_FRAME* RC_TREE_MODEL::m_editFrame
protectedinherited

Definition at line 327 of file rc_item.h.

Referenced by ERC_TREE_MODEL::GetValue(), GetValue(), and RC_TREE_MODEL().

◆ m_rcItemsProvider

std::shared_ptr<RC_ITEMS_PROVIDER> RC_TREE_MODEL::m_rcItemsProvider
protectedinherited

Definition at line 330 of file rc_item.h.

Referenced by DeleteItems(), RC_TREE_MODEL(), and rebuildModel().

◆ m_severities

int RC_TREE_MODEL::m_severities
protectedinherited

Definition at line 329 of file rc_item.h.

Referenced by RC_TREE_MODEL(), and rebuildModel().

◆ m_tree

std::vector<RC_TREE_NODE*> RC_TREE_MODEL::m_tree
protectedinherited

Definition at line 332 of file rc_item.h.

Referenced by CenterMarker(), DeleteItems(), ExpandAll(), GetChildren(), HasValue(), NextMarker(), PrevMarker(), rebuildModel(), SelectMarker(), and ~RC_TREE_MODEL().

◆ m_view

wxDataViewCtrl* RC_TREE_MODEL::m_view
protectedinherited

Definition at line 328 of file rc_item.h.

Referenced by CenterMarker(), DeleteItems(), ExpandAll(), GetAttr(), GetValue(), GetView(), NextMarker(), PrevMarker(), RC_TREE_MODEL(), rebuildModel(), and SelectMarker().

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