A holder for a rule check item, DRC in Pcbnew or ERC in Eeschema. More...

#include <rc_item.h>

Inheritance diagram for RC_ITEM:

Public Types
typedef std::vector< KIID >	KIIDS

Public Member Functions
	RC_ITEM ()

	RC_ITEM (const std::shared_ptr< RC_ITEM > &aItem)

virtual	~RC_ITEM ()

void	SetErrorMessage (const wxString &aMessage)

void	SetItems (const KIIDS &aIds)

void	AddItem (EDA_ITEM *aItem)

void	SetItems (const EDA_ITEM aItem, const EDA_ITEM bItem=nullptr, const EDA_ITEM cItem=nullptr, const EDA_ITEM dItem=nullptr)

void	SetItems (const KIID &aItem, const KIID &bItem=niluuid, const KIID &cItem=niluuid, const KIID &dItem=niluuid)

virtual KIID	GetMainItemID () const

virtual KIID	GetAuxItemID () const

virtual KIID	GetAuxItem2ID () const

virtual KIID	GetAuxItem3ID () const

std::vector< KIID >	GetIDs () const

void	SetParent (MARKER_BASE *aMarker)

MARKER_BASE *	GetParent () const

virtual wxString	ShowReport (UNITS_PROVIDER aUnitsProvider, SEVERITY aSeverity, const std::map< KIID, EDA_ITEM > &aItemMap) const
	Translate this object into a text string suitable for saving to disk in a report.

virtual void	GetJsonViolation (RC_JSON::VIOLATION &aViolation, UNITS_PROVIDER aUnitsProvider, SEVERITY aSeverity, const std::map< KIID, EDA_ITEM > &aItemMap) const
	Translate this object into an RC_JSON::VIOLATION object.

int	GetErrorCode () const

void	SetErrorCode (int aCode)

virtual wxString	GetErrorMessage () const

wxString	GetErrorText () const

wxString	GetSettingsKey () const

virtual wxString	GetViolatingRuleDesc () const

Static Protected Member Functions
static wxString	getSeverityString (SEVERITY aSeverity)

Protected Attributes
int	m_errorCode
	The error code's numeric value.

wxString	m_errorMessage
	A message describing the details of this specific error.

wxString	m_errorTitle
	The string describing the type of error.

wxString	m_settingsKey
	The key used to describe this type of error in settings.

MARKER_BASE *	m_parent
	The marker this item belongs to, if any.

KIIDS	m_ids

Detailed Description

A holder for a rule check item, DRC in Pcbnew or ERC in Eeschema.

RC_ITEMs can have zero, one, or two related EDA_ITEMs.

Definition at line 78 of file rc_item.h.

Member Typedef Documentation

◆ KIIDS

typedef std::vector<KIID> RC_ITEM::KIIDS

Definition at line 81 of file rc_item.h.

Constructor & Destructor Documentation

◆ RC_ITEM() [1/2]

RC_ITEM::RC_ITEM ( )

inline

Definition at line 83 of file rc_item.h.

◆ RC_ITEM() [2/2]

RC_ITEM::RC_ITEM ( const std::shared_ptr< RC_ITEM > & aItem )

inline

Definition at line 89 of file rc_item.h.

References m_errorCode, m_errorMessage, m_errorTitle, m_ids, m_parent, and m_settingsKey.

◆ ~RC_ITEM()

virtual RC_ITEM::~RC_ITEM ( )

inlinevirtual

Definition at line 99 of file rc_item.h.

Member Function Documentation

◆ AddItem()

void RC_ITEM::AddItem ( EDA_ITEM * aItem )

Definition at line 56 of file rc_item.cpp.

References m_ids, and EDA_ITEM::m_Uuid.

◆ GetAuxItem2ID()

virtual KIID RC_ITEM::GetAuxItem2ID ( ) const

inlinevirtual

Reimplemented in DRC_ITEM.

Definition at line 123 of file rc_item.h.

References m_ids, and niluuid.

◆ GetAuxItem3ID()

virtual KIID RC_ITEM::GetAuxItem3ID ( ) const

inlinevirtual

Reimplemented in DRC_ITEM.

Definition at line 124 of file rc_item.h.

References m_ids, and niluuid.

◆ GetAuxItemID()

virtual KIID RC_ITEM::GetAuxItemID ( ) const

inlinevirtual

Definition at line 122 of file rc_item.h.

References m_ids, and niluuid.

Referenced by GetJsonViolation(), and ShowReport().

◆ GetErrorCode()

int RC_ITEM::GetErrorCode ( ) const

inline

Definition at line 153 of file rc_item.h.

References m_errorCode.

Referenced by SCH_MARKER::GetSeverity(), PCB_MARKER::GetSeverity(), ERC_REPORT::GetTextReport(), PANEL_SETUP_SEVERITIES::ImportSettingsFrom(), PANEL_SETUP_SEVERITIES::PANEL_SETUP_SEVERITIES(), PANEL_SETUP_SEVERITIES::TransferDataFromWindow(), PANEL_SETUP_SEVERITIES::TransferDataToWindow(), and ERC_REPORT::WriteJsonReport().

◆ GetErrorMessage()

wxString RC_ITEM::GetErrorMessage ( ) const

virtual

Returns: the error message describing the specific details of a RC_ITEM. For instance, "Clearance violation (netclass '100ohm' clearance 0.4000mm; actual 0.3200mm)"

Definition at line 39 of file rc_item.cpp.

References GetErrorText(), and m_errorMessage.

Referenced by GetJsonViolation(), and ShowReport().

◆ GetErrorText()

wxString RC_ITEM::GetErrorText ( ) const

inline

Returns: the error text for the class of error of this RC_ITEM represents. For instance, "Clearance violation".

Definition at line 166 of file rc_item.h.

References m_errorTitle.

Referenced by CLEANUP_ITEM::CLEANUP_ITEM(), GetErrorMessage(), and PANEL_SETUP_SEVERITIES::PANEL_SETUP_SEVERITIES().

◆ GetIDs()

std::vector< KIID > RC_ITEM::GetIDs ( ) const

inline

Definition at line 126 of file rc_item.h.

References m_ids.

◆ GetJsonViolation()

void RC_ITEM::GetJsonViolation	(	RC_JSON::VIOLATION &	aViolation,
		UNITS_PROVIDER *	aUnitsProvider,
		SEVERITY	aSeverity,
		const std::map< KIID, EDA_ITEM * > &	aItemMap
	)		const

virtual

Translate this object into an RC_JSON::VIOLATION object.

Parameters

aViolation	is the violation to be populated by info from this item
aUnitsProvider	is the units provider that will be used to output coordinates
aSeverity	is the severity of this item
aItemMap	is a map allowing the lookup of items from KIIDs

Returns: None

Definition at line 166 of file rc_item.cpp.

References KIID::AsString(), RC_JSON::AFFECTED_ITEM::description, RC_JSON::VIOLATION::description, RC_JSON::VIOLATION::excluded, GetAuxItemID(), GetErrorMessage(), EDA_ITEM::GetItemDescription(), UNITS_PROVIDER::GetIuScale(), GetMainItemID(), EDA_ITEM::GetPosition(), GetSettingsKey(), getSeverityString(), UNITS_PROVIDER::GetUserUnits(), MARKER_BASE::IsExcluded(), RC_JSON::VIOLATION::items, m_parent, EDA_ITEM::m_Uuid, RC_JSON::AFFECTED_ITEM::pos, RC_JSON::VIOLATION::severity, EDA_UNIT_UTILS::UI::ToUserUnit(), RC_JSON::VIOLATION::type, RC_JSON::AFFECTED_ITEM::uuid, RC_JSON::COORDINATE::x, VECTOR2< T >::x, RC_JSON::COORDINATE::y, and VECTOR2< T >::y.

◆ GetMainItemID()

virtual KIID RC_ITEM::GetMainItemID ( ) const

inlinevirtual

Definition at line 121 of file rc_item.h.

References m_ids, and niluuid.

Referenced by GetJsonViolation(), and ShowReport().

◆ GetParent()

MARKER_BASE * RC_ITEM::GetParent ( ) const

inline

Definition at line 129 of file rc_item.h.

References m_parent.

◆ GetSettingsKey()

wxString RC_ITEM::GetSettingsKey ( ) const

inline

Definition at line 171 of file rc_item.h.

References m_settingsKey.

Referenced by GetJsonViolation(), and ShowReport().

◆ getSeverityString()

wxString RC_ITEM::getSeverityString ( SEVERITY aSeverity )

staticprotected

Definition at line 81 of file rc_item.cpp.

References RPT_SEVERITY_ACTION, RPT_SEVERITY_DEBUG, RPT_SEVERITY_ERROR, RPT_SEVERITY_EXCLUSION, RPT_SEVERITY_INFO, and RPT_SEVERITY_WARNING.

Referenced by GetJsonViolation(), and ShowReport().

◆ GetViolatingRuleDesc()

virtual wxString RC_ITEM::GetViolatingRuleDesc ( ) const

inlinevirtual

Reimplemented in DRC_ITEM.

Definition at line 176 of file rc_item.h.

Referenced by ShowReport().

◆ SetErrorCode()

void RC_ITEM::SetErrorCode ( int aCode )

inline

Definition at line 154 of file rc_item.h.

References m_errorCode.

◆ SetErrorMessage()

void RC_ITEM::SetErrorMessage ( const wxString & aMessage )

inline

Definition at line 101 of file rc_item.h.

References m_errorMessage.

◆ SetItems() [1/3]

void RC_ITEM::SetItems	(	const EDA_ITEM *	aItem,
		const EDA_ITEM *	bItem = `nullptr`,
		const EDA_ITEM *	cItem = `nullptr`,
		const EDA_ITEM *	dItem = `nullptr`
	)

Definition at line 62 of file rc_item.cpp.

References m_ids, and EDA_ITEM::m_Uuid.

◆ SetItems() [2/3]

void RC_ITEM::SetItems	(	const KIID &	aItem,
		const KIID &	bItem = `niluuid`,
		const KIID &	cItem = `niluuid`,
		const KIID &	dItem = `niluuid`
	)

inline

Definition at line 110 of file rc_item.h.

References m_ids.

◆ SetItems() [3/3]

void RC_ITEM::SetItems ( const KIIDS & aIds )

inline

Definition at line 103 of file rc_item.h.

References m_ids.

◆ SetParent()

void RC_ITEM::SetParent ( MARKER_BASE * aMarker )

inline

Definition at line 128 of file rc_item.h.

References m_parent.

◆ ShowReport()

wxString RC_ITEM::ShowReport	(	UNITS_PROVIDER *	aUnitsProvider,
		SEVERITY	aSeverity,
		const std::map< KIID, EDA_ITEM * > &	aItemMap
	)		const

virtual

Translate this object into a text string suitable for saving to disk in a report.

Returns: wxString - the simple multi-line report text.

Definition at line 100 of file rc_item.cpp.

References GetAuxItemID(), MARKER_BASE::GetComment(), GetErrorMessage(), EDA_ITEM::GetItemDescription(), GetMainItemID(), EDA_ITEM::GetPosition(), GetSettingsKey(), getSeverityString(), GetViolatingRuleDesc(), MARKER_BASE::IsExcluded(), m_parent, and showCoord().

Member Data Documentation

◆ m_errorCode

int RC_ITEM::m_errorCode

protected

The error code's numeric value.

Definition at line 184 of file rc_item.h.

Referenced by CLEANUP_ITEM::CLEANUP_ITEM(), DRC_ITEM::DRC_ITEM(), ERC_ITEM::ERC_ITEM(), DRC_ITEM::GetAuxItem2ID(), DRC_ITEM::GetAuxItem3ID(), GetErrorCode(), CLEANUP_ITEM::GetErrorText(), RC_ITEM(), and SetErrorCode().

◆ m_errorMessage

wxString RC_ITEM::m_errorMessage

protected

A message describing the details of this specific error.

Definition at line 185 of file rc_item.h.

Referenced by GetErrorMessage(), RC_ITEM(), and SetErrorMessage().

◆ m_errorTitle

wxString RC_ITEM::m_errorTitle

protected

The string describing the type of error.

Definition at line 186 of file rc_item.h.

Referenced by CLEANUP_ITEM::CLEANUP_ITEM(), DRC_ITEM::DRC_ITEM(), ERC_ITEM::ERC_ITEM(), GetErrorText(), and RC_ITEM().

◆ m_ids

KIIDS RC_ITEM::m_ids

protected

Definition at line 190 of file rc_item.h.

Referenced by AddItem(), GetAuxItem2ID(), DRC_ITEM::GetAuxItem2ID(), GetAuxItem3ID(), DRC_ITEM::GetAuxItem3ID(), GetAuxItemID(), GetIDs(), GetMainItemID(), RC_ITEM(), and SetItems().

◆ m_parent

MARKER_BASE* RC_ITEM::m_parent

protected

The marker this item belongs to, if any.

Definition at line 188 of file rc_item.h.

Referenced by DRC_ITEM::DRC_ITEM(), GetJsonViolation(), GetParent(), RC_ITEM(), SetParent(), and ShowReport().

◆ m_settingsKey

wxString RC_ITEM::m_settingsKey

protected

The key used to describe this type of error in settings.

Definition at line 187 of file rc_item.h.

Referenced by DRC_ITEM::DRC_ITEM(), ERC_ITEM::ERC_ITEM(), GetSettingsKey(), and RC_ITEM().

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

Public Types

Public Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ KIIDS

Constructor & Destructor Documentation

◆ RC_ITEM() [1/2]

◆ RC_ITEM() [2/2]

◆ ~RC_ITEM()

Member Function Documentation

◆ AddItem()

◆ GetAuxItem2ID()

◆ GetAuxItem3ID()

◆ GetAuxItemID()

◆ GetErrorCode()

◆ GetErrorMessage()

◆ GetErrorText()

◆ GetIDs()

◆ GetJsonViolation()

◆ GetMainItemID()

◆ GetParent()

◆ GetSettingsKey()

◆ getSeverityString()

◆ GetViolatingRuleDesc()

◆ SetErrorCode()

◆ SetErrorMessage()

◆ SetItems() [1/3]

◆ SetItems() [2/3]

◆ SetItems() [3/3]

◆ SetParent()

◆ ShowReport()

Member Data Documentation

◆ m_errorCode

◆ m_errorMessage

◆ m_errorTitle

◆ m_ids

◆ m_parent

◆ m_settingsKey