#include <transline.h>

Inheritance diagram for TRANSLINE:

Public Member Functions
	TRANSLINE ()

virtual	~TRANSLINE ()

void	setProperty (enum PRMS_ID aPrmId, double aValue)
	Set a named property to the given value, access through the application.

double	getProperty (enum PRMS_ID aPrmId)
	Return a property value.

void	SetExtraParameter (enum EXTRA_PRMS_ID aPrmId, double aValue)
	Setter for panel-level parameters that are shared across every calculator type.

virtual void	getProperties ()
	Get all properties from the UI.

void	checkProperties ()
	Check the input parameters (ie: negative length).

void	setResult (int aLine, double aValue, const char *aText)
	Put the text into the given result line.

void	setResult (int aLine, const char *aText)

bool	isSelected (enum PRMS_ID aPrmId)
	Return true if the param aPrmId is selected.

void	Init ()

virtual void	synthesize ()

virtual void	calcAnalyze ()
	Computation for analysis.

virtual void	calcSynthesize ()
	Computation for synthesis.

virtual void	showAnalyze ()
	Show synthesis results and checks for errors / warnings.

virtual void	showSynthesize ()
	Show analysis results and checks for errors / warnings.

virtual void	show_results ()
	Show 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 ()
	Calculate skin depth.

void	setErrorLevel (PRMS_ID, char)
	Set an error / warning level for a given parameter.

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)
	Convert a TRANSLINE_STATUS status to a PCB Calculation status.

Protected Attributes
double	m_parameters [EXTRA_PRMS_COUNT]

Detailed Description

Definition at line 85 of file transline.h.

Constructor & Destructor Documentation

◆ TRANSLINE()

TRANSLINE::TRANSLINE ( )

Definition at line 67 of file transline.cpp.

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

◆ ~TRANSLINE()

TRANSLINE::~TRANSLINE ( )

virtual

Definition at line 75 of file transline.cpp.

Member Function Documentation

◆ analyze()

void TRANSLINE::analyze ( )

Definition at line 230 of file transline.cpp.

References calcAnalyze(), checkProperties(), getProperties(), show_results(), and showAnalyze().

◆ 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 137 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 142 of file transline.h.

Referenced by synthesize().

◆ checkProperties()

void TRANSLINE::checkProperties ( )

Check the input parameters (ie: negative length).

Does not check for incompatibility between values as this depends on the line shape.

Definition at line 154 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()

char TRANSLINE::convertParameterStatusCode ( TRANSLINE_STATUS aStatus )

staticprotected

Convert a TRANSLINE_STATUS status to a PCB Calculation status.

Definition at line 271 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().

◆ getProperties()

void TRANSLINE::getProperties ( )

virtual

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

◆ getProperty()

double TRANSLINE::getProperty ( enum PRMS_ID aPrmId )

Return a property value.

Definition at line 134 of file transline.cpp.

References GetPropertyInDialog().

Referenced by getProperties().

◆ Init()

void TRANSLINE::Init ( )

◆ isSelected()

bool TRANSLINE::isSelected ( enum PRMS_ID aPrmId )

Return true if the param aPrmId is selected.

Has meaning only for parameters that have a radio button.

Definition at line 116 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().

◆ 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 284 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.