Abstract base class providing plot and labeling functionality for functions F:Y->X. More...

#include <mathplot.h>

Inheritance diagram for mpFY:

Public Member Functions
	mpFY (const wxString &name=wxEmptyString, int flags=mpALIGN_TOP)

virtual double	GetX (double y) const =0
	Get function value for argument.

virtual void	Plot (wxDC &dc, mpWindow &w) override
	Layer plot handler.

virtual bool	HasBBox () const
	Check whether this layer has a bounding box.

virtual bool	IsInfo () const
	Check whether the layer is an info box.

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 wxFont &	GetPlotFont () const
	Get the font to draw this layer with, which is the default one when none was set.

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 Attributes
int	m_flags

wxFont	m_font

wxPen	m_pen

wxBrush	m_brush

wxString	m_name

wxString	m_displayName

bool	m_continuous

bool	m_showName

mpLayerType	m_type

bool	m_visible

Detailed Description

Abstract base class providing plot and labeling functionality for functions F:Y->X.

Override mpFY::GetX to implement a function. Optionally implement a constructor and pass a name (label) and a label alignment to the constructor mpFY::mpFY. If the layer name is empty, no label will be plotted.

Definition at line 535 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpFY()

mpFY::mpFY	(	const wxString &	name = wxEmptyString,
		int	flags = mpALIGN_TOP )

Parameters

name	Label
flags	Label alignment, pass one of mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP.

Definition at line 392 of file mathplot.cpp.

References m_flags, mpLayer::m_type, mpFY(), mpLAYER_PLOT, name, and mpLayer::SetName().

Referenced by mpFY().

Member Function Documentation

◆ GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const

inlineinherited

Get brush set for this layer.

Returns: brush.

Definition at line 325 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 290 of file mathplot.h.

References m_continuous.

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

Invalid if none was set.

Returns: Font

Definition at line 259 of file mathplot.h.

References m_font.

Referenced by BOOST_AUTO_TEST_CASE().

◆ 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 313 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 280 of file mathplot.h.

References m_pen.

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

◆ GetPlotFont()

const wxFont & mpLayer::GetPlotFont ( ) const

inlineinherited

Get the font to draw this layer with, which is the default one when none was set.

The stock fonts are built on first use from the running toolkit, so this must not be called before there is one; layers resolve their font when they plot, not when they are constructed.

Returns: Font

Definition at line 269 of file mathplot.h.

References m_font.

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

◆ GetX()

virtual double mpFY::GetX ( double y ) const

pure virtual

Get function value for argument.

Override this function in your implementation.

Parameters

y Argument

Returns: Function value

References Plot().

Referenced by Plot().

◆ HasBBox()

virtual bool mpLayer::HasBBox ( ) const

inlinevirtualinherited

Check whether this layer has a bounding box.

The default implementation returns true. Override and return false if your mpLayer implementation should be ignored by the calculation of the global bounding box for all layers in a mpWindow.

Return values

true	Has bounding box
false	Has not bounding box

Reimplemented in mpInfoLayer, mpScaleBase, mpScaleY, SMITH_GRID, and SMITH_TRACE.

Definition at line 172 of file mathplot.h.

◆ IsInfo()

virtual bool mpLayer::IsInfo ( ) const

inlinevirtualinherited

Check whether the layer is an info box.

The default implementation returns false. It is overridden to true for mpInfoLayer class and its derivative. It is necessary to define mouse actions behaviour over info boxes.

Returns: whether the layer is an info boxes

See also: mpInfoLayer::IsInfo

Reimplemented in mpInfoLayer.

Definition at line 181 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 317 of file mathplot.h.

References m_visible.

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

◆ Plot()

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

overridevirtual

Layer plot handler.

This implementation will plot the function in the visible area and put a label according to the alignment specified.

Implements mpLayer.

Definition at line 400 of file mathplot.cpp.

References mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), mpLayer::GetPlotFont(), mpWindow::GetScrX(), mpWindow::GetScrY(), GetX(), m_flags, mpLayer::m_name, mpLayer::m_pen, mpLayer::m_showName, mpLayer::m_visible, mpALIGN_CENTER, mpALIGN_TOP, mpALIGNMASK, mpWindow::p2y(), and mpWindow::x2p().

Referenced by GetX().

◆ SetBrush()

void mpLayer::SetBrush ( const wxBrush & brush )

inlineinherited

Set layer brush.

Parameters

brush brush, will be copied to internal class member

Definition at line 329 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 285 of file mathplot.h.

References m_continuous.

Referenced by TRACE::TRACE().

◆ SetFont()

void mpLayer::SetFont ( const wxFont & font )

inlineinherited

Set layer font.

Parameters

font	Font, will be copied to internal class member

Definition at line 304 of file mathplot.h.

References m_font.

Referenced by BOOST_AUTO_TEST_CASE().

◆ 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 299 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 309 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 321 of file mathplot.h.

References m_visible.

Referenced by SIM_PLOT_TAB::AddView().

◆ 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 294 of file mathplot.h.

References m_showName.

Referenced by TRACE::TRACE().

Member Data Documentation

◆ m_brush

wxBrush mpLayer::m_brush

protectedinherited

Definition at line 335 of file mathplot.h.

Referenced by GetBrush(), and SetBrush().

◆ m_continuous

bool mpLayer::m_continuous

protectedinherited

Definition at line 338 of file mathplot.h.

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

◆ m_displayName

wxString mpLayer::m_displayName

protectedinherited

Definition at line 337 of file mathplot.h.

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

◆ m_flags

int mpFY::m_flags

protected

Definition at line 557 of file mathplot.h.

Referenced by mpFY(), and Plot().

◆ m_font

wxFont mpLayer::m_font

protectedinherited

Definition at line 333 of file mathplot.h.

Referenced by GetFont(), GetPlotFont(), and SetFont().

◆ m_name

wxString mpLayer::m_name

protectedinherited

Definition at line 336 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 334 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_showName

bool mpLayer::m_showName

protectedinherited

Definition at line 339 of file mathplot.h.

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

◆ m_type

mpLayerType mpLayer::m_type

protectedinherited

Definition at line 340 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_visible

bool mpLayer::m_visible

protectedinherited

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mpFY()

Member Function Documentation

◆ GetBrush()

◆ GetContinuity()

◆ GetDisplayName()

◆ GetFont()

◆ GetLayerType()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetPen()

◆ GetPlotFont()

◆ GetX()

◆ HasBBox()

◆ IsInfo()

◆ IsVisible()

◆ Plot()

◆ SetBrush()

◆ SetContinuity()

◆ SetFont()

◆ SetName()

◆ SetPen()

◆ SetVisible()

◆ ShowName()

Member Data Documentation

◆ m_brush

◆ m_continuous

◆ m_displayName

◆ m_flags

◆ m_font

◆ m_name

◆ m_pen

◆ m_showName

◆ m_type

◆ m_visible