|
KiCad PCB EDA Suite
|
#include <transline.h>
Public Member Functions | |
| TRANSLINE () | |
| virtual | ~TRANSLINE () |
| void | setProperty (enum PRMS_ID aPrmId, double aValue) |
| double | getProperty (enum PRMS_ID aPrmId) |
| void | SetExtraParameter (enum EXTRA_PRMS_ID aPrmId, double aValue) |
| Setter for panel-level parameters that are shared across every calculator type. | |
| virtual void | getProperties () |
| @function getProperties | |
| void | checkProperties () |
| @function checkProperties | |
| void | setResult (int, double, const char *) |
| void | setResult (int, const char *) |
| bool | isSelected (enum PRMS_ID aPrmId) |
| void | Init () |
| virtual void | synthesize () |
| virtual void | calcAnalyze () |
| Computation for analysis. | |
| virtual void | calcSynthesize () |
| Computation for synthesis. | |
| virtual void | showAnalyze () |
| Shows synthesis results and checks for errors / warnings. | |
| virtual void | showSynthesize () |
| Shows analysis results and checks for errors / warnings. | |
| virtual void | show_results () |
| Shows results. | |
| void | analyze () |
Public Attributes | |
| const char * | m_Name |
| KIGFX::COLOR4D | errCol = KIGFX::COLOR4D( 1, 0.63, 0.63, 1 ) |
| KIGFX::COLOR4D | warnCol = KIGFX::COLOR4D( 1, 1, 0.57, 1 ) |
| KIGFX::COLOR4D | okCol = KIGFX::COLOR4D( 1, 1, 1, 1 ) |
Protected Member Functions | |
| double | skin_depth () |
| @function skin_depth calculate skin depth | |
| void | setErrorLevel (PRMS_ID, char) |
| @function setErrorLevel | |
| void | pushSoldermaskParameters (TRANSLINE_CALCULATION_BASE &aCalc, bool aIncludeFillsGaps=false) const |
| Push the mask-eligible subset of soldermask parameters (PRESENT, THICKNESS, EPSILONR, TAND) into the supplied calculator. | |
Static Protected Member Functions | |
| static char | convertParameterStatusCode (TRANSLINE_STATUS aStatus) |
| Converts a TRANSLINE_PARAMETER status to a PCB Calculation status. | |
Protected Attributes | |
| double | m_parameters [EXTRA_PRMS_COUNT] |
Definition at line 87 of file transline.h.
| TRANSLINE::TRANSLINE | ( | ) |
Definition at line 62 of file transline.cpp.
References Init(), m_Name, m_parameters, and MURC_PRM.
|
virtual |
Definition at line 71 of file transline.cpp.
| void TRANSLINE::analyze | ( | ) |
Definition at line 242 of file transline.cpp.
References calcAnalyze(), checkProperties(), getProperties(), show_results(), and showAnalyze().
|
inlinevirtual |
Computation for analysis.
Reimplemented in C_MICROSTRIP, C_STRIPLINE, COAX_UI, COPLANAR_UI, MICROSTRIP_UI, RECTWAVEGUIDE_UI, STRIPLINE_UI, and TWISTEDPAIR_UI.
Definition at line 113 of file transline.h.
Referenced by analyze().
|
inlinevirtual |
Computation for synthesis.
Reimplemented in C_MICROSTRIP, C_STRIPLINE, COAX_UI, COPLANAR_UI, MICROSTRIP_UI, RECTWAVEGUIDE_UI, STRIPLINE_UI, and TWISTEDPAIR_UI.
Definition at line 118 of file transline.h.
Referenced by synthesize().
| void TRANSLINE::checkProperties | ( | ) |
@function checkProperties
Checks the input parameters (ie: negative length). Does not check for incompatibility between values as this depends on the line shape.
Definition at line 168 of file transline.cpp.
References EPSILONR_PRM, FREQUENCY_PRM, H_PRM, H_T_PRM, m_parameters, MUR_PRM, MURC_PRM, RHO_PRM, setErrorLevel(), STRIPLINE_A_PRM, T_PRM, TAND_PRM, TRANSLINE_WARNING, TWISTEDPAIR_EPSILONR_ENV_PRM, and TWISTEDPAIR_TWIST_PRM.
Referenced by analyze(), and synthesize().
|
staticprotected |
Converts a TRANSLINE_PARAMETER status to a PCB Calculation status.
Definition at line 300 of file transline.cpp.
References OK, TRANSLINE_ERROR, TRANSLINE_OK, TRANSLINE_WARNING, TS_ERROR, and WARNING.
Referenced by C_MICROSTRIP::showAnalyze(), C_STRIPLINE::showAnalyze(), COAX_UI::showAnalyze(), COPLANAR_UI::showAnalyze(), MICROSTRIP_UI::showAnalyze(), RECTWAVEGUIDE_UI::showAnalyze(), STRIPLINE_UI::showAnalyze(), TWISTEDPAIR_UI::showAnalyze(), C_MICROSTRIP::showSynthesize(), C_STRIPLINE::showSynthesize(), COAX_UI::showSynthesize(), COPLANAR_UI::showSynthesize(), MICROSTRIP_UI::showSynthesize(), RECTWAVEGUIDE_UI::showSynthesize(), STRIPLINE_UI::showSynthesize(), and TWISTEDPAIR_UI::showSynthesize().
|
virtual |
@function getProperties
Get all properties from the UI. Computes some extra ones.
Reimplemented in C_MICROSTRIP, C_STRIPLINE, COAX_UI, COPLANAR_UI, GROUNDEDCOPLANAR_UI, MICROSTRIP_UI, RECTWAVEGUIDE_UI, STRIPLINE_UI, and TWISTEDPAIR_UI.
Definition at line 149 of file transline.cpp.
References DUMMY_PRM, EPSILON_EFF_PRM, getProperty(), m_parameters, RHO_PRM, setErrorLevel(), SIGMA_PRM, skin_depth(), SKIN_DEPTH_PRM, and TRANSLINE_OK.
Referenced by analyze(), C_MICROSTRIP::getProperties(), C_STRIPLINE::getProperties(), COAX_UI::getProperties(), COPLANAR_UI::getProperties(), MICROSTRIP_UI::getProperties(), RECTWAVEGUIDE_UI::getProperties(), STRIPLINE_UI::getProperties(), TWISTEDPAIR_UI::getProperties(), and synthesize().
| double TRANSLINE::getProperty | ( | enum PRMS_ID | aPrmId | ) |
Definition at line 139 of file transline.cpp.
References GetPropertyInDialog().
Referenced by getProperties().
| void TRANSLINE::Init | ( | ) |
Definition at line 76 of file transline.cpp.
References DIELECTRIC_MODEL_PRM, EPSILONR_SPEC_FREQ_PRM, EXTRA_PRMS_COUNT, m_parameters, okCol, SOLDERMASK_EPSILONR_PRM, SOLDERMASK_FILLS_GAPS_PRM, SOLDERMASK_PRESENT_PRM, SOLDERMASK_TAND_PRM, and SOLDERMASK_THICKNESS_PRM.
Referenced by C_MICROSTRIP::C_MICROSTRIP(), C_STRIPLINE::C_STRIPLINE(), COAX_UI::COAX_UI(), COPLANAR_UI::COPLANAR_UI(), MICROSTRIP_UI::MICROSTRIP_UI(), RECTWAVEGUIDE_UI::RECTWAVEGUIDE_UI(), STRIPLINE_UI::STRIPLINE_UI(), TRANSLINE(), and TWISTEDPAIR_UI::TWISTEDPAIR_UI().
| bool TRANSLINE::isSelected | ( | enum PRMS_ID | aPrmId | ) |
Definition at line 118 of file transline.cpp.
References IsSelectedInDialog().
Referenced by COAX_UI::getProperties(), COPLANAR_UI::getProperties(), RECTWAVEGUIDE_UI::getProperties(), TWISTEDPAIR_UI::getProperties(), COAX_UI::showSynthesize(), COPLANAR_UI::showSynthesize(), RECTWAVEGUIDE_UI::showSynthesize(), and TWISTEDPAIR_UI::showSynthesize().
|
protected |
Push the mask-eligible subset of soldermask parameters (PRESENT, THICKNESS, EPSILONR, TAND) into the supplied calculator.
Callers that need the CPW-only FILLS_GAPS flag pass aIncludeFillsGaps = true. Mask-ineligible calculators (stripline, coax, waveguide, twisted pair) do not override GetSoldermaskFillingG so these writes are harmless no-ops on those backends; this helper is purely a deduplication aid for the four eligible subclasses (microstrip, c_microstrip, coplanar).
Definition at line 313 of file transline.cpp.
References m_parameters, TRANSLINE_CALCULATION_BASE::SetParameter(), SOLDERMASK_EPSILONR, SOLDERMASK_EPSILONR_PRM, SOLDERMASK_FILLS_GAPS, SOLDERMASK_FILLS_GAPS_PRM, SOLDERMASK_PRESENT, SOLDERMASK_PRESENT_PRM, SOLDERMASK_TAND, SOLDERMASK_TAND_PRM, SOLDERMASK_THICKNESS, and SOLDERMASK_THICKNESS_PRM.
Referenced by C_MICROSTRIP::getProperties(), COPLANAR_UI::getProperties(), and MICROSTRIP_UI::getProperties().
|
protected |
@function setErrorLevel
set an error / warning level for a given parameter.
| aP | parameter |
| aErrorLevel | Error level |
Definition at line 289 of file transline.cpp.
References errCol, okCol, SetPropertyBgColorInDialog(), TRANSLINE_ERROR, TRANSLINE_WARNING, and warnCol.
Referenced by checkProperties(), getProperties(), C_MICROSTRIP::showAnalyze(), C_STRIPLINE::showAnalyze(), COAX_UI::showAnalyze(), COPLANAR_UI::showAnalyze(), MICROSTRIP_UI::showAnalyze(), RECTWAVEGUIDE_UI::showAnalyze(), STRIPLINE_UI::showAnalyze(), TWISTEDPAIR_UI::showAnalyze(), C_MICROSTRIP::showSynthesize(), C_STRIPLINE::showSynthesize(), COAX_UI::showSynthesize(), COPLANAR_UI::showSynthesize(), MICROSTRIP_UI::showSynthesize(), RECTWAVEGUIDE_UI::showSynthesize(), STRIPLINE_UI::showSynthesize(), and TWISTEDPAIR_UI::showSynthesize().
|
inline |
Setter for panel-level parameters that are shared across every calculator type.
Definition at line 98 of file transline.h.
References m_parameters.
| void TRANSLINE::setProperty | ( | enum PRMS_ID | aPrmId, |
| double | aValue ) |
Definition at line 108 of file transline.cpp.
References SetPropertyInDialog().
Referenced by C_MICROSTRIP::showAnalyze(), C_STRIPLINE::showAnalyze(), COAX_UI::showAnalyze(), COPLANAR_UI::showAnalyze(), MICROSTRIP_UI::showAnalyze(), RECTWAVEGUIDE_UI::showAnalyze(), STRIPLINE_UI::showAnalyze(), TWISTEDPAIR_UI::showAnalyze(), C_MICROSTRIP::showSynthesize(), C_STRIPLINE::showSynthesize(), COAX_UI::showSynthesize(), COPLANAR_UI::showSynthesize(), MICROSTRIP_UI::showSynthesize(), RECTWAVEGUIDE_UI::showSynthesize(), STRIPLINE_UI::showSynthesize(), and TWISTEDPAIR_UI::showSynthesize().
| void TRANSLINE::setResult | ( | int | line, |
| const char * | text ) |
Definition at line 126 of file transline.cpp.
References SetResultInDialog(), and text.
| void TRANSLINE::setResult | ( | int | line, |
| double | value, | ||
| const char * | text ) |
Definition at line 132 of file transline.cpp.
References SetResultInDialog(), and text.
Referenced by COAX_UI::show_results(), COPLANAR_UI::show_results(), RECTWAVEGUIDE_UI::show_results(), TWISTEDPAIR_UI::show_results(), C_MICROSTRIP::showAnalyze(), C_STRIPLINE::showAnalyze(), MICROSTRIP_UI::showAnalyze(), STRIPLINE_UI::showAnalyze(), C_MICROSTRIP::showSynthesize(), C_STRIPLINE::showSynthesize(), MICROSTRIP_UI::showSynthesize(), and STRIPLINE_UI::showSynthesize().
|
inlinevirtual |
Shows results.
Reimplemented in C_MICROSTRIP, C_STRIPLINE, COAX_UI, COPLANAR_UI, MICROSTRIP_UI, RECTWAVEGUIDE_UI, STRIPLINE_UI, and TWISTEDPAIR_UI.
Definition at line 133 of file transline.h.
Referenced by analyze(), and synthesize().
|
inlinevirtual |
Shows synthesis results and checks for errors / warnings.
Reimplemented in C_MICROSTRIP, C_STRIPLINE, COAX_UI, COPLANAR_UI, MICROSTRIP_UI, RECTWAVEGUIDE_UI, STRIPLINE_UI, and TWISTEDPAIR_UI.
Definition at line 123 of file transline.h.
Referenced by analyze().
|
inlinevirtual |
Shows analysis results and checks for errors / warnings.
Reimplemented in C_MICROSTRIP, C_STRIPLINE, COAX_UI, COPLANAR_UI, MICROSTRIP_UI, RECTWAVEGUIDE_UI, STRIPLINE_UI, and TWISTEDPAIR_UI.
Definition at line 128 of file transline.h.
Referenced by synthesize().
|
protected |
@function skin_depth calculate skin depth

Definition at line 267 of file transline.cpp.
References FREQUENCY_PRM, m_parameters, M_PI, MU0, MURC_PRM, and SIGMA_PRM.
Referenced by getProperties().
|
virtual |
Definition at line 251 of file transline.cpp.
References calcSynthesize(), checkProperties(), getProperties(), show_results(), and showSynthesize().
| KIGFX::COLOR4D TRANSLINE::errCol = KIGFX::COLOR4D( 1, 0.63, 0.63, 1 ) |
Definition at line 137 of file transline.h.
Referenced by setErrorLevel().
| const char* TRANSLINE::m_Name |
Definition at line 93 of file transline.h.
Referenced by C_MICROSTRIP::C_MICROSTRIP(), C_STRIPLINE::C_STRIPLINE(), COAX_UI::COAX_UI(), COPLANAR_UI::COPLANAR_UI(), GROUNDEDCOPLANAR_UI::GROUNDEDCOPLANAR_UI(), MICROSTRIP_UI::MICROSTRIP_UI(), RECTWAVEGUIDE_UI::RECTWAVEGUIDE_UI(), STRIPLINE_UI::STRIPLINE_UI(), TRANSLINE(), and TWISTEDPAIR_UI::TWISTEDPAIR_UI().
|
protected |
Definition at line 142 of file transline.h.
Referenced by checkProperties(), C_MICROSTRIP::getProperties(), C_STRIPLINE::getProperties(), COAX_UI::getProperties(), COPLANAR_UI::getProperties(), MICROSTRIP_UI::getProperties(), RECTWAVEGUIDE_UI::getProperties(), STRIPLINE_UI::getProperties(), getProperties(), TWISTEDPAIR_UI::getProperties(), Init(), pushSoldermaskParameters(), SetExtraParameter(), skin_depth(), and TRANSLINE().
| KIGFX::COLOR4D TRANSLINE::okCol = KIGFX::COLOR4D( 1, 1, 1, 1 ) |
Definition at line 139 of file transline.h.
Referenced by Init(), and setErrorLevel().
| KIGFX::COLOR4D TRANSLINE::warnCol = KIGFX::COLOR4D( 1, 1, 0.57, 1 ) |
Definition at line 138 of file transline.h.
Referenced by setErrorLevel().