Interface for providers of tuning profile parameter information. More...

#include <tuning_profile_parameters_iface.h>

Inheritance diagram for TUNING_PROFILE_PARAMETERS_IFACE:

Public Member Functions
	TUNING_PROFILE_PARAMETERS_IFACE (BOARD aBoard, LENGTH_DELAY_CALCULATION aCalculation)

virtual	~TUNING_PROFILE_PARAMETERS_IFACE ()=default

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

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

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

virtual int64_t	GetPropagationDelay (const LENGTH_DELAY_CALCULATION_ITEM &aItem, const TUNING_PROFILE_GEOMETRY_CONTEXT &aContext)=0
	Gets the propagation delay (in internal units) for the given item in the given geometry context.

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

virtual int64_t	CalculatePropagationDelayForShapeLineChain (const SHAPE_LINE_CHAIN &aShape, const TUNING_PROFILE_GEOMETRY_CONTEXT &aContext)=0
	Gets the propagation delay for the given shape line chain.

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

LENGTH_DELAY_CALCULATION *	m_lengthCalculation
	The parent length / delay calculation object.

Detailed Description

Interface for providers of tuning profile parameter information.

This interface is consumed by the LENGTH_TIME_CALCULATOR object to convert space-domain physical layout information (e.g. track lengths) in to time-domain propagation information.

Definition at line 59 of file tuning_profile_parameters_iface.h.

Constructor & Destructor Documentation

◆ TUNING_PROFILE_PARAMETERS_IFACE()

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

inlineexplicit

Definition at line 62 of file tuning_profile_parameters_iface.h.

References m_board, and m_lengthCalculation.

Referenced by TUNING_PROFILE_PARAMETERS_USER_DEFINED::TUNING_PROFILE_PARAMETERS_USER_DEFINED().

◆ ~TUNING_PROFILE_PARAMETERS_IFACE()

virtual TUNING_PROFILE_PARAMETERS_IFACE::~TUNING_PROFILE_PARAMETERS_IFACE ( )

virtualdefault

Member Function Documentation

◆ CalculatePropagationDelayForShapeLineChain()

virtual int64_t TUNING_PROFILE_PARAMETERS_IFACE::CalculatePropagationDelayForShapeLineChain	(	const SHAPE_LINE_CHAIN &	aShape,
		const TUNING_PROFILE_GEOMETRY_CONTEXT &	aContext )

pure virtual

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

Implemented in TUNING_PROFILE_PARAMETERS_USER_DEFINED.

◆ GetPropagationDelay()

virtual int64_t TUNING_PROFILE_PARAMETERS_IFACE::GetPropagationDelay	(	const LENGTH_DELAY_CALCULATION_ITEM &	aItem,
		const TUNING_PROFILE_GEOMETRY_CONTEXT &	aContext )

pure virtual

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	is the geometry context in which to query to propagation delay

Implemented in TUNING_PROFILE_PARAMETERS_USER_DEFINED.

◆ GetPropagationDelays()

virtual std::vector< int64_t > TUNING_PROFILE_PARAMETERS_IFACE::GetPropagationDelays	(	const std::vector< LENGTH_DELAY_CALCULATION_ITEM > &	aItems,
		const TUNING_PROFILE_GEOMETRY_CONTEXT &	aContext )

pure virtual

Gets the propagation delays (in internal units) for the given items in the given geometry context.

Parameters

aItems	the board items to query propagation delay for
aContext	the geometry context in which to query to propagation delay

Implemented in TUNING_PROFILE_PARAMETERS_USER_DEFINED.

◆ GetTrackLengthForPropagationDelay()

virtual int64_t TUNING_PROFILE_PARAMETERS_IFACE::GetTrackLengthForPropagationDelay	(	int64_t	aDelay,
		const TUNING_PROFILE_GEOMETRY_CONTEXT &	aContext )