KiCad PCB EDA Suite
PANEL_RF_ATTENUATORS Class Reference

#include <panel_rf_attenuators.h>

Inheritance diagram for PANEL_RF_ATTENUATORS:
PANEL_RF_ATTENUATORS_BASE CALCULATOR_PANEL

Public Member Functions

 PANEL_RF_ATTENUATORS (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL, const wxString &name=wxEmptyString)
 
 ~PANEL_RF_ATTENUATORS ()
 
wxRadioBox * GetAttenuatorsSelector ()
 
void LoadSettings (PCB_CALCULATOR_SETTINGS *aCfg) override
 Load the settings into the panel. More...
 
void SaveSettings (PCB_CALCULATOR_SETTINGS *aCfg) override
 Save the settings from the panel. More...
 
void ThemeChanged () override
 Update UI elements of the panel when the theme changes to ensure the images and fonts/colors are appropriate for the new theme. More...
 
void UpdateUI ()
 
void OnAttenuatorSelection (wxCommandEvent &event) override
 
void SetAttenuator (unsigned aIdx)
 
void OnCalculateAttenuator (wxCommandEvent &event) override
 
void TransfPanelDataToAttenuator ()
 
void TransfAttenuatorDataToPanel ()
 
void TransfAttenuatorResultsToPanel ()
 

Public Attributes

ATTENUATORm_CurrAttenuator
 
std::vector< ATTENUATOR * > m_AttenuatorList
 

Protected Attributes

wxRadioBox * m_AttenuatorsSelection
 
wxStaticBitmap * m_attenuatorBitmap
 
wxStaticText * m_attenuationLabel
 
wxTextCtrl * m_AttValueCtrl
 
wxStaticText * m_attUnit
 
wxStaticText * m_attenuationZinLabel
 
wxTextCtrl * m_ZinValueCtrl
 
wxStaticText * m_attZinUnit
 
wxStaticText * m_ZoutLabel
 
wxTextCtrl * m_ZoutValueCtrl
 
wxStaticText * m_attZoutUnit
 
wxButton * m_buttonAlcAtt
 
STD_BITMAP_BUTTONm_bpButtonCalcAtt
 
wxStaticText * m_attenuatorR1Label
 
wxTextCtrl * m_Att_R1_Value
 
wxStaticText * m_attR1Unit
 
wxStaticText * m_attenuatorR2Label
 
wxTextCtrl * m_Att_R2_Value
 
wxStaticText * m_attR2Unit
 
wxStaticText * m_attenuatorR3Label
 
wxTextCtrl * m_Att_R3_Value
 
wxStaticText * m_attR3Unit
 
wxStaticText * m_staticTextAttMsg
 
HTML_WINDOWm_Attenuator_Messages
 
HTML_WINDOWm_panelAttFormula
 

Detailed Description

Definition at line 30 of file panel_rf_attenuators.h.

Constructor & Destructor Documentation

◆ PANEL_RF_ATTENUATORS()

PANEL_RF_ATTENUATORS::PANEL_RF_ATTENUATORS ( wxWindow *  parent,
wxWindowID  id = wxID_ANY,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxDefaultSize,
long  style = wxTAB_TRAVERSAL,
const wxString &  name = wxEmptyString 
)

Definition at line 36 of file panel_rf_attenuators.cpp.

37 :
38 PANEL_RF_ATTENUATORS_BASE( parent, id, pos, size, style, name )
39{
40 m_CurrAttenuator = nullptr;
42
43 // Populate attenuator list ordered like in dialog menu list
44 m_AttenuatorList.push_back( new ATTENUATOR_PI() );
45 m_AttenuatorList.push_back( new ATTENUATOR_TEE() );
46 m_AttenuatorList.push_back( new ATTENUATOR_BRIDGE() );
47 m_AttenuatorList.push_back( new ATTENUATOR_SPLITTER() );
49 SetAttenuator( 0 ); // Ensure an attenuator and especially its bitmap are set
50
51 m_staticTextAttMsg->SetFont( KIUI::GetInfoFont( this ).Italic() );
52
53 m_attZinUnit->SetLabel( wxT( "Ω" ) );
54 m_attZoutUnit->SetLabel( wxT( "Ω" ) );
55 m_attR1Unit->SetLabel( wxT( "Ω" ) );
56 m_attR2Unit->SetLabel( wxT( "Ω" ) );
57 m_attR3Unit->SetLabel( wxT( "Ω" ) );
58
59 // Needed on wxWidgets 3.0 to ensure sizers are correctly set
60 GetSizer()->SetSizeHints( this );
61}
const char * name
Definition: DXF_plotter.cpp:56
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:106
PANEL_RF_ATTENUATORS_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxTAB_TRAVERSAL, const wxString &name=wxEmptyString)
void SetAttenuator(unsigned aIdx)
std::vector< ATTENUATOR * > m_AttenuatorList
void SetBitmap(const wxBitmap &aBmp)
wxFont GetInfoFont(wxWindow *aWindow)
Definition: ui_common.cpp:156

References KIUI::GetInfoFont(), KiBitmap(), m_AttenuatorList, PANEL_RF_ATTENUATORS_BASE::m_attR1Unit, PANEL_RF_ATTENUATORS_BASE::m_attR2Unit, PANEL_RF_ATTENUATORS_BASE::m_attR3Unit, PANEL_RF_ATTENUATORS_BASE::m_attZinUnit, PANEL_RF_ATTENUATORS_BASE::m_attZoutUnit, PANEL_RF_ATTENUATORS_BASE::m_bpButtonCalcAtt, m_CurrAttenuator, PANEL_RF_ATTENUATORS_BASE::m_staticTextAttMsg, SetAttenuator(), STD_BITMAP_BUTTON::SetBitmap(), and small_down.

◆ ~PANEL_RF_ATTENUATORS()

PANEL_RF_ATTENUATORS::~PANEL_RF_ATTENUATORS ( )

Definition at line 64 of file panel_rf_attenuators.cpp.

65{
66 for( ATTENUATOR* attenuator : m_AttenuatorList )
67 delete attenuator;
68}

References m_AttenuatorList.

Member Function Documentation

◆ GetAttenuatorsSelector()

wxRadioBox * PANEL_RF_ATTENUATORS::GetAttenuatorsSelector ( )
inline

◆ LoadSettings()

void PANEL_RF_ATTENUATORS::LoadSettings ( PCB_CALCULATOR_SETTINGS aCfg)
overridevirtual

Load the settings into the panel.

Parameters
aCfgis the settings structure to load from

Implements CALCULATOR_PANEL.

Definition at line 98 of file panel_rf_attenuators.cpp.

99{
100 wxASSERT( aCfg );
101
102 for( ATTENUATOR* attenuator : m_AttenuatorList )
103 attenuator->ReadConfig();
104
105 m_AttenuatorsSelection->SetSelection( aCfg->m_Attenuators.type );
106 SetAttenuator( m_AttenuatorsSelection->GetSelection() );
107}

References m_AttenuatorList, PCB_CALCULATOR_SETTINGS::m_Attenuators, PANEL_RF_ATTENUATORS_BASE::m_AttenuatorsSelection, SetAttenuator(), and PCB_CALCULATOR_SETTINGS::ATTENUATORS::type.

◆ OnAttenuatorSelection()

void PANEL_RF_ATTENUATORS::OnAttenuatorSelection ( wxCommandEvent &  event)
overridevirtual

Reimplemented from PANEL_RF_ATTENUATORS_BASE.

Definition at line 122 of file panel_rf_attenuators.cpp.

123{
124 SetAttenuator( (unsigned) event.GetSelection() );
125 Refresh();
126}
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...

References Refresh(), and SetAttenuator().

◆ OnCalculateAttenuator()

void PANEL_RF_ATTENUATORS::OnCalculateAttenuator ( wxCommandEvent &  event)
overridevirtual

Reimplemented from PANEL_RF_ATTENUATORS_BASE.

Definition at line 149 of file panel_rf_attenuators.cpp.

150{
154}
virtual bool Calculate()
Calculates the values of components in attenuator.

References ATTENUATOR::Calculate(), m_CurrAttenuator, TransfAttenuatorResultsToPanel(), and TransfPanelDataToAttenuator().

◆ SaveSettings()

void PANEL_RF_ATTENUATORS::SaveSettings ( PCB_CALCULATOR_SETTINGS aCfg)
overridevirtual

Save the settings from the panel.

Parameters
aCfgis the settings structure to save to

Implements CALCULATOR_PANEL.

Definition at line 110 of file panel_rf_attenuators.cpp.

111{
112 wxASSERT( aCfg );
113
114 aCfg->m_Attenuators.type = m_AttenuatorsSelection->GetSelection();
115
116 for( ATTENUATOR* attenuator : m_AttenuatorList )
117 attenuator->WriteConfig();
118}

References m_AttenuatorList, PCB_CALCULATOR_SETTINGS::m_Attenuators, PANEL_RF_ATTENUATORS_BASE::m_AttenuatorsSelection, and PCB_CALCULATOR_SETTINGS::ATTENUATORS::type.

◆ SetAttenuator()

void PANEL_RF_ATTENUATORS::SetAttenuator ( unsigned  aIdx)

Definition at line 129 of file panel_rf_attenuators.cpp.

130{
131 if( aIdx >=m_AttenuatorList.size() )
132 aIdx = m_AttenuatorList.size() - 1;
133
136 m_Attenuator_Messages->SetPage( wxEmptyString );
137 m_Att_R1_Value->SetValue( wxEmptyString );
138 m_Att_R2_Value->SetValue( wxEmptyString );
139 m_Att_R3_Value->SetValue( wxEmptyString );
140
141 // Disable R3 for bridget T attenuator only
142 bool enable = aIdx != 2;
143 m_attenuatorR3Label->Enable( enable );
144 m_Att_R3_Value->Enable( enable );
145 m_attR3Unit->Enable( enable );
146}
bool SetPage(const wxString &aSource) override
Definition: html_window.cpp:38

References PANEL_RF_ATTENUATORS_BASE::m_Att_R1_Value, PANEL_RF_ATTENUATORS_BASE::m_Att_R2_Value, PANEL_RF_ATTENUATORS_BASE::m_Att_R3_Value, PANEL_RF_ATTENUATORS_BASE::m_Attenuator_Messages, m_AttenuatorList, PANEL_RF_ATTENUATORS_BASE::m_attenuatorR3Label, PANEL_RF_ATTENUATORS_BASE::m_attR3Unit, m_CurrAttenuator, HTML_WINDOW::SetPage(), and TransfAttenuatorDataToPanel().

Referenced by LoadSettings(), OnAttenuatorSelection(), and PANEL_RF_ATTENUATORS().

◆ ThemeChanged()

void PANEL_RF_ATTENUATORS::ThemeChanged ( )
overridevirtual

◆ TransfAttenuatorDataToPanel()

void PANEL_RF_ATTENUATORS::TransfAttenuatorDataToPanel ( )

Definition at line 170 of file panel_rf_attenuators.cpp.

171{
173
174 wxString msg;
175
176 msg.Printf( wxT( "%g" ), m_CurrAttenuator->m_Attenuation );
177 m_AttValueCtrl->SetValue( msg );
179
181
183 msg.Printf( wxT( "%g" ), m_CurrAttenuator->m_Zin );
184 else
185 msg.Clear();
186
187 m_ZinValueCtrl->SetValue( msg );
188
189 msg.Printf( wxT( "%g" ), m_CurrAttenuator->m_Zout );
190 m_ZoutValueCtrl->SetValue( msg );
191
193 {
194 if( m_CurrAttenuator->m_FormulaName->StartsWith( "<!" ) )
195 {
197 }
198 else
199 {
200 wxString html_txt;
201 ConvertMarkdown2Html( wxGetTranslation( *m_CurrAttenuator->m_FormulaName ), html_txt );
202 m_panelAttFormula->SetPage( html_txt );
203 }
204 }
205 else
206 {
207 m_panelAttFormula->SetPage( wxEmptyString );
208 }
209}
wxString * m_FormulaName
bool m_Attenuation_Enable
double m_Attenuation
void ConvertMarkdown2Html(const wxString &aMarkdownInput, wxString &aHtmlOutput)

References ConvertMarkdown2Html(), KiBitmap(), ATTENUATOR::m_Attenuation, ATTENUATOR::m_Attenuation_Enable, PANEL_RF_ATTENUATORS_BASE::m_attenuatorBitmap, PANEL_RF_ATTENUATORS_BASE::m_AttValueCtrl, m_CurrAttenuator, ATTENUATOR::m_FormulaName, PANEL_RF_ATTENUATORS_BASE::m_panelAttFormula, ATTENUATOR::m_SchBitmapName, ATTENUATOR::m_Zin, ATTENUATOR::m_Zin_Enable, PANEL_RF_ATTENUATORS_BASE::m_ZinValueCtrl, ATTENUATOR::m_Zout, PANEL_RF_ATTENUATORS_BASE::m_ZoutValueCtrl, and HTML_WINDOW::SetPage().

Referenced by SetAttenuator().

◆ TransfAttenuatorResultsToPanel()

void PANEL_RF_ATTENUATORS::TransfAttenuatorResultsToPanel ( )

Definition at line 212 of file panel_rf_attenuators.cpp.

213{
214 wxString msg;
215
216 m_Attenuator_Messages->SetPage( wxEmptyString );
217
219 {
220 msg.Printf( _( "Attenuation more than %f dB" ),
222 m_Attenuator_Messages->AppendToPage( wxT( "<br><b>Error!</b></br><br><em>" ) );
224 m_Attenuator_Messages->AppendToPage( wxT( "</em></br>" ) );
225
226 // Display -- as resistor values:
227 msg = wxT( "--" );
228 m_Att_R1_Value->SetValue( msg );
229 m_Att_R2_Value->SetValue( msg );
230
232 m_Att_R3_Value->SetValue( msg );
233
234 return;
235 }
236
237 msg.Printf( wxT( "%g" ), m_CurrAttenuator->m_R1 );
238 m_Att_R1_Value->SetValue( msg );
239 msg.Printf( wxT( "%g" ), m_CurrAttenuator->m_R2 );
240 m_Att_R2_Value->SetValue( msg );
241
243 {
244 m_Att_R3_Value->SetValue( wxEmptyString );
245 }
246 else
247 {
248 msg.Printf( wxT( "%g" ), m_CurrAttenuator->m_R3 );
249 m_Att_R3_Value->SetValue( msg );
250 }
251}
bool AppendToPage(const wxString &aSource)
Definition: html_window.cpp:57
#define _(s)

References _, HTML_WINDOW::AppendToPage(), PANEL_RF_ATTENUATORS_BASE::m_Att_R1_Value, PANEL_RF_ATTENUATORS_BASE::m_Att_R2_Value, PANEL_RF_ATTENUATORS_BASE::m_Att_R3_Value, PANEL_RF_ATTENUATORS_BASE::m_Attenuator_Messages, m_CurrAttenuator, ATTENUATOR::m_Error, ATTENUATOR::m_MinimumATT, ATTENUATOR::m_R1, ATTENUATOR::m_R2, ATTENUATOR::m_R3, ATTENUATOR::m_ResultCount, and HTML_WINDOW::SetPage().

Referenced by OnCalculateAttenuator().

◆ TransfPanelDataToAttenuator()

void PANEL_RF_ATTENUATORS::TransfPanelDataToAttenuator ( )

◆ UpdateUI()

void PANEL_RF_ATTENUATORS::UpdateUI ( )

Member Data Documentation

◆ m_Att_R1_Value

wxTextCtrl* PANEL_RF_ATTENUATORS_BASE::m_Att_R1_Value
protectedinherited

◆ m_Att_R2_Value

wxTextCtrl* PANEL_RF_ATTENUATORS_BASE::m_Att_R2_Value
protectedinherited

◆ m_Att_R3_Value

wxTextCtrl* PANEL_RF_ATTENUATORS_BASE::m_Att_R3_Value
protectedinherited

◆ m_attenuationLabel

wxStaticText* PANEL_RF_ATTENUATORS_BASE::m_attenuationLabel
protectedinherited

◆ m_attenuationZinLabel

wxStaticText* PANEL_RF_ATTENUATORS_BASE::m_attenuationZinLabel
protectedinherited

◆ m_Attenuator_Messages

HTML_WINDOW* PANEL_RF_ATTENUATORS_BASE::m_Attenuator_Messages
protectedinherited

◆ m_attenuatorBitmap

wxStaticBitmap* PANEL_RF_ATTENUATORS_BASE::m_attenuatorBitmap
protectedinherited

◆ m_AttenuatorList

std::vector<ATTENUATOR*> PANEL_RF_ATTENUATORS::m_AttenuatorList

◆ m_attenuatorR1Label

wxStaticText* PANEL_RF_ATTENUATORS_BASE::m_attenuatorR1Label
protectedinherited

◆ m_attenuatorR2Label

wxStaticText* PANEL_RF_ATTENUATORS_BASE::m_attenuatorR2Label
protectedinherited

◆ m_attenuatorR3Label

wxStaticText* PANEL_RF_ATTENUATORS_BASE::m_attenuatorR3Label
protectedinherited

◆ m_AttenuatorsSelection

wxRadioBox* PANEL_RF_ATTENUATORS_BASE::m_AttenuatorsSelection
protectedinherited

◆ m_attR1Unit

wxStaticText* PANEL_RF_ATTENUATORS_BASE::m_attR1Unit
protectedinherited

◆ m_attR2Unit

wxStaticText* PANEL_RF_ATTENUATORS_BASE::m_attR2Unit
protectedinherited

◆ m_attR3Unit

wxStaticText* PANEL_RF_ATTENUATORS_BASE::m_attR3Unit
protectedinherited

◆ m_attUnit

wxStaticText* PANEL_RF_ATTENUATORS_BASE::m_attUnit
protectedinherited

◆ m_AttValueCtrl

wxTextCtrl* PANEL_RF_ATTENUATORS_BASE::m_AttValueCtrl
protectedinherited

◆ m_attZinUnit

wxStaticText* PANEL_RF_ATTENUATORS_BASE::m_attZinUnit
protectedinherited

◆ m_attZoutUnit

wxStaticText* PANEL_RF_ATTENUATORS_BASE::m_attZoutUnit
protectedinherited

◆ m_bpButtonCalcAtt

◆ m_buttonAlcAtt

wxButton* PANEL_RF_ATTENUATORS_BASE::m_buttonAlcAtt
protectedinherited

◆ m_CurrAttenuator

◆ m_panelAttFormula

HTML_WINDOW* PANEL_RF_ATTENUATORS_BASE::m_panelAttFormula
protectedinherited

◆ m_staticTextAttMsg

wxStaticText* PANEL_RF_ATTENUATORS_BASE::m_staticTextAttMsg
protectedinherited

◆ m_ZinValueCtrl

wxTextCtrl* PANEL_RF_ATTENUATORS_BASE::m_ZinValueCtrl
protectedinherited

◆ m_ZoutLabel

wxStaticText* PANEL_RF_ATTENUATORS_BASE::m_ZoutLabel
protectedinherited

◆ m_ZoutValueCtrl

wxTextCtrl* PANEL_RF_ATTENUATORS_BASE::m_ZoutValueCtrl
protectedinherited

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