#include <time_domain_parameters_user_defined.h>

Inheritance diagram for TIME_DOMAIN_PARAMETERS_USER_DEFINED:

Classes
struct	VIA_OVERRIDE_CACHE_KEY
	Cache key for use with std::map. More...

Public Member Functions
	TIME_DOMAIN_PARAMETERS_USER_DEFINED (BOARD aBoard, LENGTH_DELAY_CALCULATION aCalculation)

void	OnSettingsChanged () override
	Event called by the length and time calculation architecture if netclass definitions have changed.

std::vector< int64_t >	GetPropagationDelays (const std::vector< LENGTH_DELAY_CALCULATION_ITEM > &aItems, const TIME_DOMAIN_GEOMETRY_CONTEXT &aContext) override
	Gets the propagation delays (in internal units) for the given items in the given geometry context.

int64_t	GetPropagationDelay (const LENGTH_DELAY_CALCULATION_ITEM &aItem, const TIME_DOMAIN_GEOMETRY_CONTEXT &aContext) override
	Gets the propagation delay (in internal units) for the given item in the given geometry context.

int64_t	GetTrackLengthForPropagationDelay (int64_t aDelay, const TIME_DOMAIN_GEOMETRY_CONTEXT &aContext) override
	Gets the track length (in internal distance units) required for the given propagation delay (in internal time units).

int64_t	CalculatePropagationDelayForShapeLineChain (const SHAPE_LINE_CHAIN &aShape, const TIME_DOMAIN_GEOMETRY_CONTEXT &aContext) override
	Gets the propagation delay for the given shape line chain.

virtual void	OnStackupChanged ()
	Event called by the length and time calculation architecture if the board stackup has changed.

Protected Attributes
BOARD *	m_board
	The board all calculations are for.

LENGTH_DELAY_CALCULATION *	m_lengthCalculation
	The parent length / delay calculation object.

Private Member Functions
void	rebuildCaches ()

int64_t	getPropagationDelay (const LENGTH_DELAY_CALCULATION_ITEM &aItem, const TIME_DOMAIN_GEOMETRY_CONTEXT &aContext, const DELAY_PROFILE *aDelayProfile) const
	Gets the propagation delay (in internal units) for the given item in the given geometry context, for items in the pre-found net class.

const DELAY_PROFILE *	GetDelayProfile (const wxString &aDelayProfileName)
	Gets the tuning profile pointer for the given tuning profile name.

Private Attributes
std::map< wxString, const DELAY_PROFILE * >	m_delayProfilesCache
	Cached map of tuning profile names to per-layer time domain parameters.

std::map< wxString, std::map< VIA_OVERRIDE_CACHE_KEY, int64_t > >	m_viaOverridesCache
	Cached per-tuning profile via overrides.

Detailed Description

Definition at line 31 of file time_domain_parameters_user_defined.h.

Constructor & Destructor Documentation

◆ TIME_DOMAIN_PARAMETERS_USER_DEFINED()

TIME_DOMAIN_PARAMETERS_USER_DEFINED::TIME_DOMAIN_PARAMETERS_USER_DEFINED	(	BOARD *	aBoard,
		LENGTH_DELAY_CALCULATION *	aCalculation )

inlineexplicit

Definition at line 34 of file time_domain_parameters_user_defined.h.

References TIME_DOMAIN_PARAMETERS_IFACE::TIME_DOMAIN_PARAMETERS_IFACE().

Member Function Documentation

◆ CalculatePropagationDelayForShapeLineChain()

int64_t TIME_DOMAIN_PARAMETERS_USER_DEFINED::CalculatePropagationDelayForShapeLineChain	(	const SHAPE_LINE_CHAIN &	aShape,
		const TIME_DOMAIN_GEOMETRY_CONTEXT &	aContext )

overridevirtual

Gets the propagation delay for the given shape line chain.

Parameters

aShape	is the shape to calculate delay for
aContext	is the geometry context for which to query to propagation delay

Implements TIME_DOMAIN_PARAMETERS_IFACE.

Definition at line 147 of file time_domain_parameters_user_defined.cpp.

References NETCLASS::GetDelayProfile(), GetDelayProfile(), TIME_DOMAIN_GEOMETRY_CONTEXT::Layer, SHAPE_LINE_CHAIN::Length(), DELAY_PROFILE::m_LayerPropagationDelays, TIME_DOMAIN_GEOMETRY_CONTEXT::NetClass, and PCB_IU_PER_MM.

◆ GetDelayProfile()

const DELAY_PROFILE * TIME_DOMAIN_PARAMETERS_USER_DEFINED::GetDelayProfile ( const wxString & aDelayProfileName )

private

Gets the tuning profile pointer for the given tuning profile name.

Parameters

aDelayProfileName the tuning profile name to return

Returns: Valid pointer to a tuning profile, or nullptr if no profile found

Definition at line 120 of file time_domain_parameters_user_defined.cpp.

References m_delayProfilesCache.

Referenced by CalculatePropagationDelayForShapeLineChain(), GetPropagationDelay(), GetPropagationDelays(), and GetTrackLengthForPropagationDelay().

◆ GetPropagationDelay()

int64_t TIME_DOMAIN_PARAMETERS_USER_DEFINED::GetPropagationDelay	(	const LENGTH_DELAY_CALCULATION_ITEM &	aItem,
		const TIME_DOMAIN_GEOMETRY_CONTEXT &	aContext )

overridevirtual

Gets the propagation delay (in internal units) for the given item in the given geometry context.

Parameters

aItem	the board item to query propagation delay for
aContext	the geometry context in which to query to propagation delay

Implements TIME_DOMAIN_PARAMETERS_IFACE.

Definition at line 59 of file time_domain_parameters_user_defined.cpp.

References NETCLASS::GetDelayProfile(), GetDelayProfile(), LENGTH_DELAY_CALCULATION_ITEM::GetEffectiveNetClass(), LENGTH_DELAY_CALCULATION_ITEM::GetMergeStatus(), getPropagationDelay(), and LENGTH_DELAY_CALCULATION_ITEM::MERGED_RETIRED.

◆ getPropagationDelay()

int64_t TIME_DOMAIN_PARAMETERS_USER_DEFINED::getPropagationDelay	(	const LENGTH_DELAY_CALCULATION_ITEM &	aItem,
		const TIME_DOMAIN_GEOMETRY_CONTEXT &	aContext,
		const DELAY_PROFILE *	aDelayProfile ) const

private

Gets the propagation delay (in internal units) for the given item in the given geometry context, for items in the pre-found net class.

Preconditions:

aNetClass must not be null
Calculation caches must be valid

Parameters

aItem	the board item to query propagation delay for
aContext	the geometry context in which to query to propagation delay
aDelayProfile	the time domain tuning profile for the given item

Definition at line 75 of file time_domain_parameters_user_defined.cpp.

Referenced by GetPropagationDelay(), and GetPropagationDelays().

◆ GetPropagationDelays()

std::vector< int64_t > TIME_DOMAIN_PARAMETERS_USER_DEFINED::GetPropagationDelays	(	const std::vector< LENGTH_DELAY_CALCULATION_ITEM > &	aItems,
		const TIME_DOMAIN_GEOMETRY_CONTEXT &	aContext )