#include <panel_setup_severities.h>

Inheritance diagram for PANEL_SETUP_SEVERITIES:

Public Member Functions
	PANEL_SETUP_SEVERITIES (PAGED_DIALOG aParent, std::vector< std::reference_wrapper< RC_ITEM >> aItems, std::map< int, SEVERITY > &aSeverities, RC_ITEM aPinMapSpecialCase=nullptr)
	Creates the severities setup panel. More...

void	ImportSettingsFrom (std::map< int, SEVERITY > &aSettings)

Private Member Functions
bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

Private Attributes
std::map< int, SEVERITY > &	m_severities

std::vector< std::reference_wrapper< RC_ITEM > >	m_items
	A list of item templates (to get descriptive text and error codes from) More...

RC_ITEM *	m_pinMapSpecialCase
	For ERC settings; a pointer to ERC_ITEM::pinTableConflict. More...

std::map< int, wxRadioButton *[4]>	m_buttonMap

Detailed Description

Definition at line 37 of file panel_setup_severities.h.

Constructor & Destructor Documentation

◆ PANEL_SETUP_SEVERITIES()

PANEL_SETUP_SEVERITIES::PANEL_SETUP_SEVERITIES	(	PAGED_DIALOG *	aParent,
		std::vector< std::reference_wrapper< RC_ITEM >>	aItems,
		std::map< int, SEVERITY > &	aSeverities,
		RC_ITEM *	aPinMapSpecialCase = `nullptr`
	)

Creates the severities setup panel.

Parameters

aParent	is the dialog parent
aItems	is a list of error types that can have a severity. Must have one or more!
aSeverities	is a map of error code to severity
aPinMapSpecialCase	is used to special-case the ERCE_PIN_TO_PIN_WARNING

Definition at line 34 of file panel_setup_severities.cpp.

                                                                               :
         wxPanel( aParent->GetTreebook() ),
         m_severities( aSeverities ),
         m_items( aItems ),
         m_pinMapSpecialCase( aPinMapSpecialCase )
 {
     wxString          severities[]  = { _( "Error" ), _( "Warning" ), _( "Ignore" ) };
     int               severityCount = sizeof( severities ) / sizeof( wxString );
     int               baseID        = 1000;
     wxBoxSizer*       panelSizer    = new wxBoxSizer( wxVERTICAL );
     wxScrolledWindow* scrollWin     = new wxScrolledWindow( this, wxID_ANY,
                                                             wxDefaultPosition, wxDefaultSize,
                                                             wxTAB_TRAVERSAL | wxVSCROLL );
     bool              firstLine     = true;
 
     scrollWin->SetScrollRate( 0, 5 );
 
     wxFlexGridSizer* gridSizer = new wxFlexGridSizer( 0, 2, 0, 5 );
     gridSizer->SetFlexibleDirection( wxBOTH );
     gridSizer->SetVGap( 5 );
 
     for( const RC_ITEM& item : m_items )
     {
         int      errorCode = item.GetErrorCode();
         wxString msg       = item.GetErrorText();
 
         if( m_pinMapSpecialCase && errorCode == m_pinMapSpecialCase->GetErrorCode() )
             continue;
 
         if( errorCode == 0 )
         {
             wxStaticText* heading = new wxStaticText( scrollWin, wxID_ANY, msg );
             wxFont        headingFont = heading->GetFont();
 
             heading->SetFont( headingFont.Bold() );
 
             if( !firstLine )
             {
                 gridSizer->AddSpacer( 5 );  // col 1
                 gridSizer->AddSpacer( 5 );  // col 2
             }
 
             gridSizer->Add( heading, 0, wxALIGN_BOTTOM | wxALL | wxEXPAND, 4  );
             gridSizer->AddSpacer( 0 );  // col 2
         }
         else if( !msg.IsEmpty() )   // items with no message are for internal use only
         {
             wxStaticText* errorLabel = new wxStaticText( scrollWin, wxID_ANY, msg + wxT( ":" ) );
             gridSizer->Add( errorLabel, 0, wxALIGN_CENTER_VERTICAL | wxLEFT, 15  );
 
             // OSX can't handle more than 100 radio buttons in a single window (yes, seriously),
             // so we have to create a window for each set
             wxPanel*    radioPanel = new wxPanel( scrollWin );
             wxBoxSizer* radioSizer = new wxBoxSizer( wxHORIZONTAL );
 
             for( int i = 0; i < severityCount; ++i )
             {
                 m_buttonMap[ errorCode ][i] = new wxRadioButton( radioPanel,
                                                                  baseID + errorCode * 10 + i,
                                                                  severities[i],
                                                                  wxDefaultPosition, wxDefaultSize,
                                                                  i == 0 ? wxRB_GROUP : 0 );
                 radioSizer->Add( m_buttonMap[ errorCode ][i], 0,
                                  wxRIGHT | wxALIGN_CENTER_VERTICAL, 30 );
             }
 
             radioPanel->SetSizer( radioSizer );
             radioPanel->Layout();
             gridSizer->Add( radioPanel, 0, wxALIGN_CENTER_VERTICAL  );
         }
 
         firstLine = false;
     }
 
 
     if( m_pinMapSpecialCase )
     {
         wxString pinMapSeverities[] = { _( "From Pin Conflicts Map" ), wxT( "" ), _( "Ignore" ) };
         int      errorCode          = m_pinMapSpecialCase->GetErrorCode();
         wxString msg                = m_pinMapSpecialCase->GetErrorText();
 
         wxStaticText* errorLabel = new wxStaticText( scrollWin, wxID_ANY, msg + wxT( ":" ) );
         gridSizer->Add( errorLabel, 0, wxALIGN_CENTER_VERTICAL | wxALL | wxEXPAND, 15  );
 
         wxPanel*    radioPanel = new wxPanel( scrollWin );
         wxBoxSizer* radioSizer = new wxBoxSizer( wxHORIZONTAL );
 
         for( size_t i = 0; i < 3; ++i )
         {
             if( pinMapSeverities[i] == wxT( "" ) )
             {
                 wxStaticText* spacer = new wxStaticText( radioPanel, wxID_ANY, wxT( "" ) );
                 radioSizer->Add( spacer, 0, wxRIGHT | wxEXPAND, 17 );
             }
             else
             {
                 m_buttonMap[ errorCode ][i] = new wxRadioButton( radioPanel,
                                                                  baseID + errorCode * 10 + i,
                                                                  pinMapSeverities[i],
                                                                  wxDefaultPosition, wxDefaultSize,
                                                                  i == 0 ? wxRB_GROUP : 0 );
                 radioSizer->Add( m_buttonMap[ errorCode ][i], 0, wxEXPAND );
             }
         }
 
         radioPanel->SetSizer( radioSizer );
         radioPanel->Layout();
         gridSizer->Add( radioPanel, 0, wxALIGN_CENTER_VERTICAL  );
     }
 
     scrollWin->SetSizer( gridSizer );
     scrollWin->Layout();
     gridSizer->Fit( scrollWin );
     panelSizer->Add( scrollWin, 1, wxEXPAND | wxALL, 5 );
 
     SetSizer( panelSizer );
     Layout();
     panelSizer->Fit( this );
 }

References _, RC_ITEM::GetErrorCode(), RC_ITEM::GetErrorText(), m_buttonMap, m_items, and m_pinMapSpecialCase.

Member Function Documentation

◆ ImportSettingsFrom()

void PANEL_SETUP_SEVERITIES::ImportSettingsFrom ( std::map< int, SEVERITY > & aSettings )

Definition at line 158 of file panel_setup_severities.cpp.

 {
     for( const RC_ITEM& item : m_items )
     {
         int errorCode = item.GetErrorCode();
 
         if(! m_buttonMap[ errorCode ][0] )  // this entry does not actually exist
             continue;
 
         switch( aSettings[ errorCode ] )
         {
         case RPT_SEVERITY_ERROR:   m_buttonMap[ errorCode ][0]->SetValue( true ); break;
         case RPT_SEVERITY_WARNING: m_buttonMap[ errorCode ][1]->SetValue( true ); break;
         case RPT_SEVERITY_IGNORE:  m_buttonMap[ errorCode ][2]->SetValue( true ); break;
         default:                                                                  break;
         }
     }
 
     if( m_pinMapSpecialCase )
     {
         int pinMapCode  = m_pinMapSpecialCase->GetErrorCode();
         int newSeverity = aSettings[ pinMapCode ];
 
         m_buttonMap[ pinMapCode ][0]->SetValue( newSeverity != RPT_SEVERITY_IGNORE );
         m_buttonMap[ pinMapCode ][2]->SetValue( newSeverity == RPT_SEVERITY_IGNORE );
     }
 }

References RC_ITEM::GetErrorCode(), m_buttonMap, m_items, m_pinMapSpecialCase, RPT_SEVERITY_ERROR, RPT_SEVERITY_IGNORE, and RPT_SEVERITY_WARNING.

Referenced by DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), and DIALOG_BOARD_SETUP::OnAuxiliaryAction().

◆ TransferDataFromWindow()

bool PANEL_SETUP_SEVERITIES::TransferDataFromWindow ( )

overrideprivate

Definition at line 221 of file panel_setup_severities.cpp.

 {
     for( const RC_ITEM& item : m_items )
     {
         int errorCode = item.GetErrorCode();
 
         if( m_pinMapSpecialCase && m_pinMapSpecialCase->GetErrorCode() == errorCode )
             continue;
 
         if( !m_buttonMap[ errorCode ][0] )  // this entry does not actually exist
             continue;
 
         SEVERITY severity = RPT_SEVERITY_UNDEFINED;
 
         if( m_buttonMap[ errorCode ][0]->GetValue() )
             severity = RPT_SEVERITY_ERROR;
         else if( m_buttonMap[ errorCode ][1]->GetValue() )
             severity = RPT_SEVERITY_WARNING;
         else if( m_buttonMap[ errorCode ][2]->GetValue() )
             severity = RPT_SEVERITY_IGNORE;
 
         m_severities[ errorCode ] = severity;
     }
 
     if( m_pinMapSpecialCase )
     {
         int      pinMapCode = m_pinMapSpecialCase->GetErrorCode();
         SEVERITY severity   = RPT_SEVERITY_UNDEFINED;
 
         if( m_buttonMap[ pinMapCode ][0]->GetValue() )
             severity = RPT_SEVERITY_ERROR;
         else if( m_buttonMap[ pinMapCode ][2]->GetValue() )
             severity = RPT_SEVERITY_IGNORE;
 
         m_severities[ pinMapCode ] = severity;
     }
 
     return true;
 }

References RC_ITEM::GetErrorCode(), m_buttonMap, m_items, m_pinMapSpecialCase, m_severities, RPT_SEVERITY_ERROR, RPT_SEVERITY_IGNORE, RPT_SEVERITY_UNDEFINED, and RPT_SEVERITY_WARNING.

◆ TransferDataToWindow()

bool PANEL_SETUP_SEVERITIES::TransferDataToWindow ( )

overrideprivate

Definition at line 187 of file panel_setup_severities.cpp.

 {
     for( const RC_ITEM& item : m_items )
     {
         int errorCode = item.GetErrorCode();
 
         if( !m_buttonMap[ errorCode ][0] )  // this entry does not actually exist
             continue;
 
         if( m_pinMapSpecialCase && errorCode == m_pinMapSpecialCase->GetErrorCode() )
             continue;
 
         switch( m_severities[ errorCode ] )
         {
         case RPT_SEVERITY_ERROR:   m_buttonMap[ errorCode ][0]->SetValue( true ); break;
         case RPT_SEVERITY_WARNING: m_buttonMap[ errorCode ][1]->SetValue( true ); break;
         case RPT_SEVERITY_IGNORE:  m_buttonMap[ errorCode ][2]->SetValue( true ); break;
         default:                                                                  break;
         }
     }
 
     if( m_pinMapSpecialCase )
     {
         int pinMapCode = m_pinMapSpecialCase->GetErrorCode();
         int severity   = m_severities[pinMapCode];
 
         m_buttonMap[ pinMapCode ][0]->SetValue( severity != RPT_SEVERITY_IGNORE );
         m_buttonMap[ pinMapCode ][2]->SetValue( severity == RPT_SEVERITY_IGNORE );
     }
 
     return true;
 }

References RC_ITEM::GetErrorCode(), m_buttonMap, m_items, m_pinMapSpecialCase, m_severities, RPT_SEVERITY_ERROR, RPT_SEVERITY_IGNORE, and RPT_SEVERITY_WARNING.

Member Data Documentation

◆ m_buttonMap

std::map<int, wxRadioButton*[4]> PANEL_SETUP_SEVERITIES::m_buttonMap

private

Definition at line 48 of file panel_setup_severities.h.

Referenced by ImportSettingsFrom(), PANEL_SETUP_SEVERITIES(), TransferDataFromWindow(), and TransferDataToWindow().

◆ m_items

std::vector<std::reference_wrapper<RC_ITEM> > PANEL_SETUP_SEVERITIES::m_items

private

A list of item templates (to get descriptive text and error codes from)

Definition at line 43 of file panel_setup_severities.h.

Referenced by ImportSettingsFrom(), PANEL_SETUP_SEVERITIES(), TransferDataFromWindow(), and TransferDataToWindow().

◆ m_pinMapSpecialCase

RC_ITEM* PANEL_SETUP_SEVERITIES::m_pinMapSpecialCase

private

For ERC settings; a pointer to ERC_ITEM::pinTableConflict.

Definition at line 46 of file panel_setup_severities.h.

Referenced by ImportSettingsFrom(), PANEL_SETUP_SEVERITIES(), TransferDataFromWindow(), and TransferDataToWindow().

◆ m_severities

std::map<int, SEVERITY>& PANEL_SETUP_SEVERITIES::m_severities

private

Definition at line 40 of file panel_setup_severities.h.

Referenced by TransferDataFromWindow(), and TransferDataToWindow().

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PANEL_SETUP_SEVERITIES()

Member Function Documentation

◆ ImportSettingsFrom()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

Member Data Documentation

◆ m_buttonMap

◆ m_items

◆ m_pinMapSpecialCase

◆ m_severities