The SIMULATOR_FRAME holds the main user-interface for running simulations. More...

#include <sim_plot_tab.h>

Inheritance diagram for CURSOR:

Public Member Functions
	CURSOR (TRACE aTrace, SIM_PLOT_TAB aPlotTab)

void	Plot (wxDC &aDC, mpWindow &aWindow) override
	Plot method.

void	SetX (int aX)

void	Update ()

bool	Inside (const wxPoint &aPoint) const override
	Checks whether a point is inside the info box rectangle.

void	Move (wxPoint aDelta) override
	Moves the layer rectangle of given pixel deltas.

void	UpdateReference () override
	Updates the rectangle reference point.

bool	OnDoubleClick (const wxPoint &aPoint, mpWindow &aWindow) override

const wxRealPoint &	GetCoords () const

virtual void	SetCoordX (double aValue)

virtual bool	HasBBox () const override
	mpInfoLayer has not bounding box.

virtual bool	IsInfo () const override
	Specifies that this is an Info box layer.

wxPoint	GetPosition () const
	Returns the position of the upper left corner of the box (in pixels)

wxSize	GetSize () const
	Returns the size of the box (in pixels)

virtual double	GetMinX () const
	Get inclusive left border of bounding box.

virtual double	GetMaxX () const
	Get inclusive right border of bounding box.

virtual double	GetMinY () const
	Get inclusive bottom border of bounding box.

virtual double	GetMaxY () const
	Get inclusive top border of bounding box.

const wxString &	GetName () const
	Get layer name.

const wxString &	GetDisplayName () const

const wxFont &	GetFont () const
	Get font set for this layer.

const wxPen &	GetPen () const
	Get pen set for this layer.

void	SetContinuity (bool continuity)
	Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).

bool	GetContinuity () const
	Gets the 'continuity' property of the layer.

void	ShowName (bool show)
	Shows or hides the text label with the name of the layer (default is visible).

virtual void	SetName (const wxString &name)
	Set layer name.

void	SetFont (const wxFont &font)
	Set layer font.

void	SetPen (const wxPen &pen)
	Set layer pen.

mpLayerType	GetLayerType () const
	Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value.

bool	IsVisible () const
	Checks whether the layer is visible or not.

void	SetVisible (bool show)
	Sets layer visibility.

const wxBrush &	GetBrush () const
	Get brush set for this layer.

void	SetBrush (const wxBrush &brush)
	Set layer brush.

Protected Member Functions
wxString	getID ()

Protected Attributes
TRACE *	m_trace

bool	m_updateRequired

bool	m_updateRef

wxRealPoint	m_coords

mpWindow *	m_window

int	m_sweepIndex

bool	m_snapToNearest

double	m_snapTargetY

wxRect	m_dim

wxPoint	m_reference

wxBrush	m_brush

int	m_winX

int	m_winY

wxFont	m_font

wxPen	m_pen

wxString	m_name

wxString	m_displayName

bool	m_continuous

bool	m_showName

mpLayerType	m_type

bool	m_visible

Static Protected Attributes
static constexpr int	DRAG_MARGIN = 10

Private Member Functions
void	doSetCoordX (double aValue)

Detailed Description

The SIMULATOR_FRAME holds the main user-interface for running simulations.

It contains a workbook with multiple tabs, each tab holding a SIM_PLOT_TAB, a specific simulation command (.TRAN, .AC, etc.), and simulation settings (save all currents, etc.).

Each plot can have multiple TRACEs. While internally each TRACE can have multiple cursors, the GUI supports only two cursors (and a differential cursor) for each plot.

TRACEs are identified by a signal (V(OUT), I(R2), etc.) and a type (SPT_VOLTAGE, SPT_AC_PHASE, etc.).

The simulator outputs simple signals in a vector of the same name. Complex signals (such as V(OUT) / V(IN)) are stored in vectors of the format "user%d". < Cursor attached to a trace to follow its values:

Definition at line 62 of file sim_plot_tab.h.

Constructor & Destructor Documentation

◆ CURSOR()

CURSOR::CURSOR	(	TRACE *	aTrace,
		SIM_PLOT_TAB *	aPlotTab )

inline

Definition at line 65 of file sim_plot_tab.h.

References DRAG_MARGIN, m_coords, m_snapTargetY, m_snapToNearest, m_sweepIndex, m_trace, m_updateRef, m_updateRequired, m_window, and mpInfoLayer::mpInfoLayer().

Referenced by SMITH_CURSOR::SMITH_CURSOR().

Member Function Documentation

◆ doSetCoordX()

void CURSOR::doSetCoordX ( double aValue )

private

Definition at line 952 of file sim_plot_tab.cpp.

References distance(), m_coords, m_snapTargetY, m_snapToNearest, m_sweepIndex, and m_trace.

Referenced by Plot(), and SetCoordX().

◆ GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const

inlineinherited

Get brush set for this layer.

Returns: brush.

Definition at line 309 of file mathplot.h.

References m_brush.

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const

inlineinherited

Gets the 'continuity' property of the layer.

See also: SetContinuity

Definition at line 274 of file mathplot.h.

References m_continuous.

◆ GetCoords()

const wxRealPoint & CURSOR::GetCoords ( ) const

inline

Definition at line 100 of file sim_plot_tab.h.

References m_coords.

Referenced by SIMULATOR_FRAME_UI::onCursorsGridCellChanged(), and SIMULATOR_FRAME_UI::updatePlotCursors().

◆ GetDisplayName()

const wxString & mpLayer::GetDisplayName ( ) const

inlineinherited

Definition at line 251 of file mathplot.h.

References m_displayName, and m_name.

Referenced by mpInfoLegend::Plot().

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const

inlineinherited

Get font set for this layer.

Returns: Font

Definition at line 259 of file mathplot.h.

References m_font.

Referenced by SMITH_CURSOR::Plot().

◆ getID()

wxString CURSOR::getID ( )

protected

Definition at line 1080 of file sim_plot_tab.cpp.

References _, cursor, and m_trace.

Referenced by Plot(), and SMITH_CURSOR::Plot().

◆ GetLayerType()

mpLayerType mpLayer::GetLayerType ( ) const

inlineinherited

Get layer type: a Layer can be of different types: plot lines, axis, info boxes, etc, this method returns the right value.

Returns: An integer indicating layer type

Definition at line 297 of file mathplot.h.

References m_type.

Referenced by mpInfoLegend::Plot().

◆ GetMaxX()

virtual double mpLayer::GetMaxX ( ) const

inlinevirtualinherited

Get inclusive right border of bounding box.

Returns: Value

Reimplemented in mpFXYVector.

Definition at line 191 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetMaxY()

virtual double mpLayer::GetMaxY ( ) const

inlinevirtualinherited

Get inclusive top border of bounding box.

Returns: Value

Reimplemented in mpFXYVector.

Definition at line 201 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetMinX()

virtual double mpLayer::GetMinX ( ) const

inlinevirtualinherited

Get inclusive left border of bounding box.

Returns: Value

Reimplemented in mpFXYVector.

Definition at line 186 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetMinY()

virtual double mpLayer::GetMinY ( ) const

inlinevirtualinherited

Get inclusive bottom border of bounding box.

Returns: Value

Reimplemented in mpFXYVector.

Definition at line 196 of file mathplot.h.

Referenced by mpFXY::UpdateScales().

◆ GetName()

const wxString & mpLayer::GetName ( ) const

inlineinherited

Get layer name.

Returns: Name

Definition at line 249 of file mathplot.h.

References m_name.

Referenced by SIMULATOR_FRAME_UI::ToggleSmithChart(), SIMULATOR_FRAME_UI::updatePlotCursors(), and SIM_PLOT_TAB::UpdateTraceStyle().

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const

inlineinherited

Get pen set for this layer.

Returns: Pen

Definition at line 264 of file mathplot.h.

References m_pen.

Referenced by CURSOR::Plot(), mpInfoLegend::Plot(), SMITH_CURSOR::Plot(), and SIMULATOR_FRAME_UI::rebuildSignalsGrid().

◆ GetPosition()

wxPoint mpInfoLayer::GetPosition ( ) const

inherited

Returns the position of the upper left corner of the box (in pixels)

Returns: The rectangle position

Definition at line 198 of file mathplot.cpp.

References m_dim.

◆ GetSize()

wxSize mpInfoLayer::GetSize ( ) const

inherited

Returns the size of the box (in pixels)

Returns: The rectangle size

Definition at line 204 of file mathplot.cpp.

References m_dim.

◆ HasBBox()

virtual bool mpInfoLayer::HasBBox ( ) const

inlineoverridevirtualinherited

mpInfoLayer has not bounding box.

See also: mpLayer::HasBBox

Returns: always false

Reimplemented from mpLayer.

Definition at line 355 of file mathplot.h.

◆ Inside()

bool CURSOR::Inside ( const wxPoint & point ) const

overridevirtual

Checks whether a point is inside the info box rectangle.

Parameters

point The point to be checked

Returns: true if the point is inside the bounding box

Reimplemented from mpInfoLayer.

Reimplemented in SMITH_CURSOR.

Definition at line 1214 of file sim_plot_tab.cpp.

References std::abs(), DRAG_MARGIN, m_coords, m_trace, and m_window.

Referenced by OnDoubleClick().

◆ IsInfo()

virtual bool mpInfoLayer::IsInfo ( ) const

inlineoverridevirtualinherited

Specifies that this is an Info box layer.

Returns: always true

See also: mpLayer::IsInfo

Reimplemented from mpLayer.

Definition at line 366 of file mathplot.h.

◆ IsVisible()

bool mpLayer::IsVisible ( ) const

inlineinherited

Checks whether the layer is visible or not.

Returns: true if visible

Definition at line 301 of file mathplot.h.

References m_visible.

Referenced by mpWindow::IsLayerVisible(), and mpInfoLegend::Plot().

◆ Move()

void CURSOR::Move ( wxPoint delta )

overridevirtual

Moves the layer rectangle of given pixel deltas.

Parameters

delta The wxPoint container for delta coordinates along x and y. Units are in pixels.

Reimplemented from mpInfoLayer.

Reimplemented in SMITH_CURSOR.

Definition at line 903 of file sim_plot_tab.cpp.

References mpInfoLayer::m_reference, m_snapTargetY, m_snapToNearest, m_trace, m_window, mpInfoLayer::Move(), and Update().

Referenced by SetX().

◆ OnDoubleClick()

bool CURSOR::OnDoubleClick	(	const wxPoint &	aPoint,
		mpWindow &	aWindow )

overridevirtual

Reimplemented from mpInfoLayer.

Definition at line 921 of file sim_plot_tab.cpp.

References Inside(), m_sweepIndex, m_trace, m_updateRef, m_window, and Update().

◆ Plot()

void CURSOR::Plot	(	wxDC &	dc,
		mpWindow &	w )

overridevirtual

Plot method.

Can be overridden by derived classes.

Parameters

dc	the device content where to plot
w	the window to plot

See also: mpLayer::Plot

Reimplemented from mpInfoLayer.

Reimplemented in SMITH_CURSOR.

Definition at line 1092 of file sim_plot_tab.cpp.

References _, KIGFX::COLOR4D::Distance(), doSetCoordX(), getID(), mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), mpLayer::GetPen(), mpWindow::GetScrX(), mpWindow::GetScrY(), KIGFX::COLOR4D::Invert(), mpLayer::m_continuous, m_coords, mpInfoLayer::m_dim, m_sweepIndex, m_trace, m_updateRef, m_updateRequired, mpLayer::m_visible, m_window, KIGFX::COLOR4D::Mix(), mpWindow::p2x(), KIGFX::COLOR4D::ToColour(), UpdateReference(), mpWindow::x2p(), and mpWindow::y2p().

◆ SetBrush()

void mpLayer::SetBrush ( const wxBrush & brush )

inlineinherited

Set layer brush.

Parameters

brush brush, will be copied to internal class member

Definition at line 313 of file mathplot.h.

References m_brush.

◆ SetContinuity()

void mpLayer::SetContinuity ( bool continuity )

inlineinherited

Set the 'continuity' property of the layer (true:draws a continuous line, false:draws separate points).

See also: GetContinuity

Definition at line 269 of file mathplot.h.

References m_continuous.

Referenced by TRACE::TRACE().

◆ SetCoordX()

void CURSOR::SetCoordX ( double aValue )

virtual

Reimplemented in SMITH_CURSOR.

Definition at line 884 of file sim_plot_tab.cpp.

References delta, doSetCoordX(), m_coords, m_trace, m_updateRef, m_updateRequired, m_window, and mpInfoLayer::Move().

Referenced by SIMULATOR_FRAME_UI::onCursorsGridCellChanged().

◆ SetFont()

void mpLayer::SetFont ( const wxFont & font )

inlineinherited

Set layer font.

Parameters

font	Font, will be copied to internal class member

Definition at line 288 of file mathplot.h.

References m_font.

Referenced by mpLayer(), mpScaleXBase::mpScaleXBase(), and mpScaleY::mpScaleY().

◆ SetName()

virtual void mpLayer::SetName ( const wxString & name )

inlinevirtualinherited

Set layer name.

Parameters

name	Name, will be copied to internal class member

Reimplemented in TRACE.

Definition at line 283 of file mathplot.h.

References m_name, and name.

Referenced by mpFX::mpFX(), mpFXY::mpFXY(), mpFY::mpFY(), mpScaleXBase::mpScaleXBase(), mpScaleY::mpScaleY(), and TRACE::SetName().

◆ SetPen()

void mpLayer::SetPen ( const wxPen & pen )

inlineinherited

Set layer pen.

Parameters

pen	Pen, will be copied to internal class member

Definition at line 293 of file mathplot.h.

References m_pen.

Referenced by mpLayer(), mpScaleXBase::mpScaleXBase(), mpScaleY::mpScaleY(), mpInfoLegend::Plot(), and SIM_PLOT_TAB::UpdateTraceStyle().

◆ SetVisible()

void mpLayer::SetVisible ( bool show )

inlineinherited

Sets layer visibility.

Parameters

show	visibility bool.

Definition at line 305 of file mathplot.h.

References m_visible.

◆ SetX()

void CURSOR::SetX ( int aX )

inline

Definition at line 80 of file sim_plot_tab.h.

References mpInfoLayer::m_reference, m_updateRef, and Move().

◆ ShowName()

void mpLayer::ShowName ( bool show )

inlineinherited

Shows or hides the text label with the name of the layer (default is visible).

Definition at line 278 of file mathplot.h.

References m_showName.

Referenced by TRACE::TRACE().

◆ Update()

void CURSOR::Update ( )

inline

Definition at line 87 of file sim_plot_tab.h.

References m_updateRequired.

Referenced by Move(), SMITH_CURSOR::Move(), and OnDoubleClick().

◆ UpdateReference()

void CURSOR::UpdateReference ( )

overridevirtual

Updates the rectangle reference point.

Used by internal methods of mpWindow to correctly move mpInfoLayers.

Reimplemented from mpInfoLayer.

Reimplemented in SMITH_CURSOR.

Definition at line 1229 of file sim_plot_tab.cpp.

References m_coords, mpInfoLayer::m_reference, m_trace, and m_window.

Referenced by Plot().

Member Data Documentation

◆ DRAG_MARGIN

int CURSOR::DRAG_MARGIN = 10

staticconstexprprotected

Definition at line 123 of file sim_plot_tab.h.

Referenced by CURSOR(), Inside(), and SMITH_CURSOR::Inside().

◆ m_brush

wxBrush mpInfoLayer::m_brush

protectedinherited

Definition at line 394 of file mathplot.h.

Referenced by mpInfoLayer(), mpInfoLayer(), Plot(), and mpInfoLegend::Plot().

◆ m_continuous

bool mpLayer::m_continuous

protectedinherited

Definition at line 322 of file mathplot.h.

Referenced by GetContinuity(), mpLayer(), CURSOR::Plot(), mpFXY::Plot(), and SetContinuity().

◆ m_coords

wxRealPoint CURSOR::m_coords

protected

Definition at line 117 of file sim_plot_tab.h.

Referenced by CURSOR(), doSetCoordX(), GetCoords(), Inside(), Plot(), SMITH_CURSOR::Plot(), SetCoordX(), SMITH_CURSOR::SetCoordX(), SMITH_CURSOR::snapToIndex(), and UpdateReference().

◆ m_dim

wxRect mpInfoLayer::m_dim

protectedinherited

Definition at line 391 of file mathplot.h.

Referenced by GetPosition(), GetSize(), Inside(), Move(), mpInfoLayer(), mpInfoLayer(), CURSOR::Plot(), Plot(), mpInfoLegend::Plot(), SMITH_CURSOR::Plot(), and UpdateReference().

◆ m_displayName

wxString mpLayer::m_displayName

protectedinherited

Definition at line 321 of file mathplot.h.

Referenced by GetDisplayName(), and TRACE::SetName().

◆ m_font

wxFont mpLayer::m_font

protectedinherited

Definition at line 317 of file mathplot.h.

Referenced by GetFont(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpInfoLegend::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), SMITH_GRID::Plot(), and SetFont().

◆ m_name

wxString mpLayer::m_name

protectedinherited

Definition at line 320 of file mathplot.h.

Referenced by GetDisplayName(), GetName(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), and SetName().

◆ m_pen

wxPen mpLayer::m_pen

protectedinherited

Definition at line 318 of file mathplot.h.

Referenced by GetPen(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), SMITH_GRID::Plot(), SMITH_TRACE::Plot(), and SetPen().

◆ m_reference

wxPoint mpInfoLayer::m_reference

protectedinherited

Definition at line 393 of file mathplot.h.

Referenced by CURSOR::Move(), Move(), mpInfoLayer(), mpInfoLayer(), CURSOR::SetX(), CURSOR::UpdateReference(), and UpdateReference().

◆ m_showName

bool mpLayer::m_showName

protectedinherited

Definition at line 323 of file mathplot.h.

Referenced by mpLayer(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), and ShowName().

◆ m_snapTargetY

double CURSOR::m_snapTargetY

protected

Definition at line 121 of file sim_plot_tab.h.

Referenced by CURSOR(), doSetCoordX(), and Move().

◆ m_snapToNearest

bool CURSOR::m_snapToNearest

protected

Definition at line 120 of file sim_plot_tab.h.

Referenced by CURSOR(), doSetCoordX(), and Move().

◆ m_sweepIndex

int CURSOR::m_sweepIndex

protected

Definition at line 119 of file sim_plot_tab.h.

Referenced by CURSOR(), doSetCoordX(), OnDoubleClick(), and Plot().

◆ m_trace

TRACE* CURSOR::m_trace

protected

Definition at line 114 of file sim_plot_tab.h.

Referenced by CURSOR(), doSetCoordX(), getID(), Inside(), Move(), OnDoubleClick(), Plot(), SMITH_CURSOR::Plot(), SetCoordX(), SMITH_CURSOR::SetCoordX(), SMITH_CURSOR::snapToFrequency(), SMITH_CURSOR::snapToIndex(), and UpdateReference().

◆ m_type

mpLayerType mpLayer::m_type

protectedinherited

Definition at line 324 of file mathplot.h.

Referenced by GetLayerType(), mpFX::mpFX(), mpFXY::mpFXY(), mpFXYVector::mpFXYVector(), mpFY::mpFY(), mpInfoLayer::mpInfoLayer(), mpInfoLayer::mpInfoLayer(), mpLayer(), mpScaleXBase::mpScaleXBase(), mpScaleY::mpScaleY(), and SMITH_GRID::SMITH_GRID().

◆ m_updateRef

bool CURSOR::m_updateRef

protected

Definition at line 116 of file sim_plot_tab.h.

Referenced by CURSOR(), OnDoubleClick(), Plot(), SMITH_CURSOR::Plot(), SetCoordX(), SMITH_CURSOR::SetCoordX(), and SetX().

◆ m_updateRequired

bool CURSOR::m_updateRequired

protected

Definition at line 115 of file sim_plot_tab.h.

Referenced by CURSOR(), Plot(), SMITH_CURSOR::Plot(), SetCoordX(), SMITH_CURSOR::SetCoordX(), and Update().

◆ m_visible

bool mpLayer::m_visible

protectedinherited

Definition at line 325 of file mathplot.h.

Referenced by IsVisible(), mpLayer(), CURSOR::Plot(), mpFX::Plot(), mpFXY::Plot(), mpFY::Plot(), mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpScaleXBase::Plot(), mpScaleY::Plot(), SMITH_CURSOR::Plot(), SMITH_GRID::Plot(), SMITH_TRACE::Plot(), and SetVisible().

◆ m_window

mpWindow* CURSOR::m_window

protected

Definition at line 118 of file sim_plot_tab.h.

Referenced by CURSOR(), Inside(), SMITH_CURSOR::Inside(), Move(), OnDoubleClick(), Plot(), SMITH_CURSOR::Plot(), SetCoordX(), SMITH_CURSOR::SetCoordX(), and UpdateReference().

◆ m_winX

int mpInfoLayer::m_winX

protectedinherited

Definition at line 395 of file mathplot.h.

Referenced by mpInfoLayer(), mpInfoLayer(), Plot(), and mpInfoLegend::Plot().

◆ m_winY

int mpInfoLayer::m_winY

protectedinherited

Definition at line 396 of file mathplot.h.

Referenced by mpInfoLayer(), mpInfoLayer(), Plot(), and mpInfoLegend::Plot().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CURSOR()

Member Function Documentation

◆ doSetCoordX()

◆ GetBrush()

◆ GetContinuity()

◆ GetCoords()

◆ GetDisplayName()

◆ GetFont()

◆ getID()

◆ GetLayerType()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetPen()

◆ GetPosition()

◆ GetSize()

◆ HasBBox()

◆ Inside()

◆ IsInfo()

◆ IsVisible()

◆ Move()

◆ OnDoubleClick()

◆ Plot()

◆ SetBrush()

◆ SetContinuity()

◆ SetCoordX()

◆ SetFont()

◆ SetName()

◆ SetPen()

◆ SetVisible()

◆ SetX()

◆ ShowName()

◆ Update()

◆ UpdateReference()

Member Data Documentation

◆ DRAG_MARGIN

◆ m_brush

◆ m_continuous

◆ m_coords

◆ m_dim

◆ m_displayName

◆ m_font

◆ m_name

◆ m_pen

◆ m_reference

◆ m_showName

◆ m_snapTargetY

◆ m_snapToNearest

◆ m_sweepIndex

◆ m_trace

◆ m_type

◆ m_updateRef

◆ m_updateRequired

◆ m_visible

◆ m_window

◆ m_winX

◆ m_winY