KiCad PCB EDA Suite
DIALOG_SIM_SETTINGS Class Reference

#include <dialog_sim_settings.h>

Inheritance diagram for DIALOG_SIM_SETTINGS:
DIALOG_SIM_SETTINGS_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 DIALOG_SIM_SETTINGS (wxWindow *aParent, std::shared_ptr< SPICE_SIMULATOR_SETTINGS > &aSettings)
 
const wxString & GetSimCommand () const
 
bool SetSimCommand (const wxString &aCommand)
 
int GetNetlistOptions () const
 
void SetNetlistExporter (NETLIST_EXPORTER_PSPICE_SIM *aExporter)
 
bool TransferDataFromWindow () override
 
bool TransferDataToWindow () override
 
virtual bool Validate () override
 
int ShowModal () override
 
void SetInitialFocus (wxWindow *aWindow)
 Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal () const
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
void SetPosition (const wxPoint &aNewPosition)
 Force the position of the dialog to a new position. More...
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

static bool IsCtrl (int aChar, const wxKeyEvent &e)
 
static bool IsShiftCtrl (int aChar, const wxKeyEvent &e)
 

Protected Member Functions

void finishDialogSettings ()
 In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...
 
void setSizeInDU (int x, int y)
 Set the dialog to the given dimensions in "dialog units". More...
 
int horizPixelsFromDU (int x) const
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int vertPixelsFromDU (int y) const
 Convert an integer number of dialog units to pixels, vertically. More...
 
void resetSize ()
 Clear the existing dialog size and position. More...
 
virtual void OnCharHook (wxKeyEvent &aEvt)
 

Protected Attributes

wxNotebook * m_simPages
 
wxPanel * m_pgAC
 
wxRadioBox * m_acScale
 
wxStaticText * m_staticText1
 
wxTextCtrl * m_acPointsNumber
 
wxStaticText * m_staticText2
 
wxTextCtrl * m_acFreqStart
 
wxStaticText * m_staticText19
 
wxStaticText * m_staticText3
 
wxTextCtrl * m_acFreqStop
 
wxStaticText * m_staticText110
 
wxPanel * m_pgDC
 
wxCheckBox * m_dcEnable2
 
wxRadioBox * m_dcSourceType1
 
wxRadioBox * m_dcSourceType2
 
wxStaticText * m_staticText4
 
wxChoice * m_dcSource1
 
wxChoice * m_dcSource2
 
wxStaticText * m_staticText5
 
wxTextCtrl * m_dcStart1
 
wxStaticText * m_src1DCStartValUnit
 
wxTextCtrl * m_dcStart2
 
wxStaticText * m_src2DCStartValUnit
 
wxStaticText * m_staticText6
 
wxTextCtrl * m_dcStop1
 
wxStaticText * m_src1DCEndValUnit
 
wxTextCtrl * m_dcStop2
 
wxStaticText * m_src2DCEndValUnit
 
wxStaticText * m_staticText7
 
wxTextCtrl * m_dcIncr1
 
wxStaticText * m_src1DCStepUnit
 
wxTextCtrl * m_dcIncr2
 
wxStaticText * m_src2DCStepUnit
 
wxButton * m_swapDCSources
 
wxPanel * m_pgDistortion
 
wxPanel * m_pgNoise
 
wxStaticText * m_staticText14
 
wxComboBox * m_noiseMeas
 
wxStaticText * m_staticText15
 
wxComboBox * m_noiseRef
 
wxStaticText * m_staticText23
 
wxStaticText * m_staticText16
 
wxComboBox * m_noiseSrc
 
wxRadioBox * m_noiseScale
 
wxStaticText * m_staticText11
 
wxTextCtrl * m_noisePointsNumber
 
wxStaticText * m_staticText21
 
wxTextCtrl * m_noiseFreqStart
 
wxStaticText * m_staticText31
 
wxTextCtrl * m_noiseFreqStop
 
wxPanel * m_pgOP
 
wxStaticText * m_staticText13
 
wxPanel * m_pgPoleZero
 
wxPanel * m_pgSensitivity
 
wxPanel * m_pgTransferFunction
 
wxPanel * m_pgTransient
 
wxStaticText * m_staticText151
 
wxTextCtrl * m_transStep
 
wxStaticText * m_staticText1511
 
wxStaticText * m_staticText161
 
wxTextCtrl * m_transFinal
 
wxStaticText * m_staticText1512
 
wxStaticText * m_staticText17
 
wxTextCtrl * m_transInitial
 
wxStaticText * m_staticText1513
 
wxStaticText * m_staticText24
 
wxPanel * m_pgCustom
 
wxStaticText * m_staticText18
 
wxTextCtrl * m_customTxt
 
wxButton * m_loadDirectives
 
wxCheckBox * m_fixPassiveVals
 
wxCheckBox * m_fixIncludePaths
 
wxBoxSizer * m_compatibilityMode
 
wxChoice * m_compatibilityModeChoice
 
wxStaticLine * m_staticline1
 
wxStdDialogButtonSizer * m_sdbSizer
 
wxButton * m_sdbSizerOK
 
wxButton * m_sdbSizerCancel
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_useCalculatedSize
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
EDA_BASE_FRAMEm_parentFrame
 
std::vector< wxWindow * > m_tabOrder
 

Private Types

enum  SCALE_TYPE { DECADE, OCTAVE, LINEAR }
 

Private Member Functions

void refreshUIControls ()
 
wxString evaluateDCControls (wxChoice *aDcSource, wxTextCtrl *aDcStart, wxTextCtrl *aDcStop, wxTextCtrl *aDcIncr)
 Read values from one DC sweep source to form a part of simulation command. More...
 
void updateDCSources (wxChar aType, wxChoice *aSource)
 Update DC sweep source with components from schematic. More...
 
void updateDCUnits (wxChar aType, wxChoice *aSource, wxStaticText *aStartValUnit, wxStaticText *aEndValUnit, wxStaticText *aStepUnit)
 Update units on labels depending on selected source. More...
 
virtual void onInitDlg (wxInitDialogEvent &event) override
 
bool parseCommand (const wxString &aCommand)
 Parse a Spice directive. More...
 
void onLoadDirectives (wxCommandEvent &event) override
 
void onDCEnableSecondSource (wxCommandEvent &event) override
 
void onSwapDCSources (wxCommandEvent &event) override
 
void onDCSource1Selected (wxCommandEvent &event) override
 
void onDCSource2Selected (wxCommandEvent &event) override
 
void loadDirectives ()
 
void updateNetlistOpts ()
 

Static Private Member Functions

static wxString scaleToString (int aOption)
 

Private Attributes

wxString m_simCommand
 
int m_netlistOpts
 
NETLIST_EXPORTER_PSPICE_SIMm_exporter
 
std::shared_ptr< SPICE_SIMULATOR_SETTINGSm_settings
 
SPICE_VALIDATOR m_spiceValidator
 
SPICE_VALIDATOR m_spiceEmptyValidator
 
wxIntegerValidator< int > m_posIntValidator
 

Detailed Description

Definition at line 39 of file dialog_sim_settings.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

◆ SCALE_TYPE

Enumerator
DECADE 
OCTAVE 
LINEAR 

Definition at line 84 of file dialog_sim_settings.h.

Constructor & Destructor Documentation

◆ DIALOG_SIM_SETTINGS()

DIALOG_SIM_SETTINGS::DIALOG_SIM_SETTINGS ( wxWindow *  aParent,
std::shared_ptr< SPICE_SIMULATOR_SETTINGS > &  aSettings 
)

Definition at line 59 of file dialog_sim_settings.cpp.

60  :
61  DIALOG_SIM_SETTINGS_BASE( aParent ),
62  m_exporter( nullptr ),
63  m_settings( aSettings ),
64  m_spiceEmptyValidator( true )
65 {
66  m_posIntValidator.SetMin( 1 );
67 
68  m_acPointsNumber->SetValidator( m_posIntValidator );
69  m_acFreqStart->SetValidator( m_spiceValidator );
70  m_acFreqStop->SetValidator( m_spiceValidator );
71 
72  m_dcStart1->SetValidator( m_spiceValidator );
73  m_dcStop1->SetValidator( m_spiceValidator );
74  m_dcIncr1->SetValidator( m_spiceValidator );
75 
76  m_dcStart2->SetValidator( m_spiceValidator );
77  m_dcStop2->SetValidator( m_spiceValidator );
78  m_dcIncr2->SetValidator( m_spiceValidator );
79 
80  m_noisePointsNumber->SetValidator( m_posIntValidator );
81  m_noiseFreqStart->SetValidator( m_spiceValidator );
82  m_noiseFreqStop->SetValidator( m_spiceValidator );
83 
84  m_transStep->SetValidator( m_spiceValidator );
85  m_transFinal->SetValidator( m_spiceValidator );
86  m_transInitial->SetValidator( m_spiceEmptyValidator );
87 
89 
90  // Hide pages that aren't fully implemented yet
91  // wxPanel::Hide() isn't enough on some platforms
92  m_simPages->RemovePage( m_simPages->FindPage( m_pgDistortion ) );
93  m_simPages->RemovePage( m_simPages->FindPage( m_pgNoise ) );
94  m_simPages->RemovePage( m_simPages->FindPage( m_pgPoleZero ) );
95  m_simPages->RemovePage( m_simPages->FindPage( m_pgSensitivity ) );
96  m_simPages->RemovePage( m_simPages->FindPage( m_pgTransferFunction ) );
97 
98  if( !dynamic_cast<NGSPICE_SIMULATOR_SETTINGS*>( aSettings.get() ) )
99  m_compatibilityMode->Show( false );
100 
101  m_sdbSizerOK->SetDefault();
103 
104 }
std::shared_ptr< SPICE_SIMULATOR_SETTINGS > m_settings
SPICE_VALIDATOR m_spiceEmptyValidator
SPICE_VALIDATOR m_spiceValidator
DIALOG_SIM_SETTINGS_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Simulation settings"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
NETLIST_EXPORTER_PSPICE_SIM * m_exporter
wxIntegerValidator< int > m_posIntValidator

References DIALOG_SIM_SETTINGS_BASE::m_acFreqStart, DIALOG_SIM_SETTINGS_BASE::m_acFreqStop, DIALOG_SIM_SETTINGS_BASE::m_acPointsNumber, DIALOG_SIM_SETTINGS_BASE::m_compatibilityMode, DIALOG_SIM_SETTINGS_BASE::m_dcIncr1, DIALOG_SIM_SETTINGS_BASE::m_dcIncr2, DIALOG_SIM_SETTINGS_BASE::m_dcStart1, DIALOG_SIM_SETTINGS_BASE::m_dcStart2, DIALOG_SIM_SETTINGS_BASE::m_dcStop1, DIALOG_SIM_SETTINGS_BASE::m_dcStop2, DIALOG_SIM_SETTINGS_BASE::m_noiseFreqStart, DIALOG_SIM_SETTINGS_BASE::m_noiseFreqStop, DIALOG_SIM_SETTINGS_BASE::m_noisePointsNumber, DIALOG_SIM_SETTINGS_BASE::m_pgDistortion, DIALOG_SIM_SETTINGS_BASE::m_pgNoise, DIALOG_SIM_SETTINGS_BASE::m_pgPoleZero, DIALOG_SIM_SETTINGS_BASE::m_pgSensitivity, DIALOG_SIM_SETTINGS_BASE::m_pgTransferFunction, m_posIntValidator, DIALOG_SIM_SETTINGS_BASE::m_sdbSizerOK, DIALOG_SIM_SETTINGS_BASE::m_simPages, m_spiceEmptyValidator, m_spiceValidator, DIALOG_SIM_SETTINGS_BASE::m_transFinal, DIALOG_SIM_SETTINGS_BASE::m_transInitial, DIALOG_SIM_SETTINGS_BASE::m_transStep, refreshUIControls(), and updateNetlistOpts().

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 307 of file dialog_shim.cpp.

308 {
309  // so we can do logging of this state change:
310  return wxDialog::Enable( enable );
311 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 445 of file dialog_shim.cpp.

446 {
447  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
448  // handle validation in the same way as other dialogs.
449  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
450  return;
451 
452  SetReturnCode( retCode );
453 
454  if( !IsQuasiModal() )
455  {
456  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
457  "wasn't called" );
458  return;
459  }
460 
461  if( m_qmodal_loop )
462  {
463  if( m_qmodal_loop->IsRunning() )
464  m_qmodal_loop->Exit( 0 );
465  else
466  m_qmodal_loop->ScheduleExit( 0 );
467 
469  }
470 
473 
474  Show( false );
475 }
bool IsQuasiModal() const
Definition: dialog_shim.h:107
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:212
#define NULL
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:215

References DIALOG_SHIM::IsQuasiModal(), DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, NULL, and DIALOG_SHIM::Show().

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_SYMBOL::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_SYMBOL::OnUseBrowser(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ evaluateDCControls()

wxString DIALOG_SIM_SETTINGS::evaluateDCControls ( wxChoice *  aDcSource,
wxTextCtrl *  aDcStart,
wxTextCtrl *  aDcStop,
wxTextCtrl *  aDcIncr 
)
private

Read values from one DC sweep source to form a part of simulation command.

Returns
string of four SPICE values if values are correct, empty string upon error.
Todo:
for some reason it does not trigger the assigned SPICE_VALIDATOR,

Definition at line 106 of file dialog_sim_settings.cpp.

108 {
109  wxString dcSource = aDcSource->GetString( aDcSource->GetSelection() );
110  wxWindow* ctrlWithError = nullptr;
111 
112  if( dcSource.IsEmpty() )
113  {
114  DisplayError( this, _( "You need to select DC source" ) );
115  ctrlWithError = aDcSource;
116  }
118  // hence try..catch below
119  else if( !aDcStart->Validate() )
120  ctrlWithError = aDcStart;
121  else if( !aDcStop->Validate() )
122  ctrlWithError = aDcStop;
123  else if( !aDcIncr->Validate() )
124  ctrlWithError = aDcIncr;
125 
126  if( ctrlWithError )
127  {
128  ctrlWithError->SetFocus();
129  return wxEmptyString;
130  }
131 
132  try
133  {
134  // pick device name from exporter when something different than temperature is selected
135  if( dcSource.Cmp( "TEMP" ) )
136  dcSource = m_exporter->GetSpiceDevice( dcSource );
137 
138  return wxString::Format( "%s %s %s %s", dcSource,
139  SPICE_VALUE( aDcStart->GetValue() ).ToSpiceString(),
140  SPICE_VALUE( aDcStop->GetValue() ).ToSpiceString(),
141  SPICE_VALUE( aDcIncr->GetValue() ).ToSpiceString() );
142  }
143  catch( std::exception& e )
144  {
145  DisplayError( this, e.what() );
146  return wxEmptyString;
147  }
148  catch( const KI_PARAM_ERROR& e )
149  {
150  DisplayError( this, e.What() );
151  return wxEmptyString;
152  }
153  catch( ... )
154  {
155  return wxEmptyString;
156  }
157 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:252
< Helper class to handle Spice way of expressing values (e.g. 10.5 Meg) Helper class to recognize Spi...
Definition: spice_value.h:34
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
const wxString What() const
Definition: ki_exception.h:57
NETLIST_EXPORTER_PSPICE_SIM * m_exporter
#define _(s)
Definition: 3d_actions.cpp:33
wxString GetSpiceDevice(const wxString &aComponent) const
Return name of Spice device corresponding to a schematic component.
Hold a translatable error message and may be used when throwing exceptions containing a translated er...
Definition: ki_exception.h:44

References _, DisplayError(), Format(), NETLIST_EXPORTER_PSPICE::GetSpiceDevice(), m_exporter, and KI_PARAM_ERROR::What().

Referenced by TransferDataFromWindow().

◆ finishDialogSettings()

void DIALOG_SHIM::finishDialogSettings ( )
protectedinherited

In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls.

finishDialogSettings must be called from derived classes after all widgets have been initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at the end of TransferDataToWindow, or better yet, at end of a wxInitDialogEvent handler.

Definition at line 148 of file dialog_shim.cpp.

149 {
150  // must be called from the constructor of derived classes,
151  // when all widgets are initialized, and therefore their size fixed
152 
153  // SetSizeHints fixes the minimal size of sizers in the dialog
154  // (SetSizeHints calls Fit(), so no need to call it)
155  GetSizer()->SetSizeHints( this );
156 }

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetNetlistOptions()

int DIALOG_SIM_SETTINGS::GetNetlistOptions ( ) const
inline

Definition at line 59 of file dialog_sim_settings.h.

60  {
61  return m_netlistOpts;
62  }

References m_netlistOpts.

Referenced by SIM_PLOT_FRAME::StartSimulation().

◆ GetSimCommand()

const wxString& DIALOG_SIM_SETTINGS::GetSimCommand ( ) const
inline

Definition at line 44 of file dialog_sim_settings.h.

45  {
46  return m_simCommand;
47  }

References m_simCommand.

Referenced by SIM_PLOT_FRAME::onSettings().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:79

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int  x) const
protectedinherited

Convert an integer number of dialog units to pixels, horizontally.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 166 of file dialog_shim.cpp.

167 {
168  wxSize sz( x, 0 );
169  return ConvertDialogToPixels( sz ).x;
170 }

Referenced by DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), and DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

◆ IsCtrl()

static bool DIALOG_SHIM::IsCtrl ( int  aChar,
const wxKeyEvent &  e 
)
inlinestaticinherited

Definition at line 125 of file dialog_shim.h.

126  {
127  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
128  !e.ShiftDown() && !e.MetaDown();
129  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

static bool DIALOG_SHIM::IsShiftCtrl ( int  aChar,
const wxKeyEvent &  e 
)
inlinestaticinherited

Definition at line 131 of file dialog_shim.h.

132  {
133  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
134  e.ShiftDown() && !e.MetaDown();
135  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Return a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:78

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesListBox(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurPart(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ loadDirectives()

void DIALOG_SIM_SETTINGS::loadDirectives ( )
private

Definition at line 591 of file dialog_sim_settings.cpp.

592 {
593  if( m_exporter )
594  m_customTxt->SetValue( m_exporter->GetSheetSimCommand() );
595 }
wxString GetSheetSimCommand()
Return simulation command directives placed in schematic sheets (if any).
NETLIST_EXPORTER_PSPICE_SIM * m_exporter

References NETLIST_EXPORTER_PSPICE_SIM::GetSheetSimCommand(), DIALOG_SIM_SETTINGS_BASE::m_customTxt, and m_exporter.

Referenced by onLoadDirectives(), and TransferDataToWindow().

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt)
protectedvirtualinherited

Reimplemented in DIALOG_CHOOSE_SYMBOL, HK_PROMPT_DIALOG, DIALOG_TEXT_PROPERTIES, and HTML_MESSAGE_BOX.

Definition at line 536 of file dialog_shim.cpp.

537 {
538  if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
539  {
540  if( m_parentFrame )
541  {
543  return;
544  }
545  }
546  // shift-return (Mac default) or Ctrl-Return (GTK) for OK
547  else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
548  {
549  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
550  return;
551  }
552  else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
553  {
554  wxWindow* currentWindow = wxWindow::FindFocus();
555  int currentIdx = -1;
556  int delta = aEvt.ShiftDown() ? -1 : 1;
557 
558  auto advance = [&]( int& idx )
559  {
560  // Wrap-around modulus
561  int size = m_tabOrder.size();
562  idx = ( ( idx + delta ) % size + size ) % size;
563  };
564 
565  for( size_t i = 0; i < m_tabOrder.size(); ++i )
566  {
567  if( m_tabOrder[i] == currentWindow )
568  {
569  currentIdx = (int) i;
570  break;
571  }
572  }
573 
574  if( currentIdx >= 0 )
575  {
576  advance( currentIdx );
577 
578  //todo: We don't currently have non-textentry dialog boxes but this will break if
579  // we add them.
580 #ifdef __APPLE__
581  while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
582  advance( currentIdx );
583 #endif
584 
585  m_tabOrder[ currentIdx ]->SetFocus();
586  return;
587  }
588  }
589 
590  aEvt.Skip();
591 }
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:219
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:217
virtual void ToggleUserUnits()

References DIALOG_SHIM::m_parentFrame, DIALOG_SHIM::m_tabOrder, and EDA_BASE_FRAME::ToggleUserUnits().

◆ onDCEnableSecondSource()

void DIALOG_SIM_SETTINGS::onDCEnableSecondSource ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SIM_SETTINGS_BASE.

Definition at line 555 of file dialog_sim_settings.cpp.

556 {
557  bool is2ndSrcEnabled = m_dcEnable2->IsChecked();
558  wxChar type = getStringSelection( m_dcSourceType2 ).Upper().GetChar( 0 );
559 
560  m_dcSourceType2->Enable( is2ndSrcEnabled );
561  m_dcSource2->Enable( is2ndSrcEnabled && type != 'T' );
562  m_dcStart2->Enable( is2ndSrcEnabled );
563  m_dcStop2->Enable( is2ndSrcEnabled );
564  m_dcIncr2->Enable( is2ndSrcEnabled );
565 }
static wxString getStringSelection(const wxRadioBox *aCtrl)

References getStringSelection(), DIALOG_SIM_SETTINGS_BASE::m_dcEnable2, DIALOG_SIM_SETTINGS_BASE::m_dcIncr2, DIALOG_SIM_SETTINGS_BASE::m_dcSource2, DIALOG_SIM_SETTINGS_BASE::m_dcSourceType2, DIALOG_SIM_SETTINGS_BASE::m_dcStart2, and DIALOG_SIM_SETTINGS_BASE::m_dcStop2.

◆ onDCSource1Selected()

void DIALOG_SIM_SETTINGS::onDCSource1Selected ( wxCommandEvent &  event)
inlineoverrideprivatevirtual

Reimplemented from DIALOG_SIM_SETTINGS_BASE.

Definition at line 142 of file dialog_sim_settings.h.

143  {
144  wxChar type =
145  m_dcSourceType1->GetString( m_dcSourceType1->GetSelection() ).Upper().GetChar( 0 );
146  updateDCSources( type, m_dcSource1 );
149  }
void updateDCSources(wxChar aType, wxChoice *aSource)
Update DC sweep source with components from schematic.
void updateDCUnits(wxChar aType, wxChoice *aSource, wxStaticText *aStartValUnit, wxStaticText *aEndValUnit, wxStaticText *aStepUnit)
Update units on labels depending on selected source.

References DIALOG_SIM_SETTINGS_BASE::m_dcSource1, DIALOG_SIM_SETTINGS_BASE::m_dcSourceType1, DIALOG_SIM_SETTINGS_BASE::m_src1DCEndValUnit, DIALOG_SIM_SETTINGS_BASE::m_src1DCStartValUnit, DIALOG_SIM_SETTINGS_BASE::m_src1DCStepUnit, updateDCSources(), and updateDCUnits().

◆ onDCSource2Selected()

void DIALOG_SIM_SETTINGS::onDCSource2Selected ( wxCommandEvent &  event)
inlineoverrideprivatevirtual

Reimplemented from DIALOG_SIM_SETTINGS_BASE.

Definition at line 151 of file dialog_sim_settings.h.

152  {
153  wxChar type =
154  m_dcSourceType2->GetString( m_dcSourceType2->GetSelection() ).Upper().GetChar( 0 );
155  updateDCSources( type, m_dcSource2 );
158  }
void updateDCSources(wxChar aType, wxChoice *aSource)
Update DC sweep source with components from schematic.
void updateDCUnits(wxChar aType, wxChoice *aSource, wxStaticText *aStartValUnit, wxStaticText *aEndValUnit, wxStaticText *aStepUnit)
Update units on labels depending on selected source.

References DIALOG_SIM_SETTINGS_BASE::m_dcSource2, DIALOG_SIM_SETTINGS_BASE::m_dcSourceType2, DIALOG_SIM_SETTINGS_BASE::m_src2DCEndValUnit, DIALOG_SIM_SETTINGS_BASE::m_src2DCStartValUnit, DIALOG_SIM_SETTINGS_BASE::m_src2DCStepUnit, updateDCSources(), and updateDCUnits().

◆ onInitDlg()

virtual void DIALOG_SIM_SETTINGS::onInitDlg ( wxInitDialogEvent &  event)
inlineoverrideprivatevirtual

Reimplemented from DIALOG_SIM_SETTINGS_BASE.

Definition at line 118 of file dialog_sim_settings.h.

119  {
120  // Call the default wxDialog handler of a wxInitDialogEvent
122 
123  // Now all widgets have the size fixed, call FinishDialogSettings
125  }
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
bool TransferDataToWindow() override

References DIALOG_SHIM::finishDialogSettings(), and TransferDataToWindow().

◆ onLoadDirectives()

void DIALOG_SIM_SETTINGS::onLoadDirectives ( wxCommandEvent &  event)
inlineoverrideprivatevirtual

Reimplemented from DIALOG_SIM_SETTINGS_BASE.

Definition at line 135 of file dialog_sim_settings.h.

136  {
137  loadDirectives();
138  }

References loadDirectives().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 352 of file dialog_shim.cpp.

353 {
354  if( m_firstPaintEvent )
355  {
357 
358  selectAllInTextCtrls( GetChildren() );
359 
362  else
363  KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
364 
365  m_firstPaintEvent = false;
366  }
367 
368  event.Skip();
369 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:210
bool m_firstPaintEvent
Definition: dialog_shim.h:209
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:68
static void selectAllInTextCtrls(wxWindowList &children)

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), KIPLATFORM::UI::ForceFocus(), DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ onSwapDCSources()

void DIALOG_SIM_SETTINGS::onSwapDCSources ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SIM_SETTINGS_BASE.

Definition at line 522 of file dialog_sim_settings.cpp.

523 {
524  std::vector<std::pair<wxTextEntry*, wxTextEntry*>> textCtrl = { { m_dcStart1, m_dcStart2 },
525  { m_dcStop1, m_dcStop2 },
526  { m_dcIncr1, m_dcIncr2 } };
527 
528  for( auto& couple : textCtrl )
529  {
530  wxString tmp = couple.first->GetValue();
531  couple.first->SetValue( couple.second->GetValue() );
532  couple.second->SetValue( tmp );
533  }
534 
535  int src1 = m_dcSource1->GetSelection();
536  int src2 = m_dcSource2->GetSelection();
537 
538  int sel = m_dcSourceType1->GetSelection();
539  m_dcSourceType1->SetSelection( m_dcSourceType2->GetSelection() );
540  m_dcSourceType2->SetSelection( sel );
541 
542  wxChar type1 = getStringSelection( m_dcSourceType1 ).Upper().GetChar( 0 );
543  updateDCSources( type1, m_dcSource1 );
544  wxChar type2 = getStringSelection( m_dcSourceType2 ).Upper().GetChar( 0 );
545  updateDCSources( type2, m_dcSource2 );
546 
547  m_dcSource1->SetSelection( src2 );
548  m_dcSource2->SetSelection( src1 );
549 
552 }
void updateDCSources(wxChar aType, wxChoice *aSource)
Update DC sweep source with components from schematic.
static wxString getStringSelection(const wxRadioBox *aCtrl)
void updateDCUnits(wxChar aType, wxChoice *aSource, wxStaticText *aStartValUnit, wxStaticText *aEndValUnit, wxStaticText *aStepUnit)
Update units on labels depending on selected source.

References getStringSelection(), DIALOG_SIM_SETTINGS_BASE::m_dcIncr1, DIALOG_SIM_SETTINGS_BASE::m_dcIncr2, DIALOG_SIM_SETTINGS_BASE::m_dcSource1, DIALOG_SIM_SETTINGS_BASE::m_dcSource2, DIALOG_SIM_SETTINGS_BASE::m_dcSourceType1, DIALOG_SIM_SETTINGS_BASE::m_dcSourceType2, DIALOG_SIM_SETTINGS_BASE::m_dcStart1, DIALOG_SIM_SETTINGS_BASE::m_dcStart2, DIALOG_SIM_SETTINGS_BASE::m_dcStop1, DIALOG_SIM_SETTINGS_BASE::m_dcStop2, DIALOG_SIM_SETTINGS_BASE::m_src1DCEndValUnit, DIALOG_SIM_SETTINGS_BASE::m_src1DCStartValUnit, DIALOG_SIM_SETTINGS_BASE::m_src1DCStepUnit, DIALOG_SIM_SETTINGS_BASE::m_src2DCEndValUnit, DIALOG_SIM_SETTINGS_BASE::m_src2DCStartValUnit, DIALOG_SIM_SETTINGS_BASE::m_src2DCStepUnit, updateDCSources(), and updateDCUnits().

◆ parseCommand()

bool DIALOG_SIM_SETTINGS::parseCommand ( const wxString &  aCommand)
private

Parse a Spice directive.

Parameters
aCommandis the directive to be parsed (e.g. ".tran 10n 1000n").
Returns
true if the directive was parsed correctly.

Definition at line 420 of file dialog_sim_settings.cpp.

421 {
422  if( aCommand.IsEmpty() )
423  return false;
424 
425  wxStringTokenizer tokenizer( aCommand, " " );
426  wxString tkn = tokenizer.GetNextToken().Lower();
427 
428  try
429  {
430  if( tkn == ".ac" )
431  {
432  m_simPages->SetSelection( m_simPages->FindPage( m_pgAC ) );
433 
434  tkn = tokenizer.GetNextToken().Lower();
435 
436  if( tkn == "dec" )
437  m_acScale->SetSelection( 0 );
438  if( tkn == "oct" )
439  m_acScale->SetSelection( 1 );
440  if( tkn == "lin" )
441  m_acScale->SetSelection( 2 );
442  else
443  return false;
444 
445  // If the fields below are empty, it will be caught by the exception handler
446  m_acPointsNumber->SetValue( tokenizer.GetNextToken() );
447  m_acFreqStart->SetValue( SPICE_VALUE( tokenizer.GetNextToken() ).ToSpiceString() );
448  m_acFreqStop->SetValue( SPICE_VALUE( tokenizer.GetNextToken() ).ToSpiceString() );
449  }
450  else if( tkn == ".dc" )
451  {
452  SPICE_DC_PARAMS src1, src2;
453  src2.m_vincrement = SPICE_VALUE( -1 );
454 
455  if( !m_exporter->ParseDCCommand( aCommand, &src1, &src2 ) )
456  return false;
457 
458  m_simPages->SetSelection( m_simPages->FindPage( m_pgDC ) );
459 
460  if( src1.m_source.IsSameAs( wxT( "TEMP" ), false ) )
461  setStringSelection( m_dcSourceType1, wxT( "TEMP" ) );
462  else
463  setStringSelection( m_dcSourceType1, src1.m_source.GetChar( 0 ) );
464 
465  updateDCSources( src1.m_source.GetChar( 0 ), m_dcSource1 );
466  m_dcSource1->SetStringSelection( src1.m_source );
467  m_dcStart1->SetValue( src1.m_vstart.ToSpiceString() );
468  m_dcStop1->SetValue( src1.m_vend.ToSpiceString() );
469  m_dcIncr1->SetValue( src1.m_vincrement.ToSpiceString() );
470 
471  if( src2.m_vincrement.ToDouble() != -1 )
472  {
473  if( src2.m_source.IsSameAs( wxT( "TEMP" ), false ) )
474  setStringSelection( m_dcSourceType2, wxT( "TEMP" ) );
475  else
476  setStringSelection( m_dcSourceType2, src2.m_source.GetChar( 0 ) );
477 
478  updateDCSources( src2.m_source.GetChar( 0 ), m_dcSource2 );
479  m_dcSource2->SetStringSelection( src2.m_source );
480  m_dcStart2->SetValue( src2.m_vstart.ToSpiceString() );
481  m_dcStop2->SetValue( src2.m_vend.ToSpiceString() );
482  m_dcIncr2->SetValue( src2.m_vincrement.ToSpiceString() );
483 
484  m_dcEnable2->SetValue( true );
485  }
486 
488  }
489  else if( tkn == ".tran" )
490  {
491  m_simPages->SetSelection( m_simPages->FindPage( m_pgTransient ) );
492 
493  // If the fields below are empty, it will be caught by the exception handler
494  m_transStep->SetValue( SPICE_VALUE( tokenizer.GetNextToken() ).ToSpiceString() );
495  m_transFinal->SetValue( SPICE_VALUE( tokenizer.GetNextToken() ).ToSpiceString() );
496 
497  // Initial time is an optional field
498  tkn = tokenizer.GetNextToken();
499 
500  if( !tkn.IsEmpty() )
501  m_transInitial->SetValue( SPICE_VALUE( tkn ).ToSpiceString() );
502  }
503  else if( tkn == ".op" )
504  {
505  m_simPages->SetSelection( m_simPages->FindPage( m_pgOP ) );
506  }
507  else if( !empty( m_customTxt ) ) // Custom directives
508  {
509  m_simPages->SetSelection( m_simPages->FindPage( m_pgCustom ) );
510  }
511  }
512  catch( ... )
513  {
514  // Nothing really bad has happened
515  return false;
516  }
517 
518  return true;
519 }
wxString ToSpiceString() const
Return string value in Spice format (e.g.
double ToDouble() const
static void setStringSelection(wxRadioBox *aCtrl, const wxString &aStr)
void updateDCSources(wxChar aType, wxChoice *aSource)
Update DC sweep source with components from schematic.
< Helper class to handle Spice way of expressing values (e.g. 10.5 Meg) Helper class to recognize Spi...
Definition: spice_value.h:34
bool ParseDCCommand(const wxString &aCmd, SPICE_DC_PARAMS *aSource1, SPICE_DC_PARAMS *aSource2)
Parse a two-source .dc command directive into its components.
NETLIST_EXPORTER_PSPICE_SIM * m_exporter
static bool empty(const wxTextEntryBase *aCtrl)

References empty(), DIALOG_SIM_SETTINGS_BASE::m_acFreqStart, DIALOG_SIM_SETTINGS_BASE::m_acFreqStop, DIALOG_SIM_SETTINGS_BASE::m_acPointsNumber, DIALOG_SIM_SETTINGS_BASE::m_acScale, DIALOG_SIM_SETTINGS_BASE::m_customTxt, DIALOG_SIM_SETTINGS_BASE::m_dcEnable2, DIALOG_SIM_SETTINGS_BASE::m_dcIncr1, DIALOG_SIM_SETTINGS_BASE::m_dcIncr2, DIALOG_SIM_SETTINGS_BASE::m_dcSource1, DIALOG_SIM_SETTINGS_BASE::m_dcSource2, DIALOG_SIM_SETTINGS_BASE::m_dcSourceType1, DIALOG_SIM_SETTINGS_BASE::m_dcSourceType2, DIALOG_SIM_SETTINGS_BASE::m_dcStart1, DIALOG_SIM_SETTINGS_BASE::m_dcStart2, DIALOG_SIM_SETTINGS_BASE::m_dcStop1, DIALOG_SIM_SETTINGS_BASE::m_dcStop2, m_exporter, DIALOG_SIM_SETTINGS_BASE::m_pgAC, DIALOG_SIM_SETTINGS_BASE::m_pgCustom, DIALOG_SIM_SETTINGS_BASE::m_pgDC, DIALOG_SIM_SETTINGS_BASE::m_pgOP, DIALOG_SIM_SETTINGS_BASE::m_pgTransient, DIALOG_SIM_SETTINGS_BASE::m_simPages, SPICE_DC_PARAMS::m_source, DIALOG_SIM_SETTINGS_BASE::m_transFinal, DIALOG_SIM_SETTINGS_BASE::m_transInitial, DIALOG_SIM_SETTINGS_BASE::m_transStep, SPICE_DC_PARAMS::m_vend, SPICE_DC_PARAMS::m_vincrement, SPICE_DC_PARAMS::m_vstart, NETLIST_EXPORTER_PSPICE_SIM::ParseDCCommand(), refreshUIControls(), setStringSelection(), SPICE_VALUE::ToDouble(), SPICE_VALUE::ToSpiceString(), and updateDCSources().

Referenced by SetSimCommand(), and TransferDataToWindow().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:173

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), BOARD_EDITOR_CONTROL::ExportNetlist(), DIALOG_EXPORT_SVG::ExportSVGFile(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::Save_File(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::savePartAs(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SIM_PLOT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::~DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ refreshUIControls()

void DIALOG_SIM_SETTINGS::refreshUIControls ( )
inlineprivate

Definition at line 92 of file dialog_sim_settings.h.

93  {
94  wxQueueEvent( m_dcEnable2, new wxCommandEvent( wxEVT_CHECKBOX ) );
95  wxQueueEvent( m_dcSourceType1, new wxCommandEvent( wxEVT_RADIOBOX ) );
96  wxQueueEvent( m_dcSourceType2, new wxCommandEvent( wxEVT_RADIOBOX ) );
97  }

References DIALOG_SIM_SETTINGS_BASE::m_dcEnable2, DIALOG_SIM_SETTINGS_BASE::m_dcSourceType1, and DIALOG_SIM_SETTINGS_BASE::m_dcSourceType2.

Referenced by DIALOG_SIM_SETTINGS(), and parseCommand().

◆ resetSize()

void DIALOG_SHIM::resetSize ( )
protectedinherited

Clear the existing dialog size and position.

This will cause the dialog size to be clear so the next time the dialog is shown the sizers will layout the dialog accordingly. This useful when there are dialog windows that size changes due to layout dependency hidden controls.

Definition at line 282 of file dialog_shim.cpp.

283 {
284  const char* hash_key;
285 
286  if( m_hash_key.size() )
287  {
288  // a special case like EDA_LIST_DIALOG, which has multiple uses.
289  hash_key = m_hash_key.c_str();
290  }
291  else
292  {
293  hash_key = typeid(*this).name();
294  }
295 
296  RECT_MAP::iterator it = class_map.find( hash_key );
297 
298  if( it == class_map.end() )
299  return;
300 
301  EDA_RECT rect = it->second;
302  rect.SetSize( 0, 0 );
303  class_map[ hash_key ] = rect;
304 }
std::string m_hash_key
Definition: dialog_shim.h:200
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:139
Handle the component boundary box.
Definition: eda_rect.h:42

References class_map, DIALOG_SHIM::m_hash_key, and EDA_RECT::SetSize().

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

◆ scaleToString()

static wxString DIALOG_SIM_SETTINGS::scaleToString ( int  aOption)
inlinestaticprivate

Definition at line 160 of file dialog_sim_settings.h.

161  {
162  switch( aOption )
163  {
164  case DECADE:
165  return wxString( "dec" );
166 
167  case OCTAVE:
168  return wxString( "oct" );
169 
170  case LINEAR:
171  return wxString( "lin" );
172  }
173 
174  wxASSERT_MSG( false, "Unhandled scale type" );
175 
176  return wxEmptyString;
177  }

References DECADE, LINEAR, and OCTAVE.

Referenced by TransferDataFromWindow().

◆ SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow)
inlineinherited

Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.

Definition at line 98 of file dialog_shim.h.

99  {
100  m_initialFocusTarget = aWindow;
101  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:210

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_INSPECTION_REPORTER::DIALOG_INSPECTION_REPORTER(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

◆ SetKiway()

void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters
aDestis the recipient of aKiway pointer.
aKiwayis often from a parent window or from KIFACE::CreateWindow().

Definition at line 42 of file kiway_holder.cpp.

43 {
44 #if defined(DEBUG)
45  // offer a trap point for debugging most any window
46  wxASSERT( aDest );
47  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
48  {
49  int breakhere=1;
50  (void) breakhere;
51  }
52 #endif
53 
54  (void) aDest;
55 
56  m_kiway = aKiway;
57 }
KIWAY * m_kiway
Definition: kiway_holder.h:78
const char * name
Definition: DXF_plotter.cpp:59

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetNetlistExporter()

void DIALOG_SIM_SETTINGS::SetNetlistExporter ( NETLIST_EXPORTER_PSPICE_SIM aExporter)
inline

Definition at line 64 of file dialog_sim_settings.h.

65  {
66  m_exporter = aExporter;
67  }
NETLIST_EXPORTER_PSPICE_SIM * m_exporter

References m_exporter.

Referenced by SIM_PLOT_FRAME::updateNetlistExporter().

◆ SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint &  aNewPosition)
inherited

Force the position of the dialog to a new position.

Parameters
aNewPositionis the new forced position

Definition at line 187 of file dialog_shim.cpp.

188 {
189  wxDialog::SetPosition( aNewPosition );
190 
191  // Now update the stored position:
192  const char* hash_key;
193 
194  if( m_hash_key.size() )
195  {
196  // a special case like EDA_LIST_DIALOG, which has multiple uses.
197  hash_key = m_hash_key.c_str();
198  }
199  else
200  {
201  hash_key = typeid(*this).name();
202  }
203 
204  RECT_MAP::iterator it = class_map.find( hash_key );
205 
206  if( it == class_map.end() )
207  return;
208 
209  EDA_RECT rect = it->second;
210  rect.SetOrigin( aNewPosition );
211 
212  class_map[ hash_key ] = rect;
213 }
void SetPosition(wxString aStr, const wxString &aDefaultMeasurementUnit, int *aX, int *aY, const wxString &aActualConversion)
std::string m_hash_key
Definition: dialog_shim.h:200
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:126
static RECT_MAP class_map
Handle the component boundary box.
Definition: eda_rect.h:42

References class_map, DIALOG_SHIM::m_hash_key, EDA_RECT::SetOrigin(), and PCAD2KICAD::SetPosition().

Referenced by DIALOG_SCH_FIND::DIALOG_SCH_FIND(), and PCB_BASE_FRAME::SelectOneLayer().

◆ SetSimCommand()

bool DIALOG_SIM_SETTINGS::SetSimCommand ( const wxString &  aCommand)
inline

Definition at line 49 of file dialog_sim_settings.h.

50  {
51  bool res = parseCommand( aCommand );
52 
53  if( res )
54  m_simCommand = aCommand;
55 
56  return res;
57  }
bool parseCommand(const wxString &aCommand)
Parse a Spice directive.

References m_simCommand, and parseCommand().

Referenced by SIM_PLOT_FRAME::onSettings().

◆ setSizeInDU()

void DIALOG_SHIM::setSizeInDU ( int  x,
int  y 
)
protectedinherited

Set the dialog to the given dimensions in "dialog units".

These are units equivalent to 4* the average character width and 8* the average character height, allowing a dialog to be sized in a way that scales it with the system font.

Definition at line 159 of file dialog_shim.cpp.

160 {
161  wxSize sz( x, y );
162  SetSize( ConvertDialogToPixels( sz ) );
163 }

Referenced by DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 216 of file dialog_shim.cpp.

217 {
218  bool ret;
219  const char* hash_key;
220 
221  if( m_hash_key.size() )
222  {
223  // a special case like EDA_LIST_DIALOG, which has multiple uses.
224  hash_key = m_hash_key.c_str();
225  }
226  else
227  {
228  hash_key = typeid(*this).name();
229  }
230 
231  // Show or hide the window. If hiding, save current position and size.
232  // If showing, use previous position and size.
233  if( show )
234  {
235 #ifndef __WINDOWS__
236  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
237 #endif
238  ret = wxDialog::Show( show );
239 
240  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
241  EDA_RECT savedDialogRect = class_map[ hash_key ];
242 
243  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
244  {
245  if( m_useCalculatedSize )
246  {
247  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
248  wxDialog::GetSize().x, wxDialog::GetSize().y, 0 );
249  }
250  else
251  {
252  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
253  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
254  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
255  0 );
256  }
257  }
258 
259  // Be sure that the dialog appears in a visible area
260  // (the dialog position might have been stored at the time when it was
261  // shown on another display)
262  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
263  Centre();
264  }
265  else
266  {
267  // Save the dialog's position & size before hiding, using classname as key
268  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
269 
270 #ifdef __WXMAC__
271  if ( m_eventLoop )
272  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
273 #endif
274 
275  ret = wxDialog::Show( show );
276  }
277 
278  return ret;
279 }
std::string m_hash_key
Definition: dialog_shim.h:200
static RECT_MAP class_map
const wxPoint GetPosition() const
Definition: eda_rect.h:107
Handle the component boundary box.
Definition: eda_rect.h:42
bool m_useCalculatedSize
Definition: dialog_shim.h:204
const wxSize GetSize() const
Definition: eda_rect.h:96

References class_map, EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, and DIALOG_SHIM::m_useCalculatedSize.

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), EE_INSPECTION_TOOL::NextMarker(), DRC_TOOL::NextMarker(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), EE_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), EDA_VIEW_SWITCHER::Show(), DIALOG_PAD_PROPERTIES::Show(), DRC_TOOL::ShowDRCDialog(), EE_INSPECTION_TOOL::ShowERCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

◆ ShowModal()

int DIALOG_SIM_SETTINGS::ShowModal ( )
override

Definition at line 343 of file dialog_sim_settings.cpp.

344 {
345  // Fill out comboboxes that allows one to select nets
346  // Map comoboxes to their current values
347  std::map<wxComboBox*, wxString> cmbNet = {
348  { m_noiseMeas, m_noiseMeas->GetStringSelection() },
349  { m_noiseRef, m_noiseRef->GetStringSelection() }
350  };
351 
352  for( auto c : cmbNet )
353  c.first->Clear();
354 
355  for( const auto& net : m_exporter->GetNetIndexMap() )
356  {
357  for( auto c : cmbNet )
358  c.first->Append( net.first );
359  }
360 
361  // Try to restore the previous selection, if possible
362  for( auto c : cmbNet )
363  {
364  int idx = c.first->FindString( c.second );
365 
366  if( idx != wxNOT_FOUND )
367  c.first->SetSelection( idx );
368  }
369 
370  return DIALOG_SIM_SETTINGS_BASE::ShowModal();
371 }
const NET_INDEX_MAP & GetNetIndexMap() const
Return a map of circuit nodes to net names.
NETLIST_EXPORTER_PSPICE_SIM * m_exporter

References NETLIST_EXPORTER_PSPICE::GetNetIndexMap(), m_exporter, DIALOG_SIM_SETTINGS_BASE::m_noiseMeas, and DIALOG_SIM_SETTINGS_BASE::m_noiseRef.

Referenced by SIM_PLOT_FRAME::onSettings().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 395 of file dialog_shim.cpp.

396 {
397  // This is an exception safe way to zero a pointer before returning.
398  // Yes, even though DismissModal() clears this first normally, this is
399  // here in case there's an exception before the dialog is dismissed.
400  struct NULLER
401  {
402  void*& m_what;
403  NULLER( void*& aPtr ) : m_what( aPtr ) {}
404  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
405  } clear_this( (void*&) m_qmodal_loop );
406 
407  // release the mouse if it's currently captured as the window having it
408  // will be disabled when this dialog is shown -- but will still keep the
409  // capture making it impossible to do anything in the modal dialog itself
410  wxWindow* win = wxWindow::GetCapture();
411  if( win )
412  win->ReleaseMouse();
413 
414  // Get the optimal parent
415  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
416 
417  wxASSERT_MSG( !m_qmodal_parent_disabler,
418  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
419 
420  // quasi-modal: disable only my "optimal" parent
422 
423  // Apple in its infinite wisdom will raise a disabled window before even passing
424  // us the event, so we have no way to stop it. Instead, we must set an order on
425  // the windows so that the quasi-modal will be pushed in front of the disabled
426  // window when it is raised.
428 
429  Show( true );
430 
431  m_qmodal_showing = true;
432 
433  WX_EVENT_LOOP event_loop;
434 
435  m_qmodal_loop = &event_loop;
436 
437  event_loop.Run();
438 
439  m_qmodal_showing = false;
440 
441  return GetReturnCode();
442 }
bool m_qmodal_showing
Definition: dialog_shim.h:214
#define WX_EVENT_LOOP
Definition: kiway_player.h:43
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:212
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:215
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:42
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:62

References DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, KIPLATFORM::UI::ReparentQuasiModal(), DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by SCH_EDIT_TOOL::ChangeSymbols(), S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowDimensionPropertiesDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), and PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog().

◆ TransferDataFromWindow()

bool DIALOG_SIM_SETTINGS::TransferDataFromWindow ( )
override

Definition at line 160 of file dialog_sim_settings.cpp.

161 {
162  if( !wxDialog::TransferDataFromWindow() )
163  return false;
164 
165  // The simulator dependent settings always get transferred.
166  NGSPICE_SIMULATOR_SETTINGS* ngspiceSettings =
167  dynamic_cast<NGSPICE_SIMULATOR_SETTINGS*>( m_settings.get() );
168 
169  if( ngspiceSettings )
170  {
171  switch( m_compatibilityModeChoice->GetSelection() )
172  {
173  case 0: ngspiceSettings->SetModelMode( NGSPICE_MODEL_MODE::USER_CONFIG ); break;
174  case 1: ngspiceSettings->SetModelMode( NGSPICE_MODEL_MODE::NGSPICE ); break;
175  case 2: ngspiceSettings->SetModelMode( NGSPICE_MODEL_MODE::PSPICE ); break;
176  case 3: ngspiceSettings->SetModelMode( NGSPICE_MODEL_MODE::LTSPICE ); break;
177  case 4: ngspiceSettings->SetModelMode( NGSPICE_MODEL_MODE::LT_PSPICE ); break;
178  case 5: ngspiceSettings->SetModelMode( NGSPICE_MODEL_MODE::HSPICE ); break;
179  }
180  }
181 
182  wxString previousSimCommand = m_simCommand;
183  wxWindow* page = m_simPages->GetCurrentPage();
184 
185  if( page == m_pgAC ) // AC analysis
186  {
187  if( !m_pgAC->Validate() )
188  return false;
189 
190  m_simCommand.Printf( ".ac %s %s %s %s",
191  scaleToString( m_acScale->GetSelection() ),
192  m_acPointsNumber->GetValue(),
193  SPICE_VALUE( m_acFreqStart->GetValue() ).ToSpiceString(),
194  SPICE_VALUE( m_acFreqStop->GetValue() ).ToSpiceString() );
195  }
196  else if( page == m_pgDC ) // DC transfer analysis
197  {
198  wxString simCmd = wxString( ".dc " );
199 
201 
202  if( src1.IsEmpty() )
203  return false;
204  else
205  simCmd += src1;
206 
207  if( m_dcEnable2->IsChecked() )
208  {
210 
211  if( src2.IsEmpty() )
212  return false;
213  else
214  simCmd += " " + src2;
215 
216  if( m_dcSource1->GetSelection() == m_dcSource2->GetSelection() )
217  {
218  DisplayError( this, _( "Source 1 and Source 2 must be different" ) );
219  return false;
220  }
221  }
222 
223  m_simCommand = simCmd;
224  }
225  else if( page == m_pgNoise ) // Noise analysis
226  {
228 
231  {
232  return false;
233  }
234 
235  wxString ref;
236 
237  if( !empty( m_noiseRef ) )
238  ref = wxString::Format( ", %d", netMap.at( m_noiseRef->GetValue() ) );
239 
240  wxString noiseSource = m_exporter->GetSpiceDevice( m_noiseSrc->GetValue() );
241 
242  // Add voltage source prefix if needed
243  if( noiseSource[0] != 'v' && noiseSource[0] != 'V' )
244  noiseSource += 'v' + noiseSource;
245 
246  m_simCommand.Printf( ".noise v(%d%s) %s %s %s %s %s",
247  netMap.at( m_noiseMeas->GetValue() ), ref,
248  noiseSource, scaleToString( m_noiseScale->GetSelection() ),
249  m_noisePointsNumber->GetValue(),
250  SPICE_VALUE( m_noiseFreqStart->GetValue() ).ToSpiceString(),
251  SPICE_VALUE( m_noiseFreqStop->GetValue() ).ToSpiceString() );
252  }
253  else if( page == m_pgOP ) // DC operating point analysis
254  {
255  m_simCommand = wxString( ".op" );
256  }
257  else if( page == m_pgTransient ) // Transient analysis
258  {
259  if( !m_pgTransient->Validate() )
260  return false;
261 
262  wxString initial;
263 
264  if( !empty( m_transInitial ) )
265  initial = SPICE_VALUE( m_transInitial->GetValue() ).ToSpiceString();
266 
267  m_simCommand.Printf( ".tran %s %s %s",
268  SPICE_VALUE( m_transStep->GetValue() ).ToSpiceString(),
269  SPICE_VALUE( m_transFinal->GetValue() ).ToSpiceString(),
270  initial );
271  }
272  else if( page == m_pgCustom ) // Custom directives
273  {
274  m_simCommand = m_customTxt->GetValue();
275  }
276  else
277  {
278  wxString extendedMsg;
279 
280  if( m_simCommand.IsEmpty() )
281  {
282  KIDIALOG dlg( this, _( "No valid simulation is configured." ), _( "Warning" ),
283  wxOK | wxCANCEL | wxICON_EXCLAMATION | wxCENTER );
284 
285  dlg.SetExtendedMessage( _( "A valid simulation can be configured by selecting a "
286  "simulation tab, setting the simulation parameters and "
287  "clicking the OK button with the tab selected." ) );
288  dlg.SetOKCancelLabels(
289  wxMessageDialog::ButtonLabel( _( "Exit Without Valid Simulation" ) ),
290  wxMessageDialog::ButtonLabel( _( "Configure Valid Simulation" ) ) );
291  dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
292 
293  if( dlg.ShowModal() == wxID_OK )
294  return true;
295  }
296 
297  return false;
298  }
299 
300  if( previousSimCommand != m_simCommand )
301  {
302  m_simCommand.Trim();
304  }
305 
306  return true;
307 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:252
std::shared_ptr< SPICE_SIMULATOR_SETTINGS > m_settings
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
Definition: confirm.h:45
wxString evaluateDCControls(wxChoice *aDcSource, wxTextCtrl *aDcStart, wxTextCtrl *aDcStop, wxTextCtrl *aDcIncr)
Read values from one DC sweep source to form a part of simulation command.
static wxString scaleToString(int aOption)
< Helper class to handle Spice way of expressing values (e.g. 10.5 Meg) Helper class to recognize Spi...
Definition: spice_value.h:34
const NET_INDEX_MAP & GetNetIndexMap() const
Return a map of circuit nodes to net names.
std::map< wxString, int > NET_INDEX_MAP
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
NETLIST_EXPORTER_PSPICE_SIM * m_exporter
Container for Ngspice simulator settings.
#define _(s)
Definition: 3d_actions.cpp:33
static bool empty(const wxTextEntryBase *aCtrl)
wxString GetSpiceDevice(const wxString &aComponent) const
Return name of Spice device corresponding to a schematic component.
void SetModelMode(NGSPICE_MODEL_MODE aMode)

References _, DisplayError(), KIDIALOG::DoNotShowCheckbox(), empty(), evaluateDCControls(), Format(), NETLIST_EXPORTER_PSPICE::GetNetIndexMap(), NETLIST_EXPORTER_PSPICE::GetSpiceDevice(), HSPICE, LT_PSPICE, LTSPICE, DIALOG_SIM_SETTINGS_BASE::m_acFreqStart, DIALOG_SIM_SETTINGS_BASE::m_acFreqStop, DIALOG_SIM_SETTINGS_BASE::m_acPointsNumber, DIALOG_SIM_SETTINGS_BASE::m_acScale, DIALOG_SIM_SETTINGS_BASE::m_compatibilityModeChoice, DIALOG_SIM_SETTINGS_BASE::m_customTxt, DIALOG_SIM_SETTINGS_BASE::m_dcEnable2, DIALOG_SIM_SETTINGS_BASE::m_dcIncr1, DIALOG_SIM_SETTINGS_BASE::m_dcIncr2, DIALOG_SIM_SETTINGS_BASE::m_dcSource1, DIALOG_SIM_SETTINGS_BASE::m_dcSource2, DIALOG_SIM_SETTINGS_BASE::m_dcStart1, DIALOG_SIM_SETTINGS_BASE::m_dcStart2, DIALOG_SIM_SETTINGS_BASE::m_dcStop1, DIALOG_SIM_SETTINGS_BASE::m_dcStop2, m_exporter, DIALOG_SIM_SETTINGS_BASE::m_noiseFreqStart, DIALOG_SIM_SETTINGS_BASE::m_noiseFreqStop, DIALOG_SIM_SETTINGS_BASE::m_noiseMeas, DIALOG_SIM_SETTINGS_BASE::m_noisePointsNumber, DIALOG_SIM_SETTINGS_BASE::m_noiseRef, DIALOG_SIM_SETTINGS_BASE::m_noiseScale, DIALOG_SIM_SETTINGS_BASE::m_noiseSrc, DIALOG_SIM_SETTINGS_BASE::m_pgAC, DIALOG_SIM_SETTINGS_BASE::m_pgCustom, DIALOG_SIM_SETTINGS_BASE::m_pgDC, DIALOG_SIM_SETTINGS_BASE::m_pgNoise, DIALOG_SIM_SETTINGS_BASE::m_pgOP, DIALOG_SIM_SETTINGS_BASE::m_pgTransient, m_settings, m_simCommand, DIALOG_SIM_SETTINGS_BASE::m_simPages, DIALOG_SIM_SETTINGS_BASE::m_transFinal, DIALOG_SIM_SETTINGS_BASE::m_transInitial, DIALOG_SIM_SETTINGS_BASE::m_transStep, NGSPICE, PSPICE, scaleToString(), NGSPICE_SIMULATOR_SETTINGS::SetModelMode(), KIDIALOG::SetOKCancelLabels(), KIDIALOG::ShowModal(), updateNetlistOpts(), and USER_CONFIG.

◆ TransferDataToWindow()

bool DIALOG_SIM_SETTINGS::TransferDataToWindow ( )
override
Todo:
one day it could interpret the sim command and fill out appropriate fields.

Definition at line 310 of file dialog_sim_settings.cpp.

311 {
313  if( empty( m_customTxt ) )
314  loadDirectives();
315 
316  NGSPICE_SIMULATOR_SETTINGS* ngspiceSettings =
317  dynamic_cast<NGSPICE_SIMULATOR_SETTINGS*>( m_settings.get() );
318 
319  if( ngspiceSettings )
320  {
321  switch( ngspiceSettings->GetModelMode() )
322  {
323  case NGSPICE_MODEL_MODE::USER_CONFIG: m_compatibilityModeChoice->SetSelection( 0 ); break;
324  case NGSPICE_MODEL_MODE::NGSPICE: m_compatibilityModeChoice->SetSelection( 1 ); break;
325  case NGSPICE_MODEL_MODE::PSPICE: m_compatibilityModeChoice->SetSelection( 2 ); break;
326  case NGSPICE_MODEL_MODE::LTSPICE: m_compatibilityModeChoice->SetSelection( 3 ); break;
327  case NGSPICE_MODEL_MODE::LT_PSPICE: m_compatibilityModeChoice->SetSelection( 4 ); break;
328  case NGSPICE_MODEL_MODE::HSPICE: m_compatibilityModeChoice->SetSelection( 5 ); break;
329  default:
330  wxFAIL_MSG( wxString::Format( "Unknown NGSPICE_MODEL_MODE %d.",
331  ngspiceSettings->GetModelMode() ) );
332  break;
333  }
334  }
335 
336  if( m_simCommand.IsEmpty() && !empty( m_customTxt ) )
337  return parseCommand( m_customTxt->GetValue() );
338 
339  return true;
340 }
std::shared_ptr< SPICE_SIMULATOR_SETTINGS > m_settings
bool parseCommand(const wxString &aCommand)
Parse a Spice directive.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
NGSPICE_MODEL_MODE GetModelMode() const
Container for Ngspice simulator settings.
static bool empty(const wxTextEntryBase *aCtrl)

References empty(), Format(), NGSPICE_SIMULATOR_SETTINGS::GetModelMode(), HSPICE, loadDirectives(), LT_PSPICE, LTSPICE, DIALOG_SIM_SETTINGS_BASE::m_compatibilityModeChoice, DIALOG_SIM_SETTINGS_BASE::m_customTxt, m_settings, m_simCommand, NGSPICE, parseCommand(), PSPICE, and USER_CONFIG.

Referenced by onInitDlg().

◆ updateDCSources()

void DIALOG_SIM_SETTINGS::updateDCSources ( wxChar  aType,
wxChoice *  aSource 
)
private

Update DC sweep source with components from schematic.

Definition at line 374 of file dialog_sim_settings.cpp.

375 {
376  wxString prevSelection;
377 
378  if( aSource->GetCount() )
379  aSource->GetString( aSource->GetSelection() );
380 
381  std::vector<wxString> sourcesList;
382  bool enableSrcSelection = true;
383 
384  if( aType != 'T' )
385  {
386  for( const auto& item : m_exporter->GetSpiceItems() )
387  {
388  if( item.m_primitive == aType )
389  sourcesList.push_back( item.m_refName );
390  }
391 
392  std::sort( sourcesList.begin(), sourcesList.end(),
393  [](wxString& a, wxString& b) -> bool
394  {
395  return a.Len() < b.Len() || b.Cmp( a ) > 0;
396  } );
397 
398  if( aSource == m_dcSource2 && !m_dcEnable2->IsChecked() )
399  enableSrcSelection = false;
400  }
401  else
402  {
403  prevSelection = wxT( "TEMP" );
404  sourcesList.push_back( prevSelection );
405  enableSrcSelection = false;
406  }
407 
408  aSource->Enable( enableSrcSelection );
409 
410  aSource->Clear();
411 
412  for( auto& src : sourcesList )
413  aSource->Append( src );
414 
415  // Try to restore the previous selection, if possible
416  aSource->SetStringSelection( prevSelection );
417 }
const SPICE_ITEM_LIST & GetSpiceItems() const
Return list of items representing schematic components in the Spice world.
NETLIST_EXPORTER_PSPICE_SIM * m_exporter

References NETLIST_EXPORTER_PSPICE::GetSpiceItems(), DIALOG_SIM_SETTINGS_BASE::m_dcEnable2, DIALOG_SIM_SETTINGS_BASE::m_dcSource2, and m_exporter.

Referenced by onDCSource1Selected(), onDCSource2Selected(), onSwapDCSources(), and parseCommand().

◆ updateDCUnits()

void DIALOG_SIM_SETTINGS::updateDCUnits ( wxChar  aType,
wxChoice *  aSource,
wxStaticText *  aStartValUnit,
wxStaticText *  aEndValUnit,
wxStaticText *  aStepUnit 
)
private

Update units on labels depending on selected source.

Definition at line 568 of file dialog_sim_settings.cpp.

571 {
572  wxString unit;
573 
574  switch( aType )
575  {
576  case 'V': unit = _( "Volts" ); break;
577  case 'I': unit = _( "Amperes" ); break;
578  case 'R': unit = _( "Ohms" ); break;
579  case 'T': unit = wxT( "\u00B0C" ); break;
580  }
581 
582  aStartValUnit->SetLabel( unit );
583  aEndValUnit->SetLabel( unit );
584  aStepUnit->SetLabel( unit );
585 
586  m_pgDC->Fit();
587  m_pgDC->Refresh();
588 }
#define _(s)
Definition: 3d_actions.cpp:33

References _, and DIALOG_SIM_SETTINGS_BASE::m_pgDC.

Referenced by onDCSource1Selected(), onDCSource2Selected(), and onSwapDCSources().

◆ updateNetlistOpts()

◆ Validate()

virtual bool DIALOG_SIM_SETTINGS::Validate ( )
inlineoverridevirtual

Definition at line 76 of file dialog_sim_settings.h.

77  {
78  return true;
79  }

◆ vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int  y) const
protectedinherited

Convert an integer number of dialog units to pixels, vertically.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 173 of file dialog_shim.cpp.

174 {
175  wxSize sz( 0, y );
176  return ConvertDialogToPixels( sz ).y;
177 }

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

Member Data Documentation

◆ m_acFreqStart

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_acFreqStart
protectedinherited

◆ m_acFreqStop

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_acFreqStop
protectedinherited

◆ m_acPointsNumber

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_acPointsNumber
protectedinherited

◆ m_acScale

wxRadioBox* DIALOG_SIM_SETTINGS_BASE::m_acScale
protectedinherited

◆ m_compatibilityMode

wxBoxSizer* DIALOG_SIM_SETTINGS_BASE::m_compatibilityMode
protectedinherited

◆ m_compatibilityModeChoice

wxChoice* DIALOG_SIM_SETTINGS_BASE::m_compatibilityModeChoice
protectedinherited

◆ m_customTxt

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_customTxt
protectedinherited

◆ m_dcEnable2

◆ m_dcIncr1

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_dcIncr1
protectedinherited

◆ m_dcIncr2

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_dcIncr2
protectedinherited

◆ m_dcSource1

wxChoice* DIALOG_SIM_SETTINGS_BASE::m_dcSource1
protectedinherited

◆ m_dcSource2

◆ m_dcSourceType1

◆ m_dcSourceType2

◆ m_dcStart1

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_dcStart1
protectedinherited

◆ m_dcStart2

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_dcStart2
protectedinherited

◆ m_dcStop1

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_dcStop1
protectedinherited

◆ m_dcStop2

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_dcStop2
protectedinherited

◆ m_exporter

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 209 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_fixIncludePaths

wxCheckBox* DIALOG_SIM_SETTINGS_BASE::m_fixIncludePaths
protectedinherited

◆ m_fixPassiveVals

wxCheckBox* DIALOG_SIM_SETTINGS_BASE::m_fixPassiveVals
protectedinherited

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 210 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint(), and DIALOG_SHIM::SetInitialFocus().

◆ m_loadDirectives

wxButton* DIALOG_SIM_SETTINGS_BASE::m_loadDirectives
protectedinherited

◆ m_netlistOpts

int DIALOG_SIM_SETTINGS::m_netlistOpts
private

Definition at line 183 of file dialog_sim_settings.h.

Referenced by GetNetlistOptions(), and updateNetlistOpts().

◆ m_noiseFreqStart

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_noiseFreqStart
protectedinherited

◆ m_noiseFreqStop

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_noiseFreqStop
protectedinherited

◆ m_noiseMeas

wxComboBox* DIALOG_SIM_SETTINGS_BASE::m_noiseMeas
protectedinherited

◆ m_noisePointsNumber

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_noisePointsNumber
protectedinherited

◆ m_noiseRef

wxComboBox* DIALOG_SIM_SETTINGS_BASE::m_noiseRef
protectedinherited

◆ m_noiseScale

wxRadioBox* DIALOG_SIM_SETTINGS_BASE::m_noiseScale
protectedinherited

◆ m_noiseSrc

wxComboBox* DIALOG_SIM_SETTINGS_BASE::m_noiseSrc
protectedinherited

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 217 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook().

◆ m_pgAC

wxPanel* DIALOG_SIM_SETTINGS_BASE::m_pgAC
protectedinherited

◆ m_pgCustom

wxPanel* DIALOG_SIM_SETTINGS_BASE::m_pgCustom
protectedinherited

◆ m_pgDC

wxPanel* DIALOG_SIM_SETTINGS_BASE::m_pgDC
protectedinherited

◆ m_pgDistortion

wxPanel* DIALOG_SIM_SETTINGS_BASE::m_pgDistortion
protectedinherited

◆ m_pgNoise

wxPanel* DIALOG_SIM_SETTINGS_BASE::m_pgNoise
protectedinherited

◆ m_pgOP

wxPanel* DIALOG_SIM_SETTINGS_BASE::m_pgOP
protectedinherited

◆ m_pgPoleZero

wxPanel* DIALOG_SIM_SETTINGS_BASE::m_pgPoleZero
protectedinherited

◆ m_pgSensitivity

wxPanel* DIALOG_SIM_SETTINGS_BASE::m_pgSensitivity
protectedinherited

◆ m_pgTransferFunction

wxPanel* DIALOG_SIM_SETTINGS_BASE::m_pgTransferFunction
protectedinherited

◆ m_pgTransient

wxPanel* DIALOG_SIM_SETTINGS_BASE::m_pgTransient
protectedinherited

◆ m_posIntValidator

wxIntegerValidator<int> DIALOG_SIM_SETTINGS::m_posIntValidator
private

Definition at line 188 of file dialog_sim_settings.h.

Referenced by DIALOG_SIM_SETTINGS().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 212 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

◆ m_qmodal_parent_disabler

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited

◆ m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing
protectedinherited

Definition at line 214 of file dialog_shim.h.

Referenced by DIALOG_SHIM::IsQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

◆ m_sdbSizer

wxStdDialogButtonSizer* DIALOG_SIM_SETTINGS_BASE::m_sdbSizer
protectedinherited

◆ m_sdbSizerCancel

wxButton* DIALOG_SIM_SETTINGS_BASE::m_sdbSizerCancel
protectedinherited

◆ m_sdbSizerOK

wxButton* DIALOG_SIM_SETTINGS_BASE::m_sdbSizerOK
protectedinherited

◆ m_settings

std::shared_ptr<SPICE_SIMULATOR_SETTINGS> DIALOG_SIM_SETTINGS::m_settings
private

Definition at line 185 of file dialog_sim_settings.h.

Referenced by TransferDataFromWindow(), and TransferDataToWindow().

◆ m_simCommand

wxString DIALOG_SIM_SETTINGS::m_simCommand
private

◆ m_simPages

wxNotebook* DIALOG_SIM_SETTINGS_BASE::m_simPages
protectedinherited

◆ m_spiceEmptyValidator

SPICE_VALIDATOR DIALOG_SIM_SETTINGS::m_spiceEmptyValidator
private

Definition at line 187 of file dialog_sim_settings.h.

Referenced by DIALOG_SIM_SETTINGS().

◆ m_spiceValidator

SPICE_VALIDATOR DIALOG_SIM_SETTINGS::m_spiceValidator
private

Definition at line 186 of file dialog_sim_settings.h.

Referenced by DIALOG_SIM_SETTINGS().

◆ m_src1DCEndValUnit

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_src1DCEndValUnit
protectedinherited

◆ m_src1DCStartValUnit

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_src1DCStartValUnit
protectedinherited

◆ m_src1DCStepUnit

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_src1DCStepUnit
protectedinherited

◆ m_src2DCEndValUnit

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_src2DCEndValUnit
protectedinherited

◆ m_src2DCStartValUnit

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_src2DCStartValUnit
protectedinherited

◆ m_src2DCStepUnit

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_src2DCStepUnit
protectedinherited

◆ m_staticline1

wxStaticLine* DIALOG_SIM_SETTINGS_BASE::m_staticline1
protectedinherited

◆ m_staticText1

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText1
protectedinherited

◆ m_staticText11

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText11
protectedinherited

◆ m_staticText110

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText110
protectedinherited

◆ m_staticText13

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText13
protectedinherited

◆ m_staticText14

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText14
protectedinherited

◆ m_staticText15

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText15
protectedinherited

◆ m_staticText151

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText151
protectedinherited

◆ m_staticText1511

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText1511
protectedinherited

◆ m_staticText1512

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText1512
protectedinherited

◆ m_staticText1513

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText1513
protectedinherited

◆ m_staticText16

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText16
protectedinherited

◆ m_staticText161

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText161
protectedinherited

◆ m_staticText17

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText17
protectedinherited

◆ m_staticText18

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText18
protectedinherited

◆ m_staticText19

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText19
protectedinherited

◆ m_staticText2

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText2
protectedinherited

◆ m_staticText21

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText21
protectedinherited

◆ m_staticText23

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText23
protectedinherited

◆ m_staticText24

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText24
protectedinherited

◆ m_staticText3

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText3
protectedinherited

◆ m_staticText31

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText31
protectedinherited

◆ m_staticText4

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText4
protectedinherited

◆ m_staticText5

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText5
protectedinherited

◆ m_staticText6

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText6
protectedinherited

◆ m_staticText7

wxStaticText* DIALOG_SIM_SETTINGS_BASE::m_staticText7
protectedinherited

◆ m_swapDCSources

wxButton* DIALOG_SIM_SETTINGS_BASE::m_swapDCSources
protectedinherited

◆ m_tabOrder

◆ m_transFinal

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_transFinal
protectedinherited

◆ m_transInitial

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_transInitial
protectedinherited

◆ m_transStep

wxTextCtrl* DIALOG_SIM_SETTINGS_BASE::m_transStep
protectedinherited

◆ m_units

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

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