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:

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.

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

◆ ~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 751 of file rc_item.cpp.

References RC_TREE_MODEL::m_tree, RC_TREE_MODEL::m_view, and RC_TREE_MODEL::ToItem().

Referenced by DIALOG_ERC::centerMarkerIdleHandler(), DIALOG_FOOTPRINT_CHECKER::centerMarkerIdleHandler(), and DIALOG_DRC::SelectMarker().

◆ DeleteCurrentItem()

void RC_TREE_MODEL::DeleteCurrentItem ( bool aDeep )

inherited

Definition at line 566 of file rc_item.cpp.

References RC_TREE_MODEL::DeleteItems().

Referenced by DIALOG_DRC::ExcludeMarker(), DIALOG_ERC::ExcludeMarker(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnDeleteOneClick(), and DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick().

◆ DeleteItems()

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

inherited

Deletes 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 572 of file rc_item.cpp.

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

Referenced by DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), and RC_TREE_MODEL::DeleteCurrentItem().

◆ ExpandAll()

void RC_TREE_MODEL::ExpandAll ( )

inherited

Definition at line 370 of file rc_item.cpp.

References RC_TREE_MODEL::m_tree, RC_TREE_MODEL::m_view, and RC_TREE_MODEL::ToItem().

Referenced by RC_TREE_MODEL::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 477 of file rc_item.cpp.

References KIGFX::COLOR4D::GetBrightness(), RC_TREE_NODE::m_RcItem, RC_TREE_NODE::m_Type, RC_TREE_NODE::MARKER, RPT_SEVERITY_EXCLUSION, and RC_TREE_MODEL::ToNode().

◆ GetChildren()

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

overrideinherited

Definition at line 392 of file rc_item.cpp.

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

◆ GetColumnCount()

unsigned int RC_TREE_MODEL::GetColumnCount ( ) const

inlineoverrideinherited

Definition at line 264 of file rc_item.h.

◆ GetColumnType()

wxString RC_TREE_MODEL::GetColumnType ( unsigned int aCol ) const

inlineoverrideinherited

Definition at line 265 of file rc_item.h.

◆ GetParent()

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

overrideinherited

Definition at line 386 of file rc_item.cpp.

References RC_TREE_MODEL::ToItem(), and RC_TREE_MODEL::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 364 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(), SCH_EDIT_FRAME::GetItem(), 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, RPT_SEVERITY_EXCLUSION, RPT_SEVERITY_WARNING, SCH_EDIT_FRAME::SetCurrentSheet(), RC_TREE_MODEL::ToNode(), and SCH_SHEET_PATH::UpdateAllScreenReferences().