KiCad PCB EDA Suite
Loading...
Searching...
No Matches
TRANSLINE Class Reference

#include <transline.h>

Inheritance diagram for TRANSLINE:
COAX_UI COPLANAR_UI C_MICROSTRIP C_STRIPLINE MICROSTRIP_UI RECTWAVEGUIDE_UI STRIPLINE_UI TWISTEDPAIR_UI

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]
 

Detailed Description

Definition at line 87 of file transline.h.

Constructor & Destructor Documentation

◆ TRANSLINE()

TRANSLINE::TRANSLINE ( )

Definition at line 62 of file transline.cpp.

References Init(), m_Name, m_parameters, and MURC_PRM.

◆ ~TRANSLINE()

TRANSLINE::~TRANSLINE ( )
virtual

Definition at line 71 of file transline.cpp.

Member Function Documentation

◆ analyze()

void TRANSLINE::analyze ( )

◆ calcAnalyze()

virtual void TRANSLINE::calcAnalyze ( )
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().

◆ calcSynthesize()

virtual void TRANSLINE::calcSynthesize ( )
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().

◆ checkProperties()

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().

◆ convertParameterStatusCode()

◆ getProperties()

◆ getProperty()

double TRANSLINE::getProperty ( enum PRMS_ID aPrmId)

Definition at line 139 of file transline.cpp.

References GetPropertyInDialog().

Referenced by getProperties().

◆ Init()

◆ isSelected()

◆ pushSoldermaskParameters()

void TRANSLINE::pushSoldermaskParameters ( TRANSLINE_CALCULATION_BASE & aCalc,
bool aIncludeFillsGaps = false ) const
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().

◆ setErrorLevel()

◆ SetExtraParameter()

void TRANSLINE::SetExtraParameter ( enum EXTRA_PRMS_ID aPrmId,
double aValue )
inline

Setter for panel-level parameters that are shared across every calculator type.

Definition at line 98 of file transline.h.

References m_parameters.

◆ setProperty()

◆ setResult() [1/2]

void TRANSLINE::setResult ( int line,
const char * text )

Definition at line 126 of file transline.cpp.

References SetResultInDialog(), and text.

◆ setResult() [2/2]

◆ show_results()

virtual void TRANSLINE::show_results ( )
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().

◆ showAnalyze()

virtual void TRANSLINE::showAnalyze ( )
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().

◆ showSynthesize()

virtual void TRANSLINE::showSynthesize ( )
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().

◆ skin_depth()

double TRANSLINE::skin_depth ( )
protected

@function skin_depth calculate skin depth

$ \frac{1}{\sqrt{ \pi \cdot f \cdot \mu \cdot \sigma }} $

Definition at line 267 of file transline.cpp.

References FREQUENCY_PRM, m_parameters, M_PI, MU0, MURC_PRM, and SIGMA_PRM.

Referenced by getProperties().

◆ synthesize()

void TRANSLINE::synthesize ( )
virtual

Member Data Documentation

◆ errCol

KIGFX::COLOR4D TRANSLINE::errCol = KIGFX::COLOR4D( 1, 0.63, 0.63, 1 )

Definition at line 137 of file transline.h.

Referenced by setErrorLevel().

◆ m_Name

◆ m_parameters

◆ okCol

KIGFX::COLOR4D TRANSLINE::okCol = KIGFX::COLOR4D( 1, 1, 1, 1 )

Definition at line 139 of file transline.h.

Referenced by Init(), and setErrorLevel().

◆ warnCol

KIGFX::COLOR4D TRANSLINE::warnCol = KIGFX::COLOR4D( 1, 1, 0.57, 1 )

Definition at line 138 of file transline.h.

Referenced by setErrorLevel().


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