A class providing graphs functionality for a 2D plot (either continuous or a set of points), from vectors of data. More...

#include <mathplot.h>

Inheritance diagram for mpFXYVector:

Public Member Functions
	mpFXYVector (const wxString &name=wxEmptyString, int flags=mpALIGN_NE)

virtual	~mpFXYVector ()

virtual void	SetData (const std::vector< double > &xs, const std::vector< double > &ys)
	Changes the internal data: the set of points to draw. More...

void	Clear ()
	Clears all the data, leaving the layer empty. More...

double	GetMinX () const override
	Returns the actual minimum X data (loaded in SetData). More...

double	GetMinY () const override
	Returns the actual minimum Y data (loaded in SetData). More...

double	GetMaxX () const override
	Returns the actual maximum X data (loaded in SetData). More...

double	GetMaxY () const override
	Returns the actual maximum Y data (loaded in SetData). More...

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

virtual void	SetScale (mpScaleBase scaleX, mpScaleBase scaleY)

void	UpdateScales ()

double	s2x (double plotCoordX) const

double	s2y (double plotCoordY) const

double	x2s (double x) const

double	y2s (double y) const

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

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

const wxString &	GetName () const
	Get layer name. More...

const wxString &	GetDisplayName () const

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

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

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

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

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

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

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

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

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

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

void	SetVisible (bool show)
	Sets layer visibility. More...

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

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

Protected Member Functions
void	Rewind () override
	Rewind value enumeration with mpFXY::GetNextXY. More...

bool	GetNextXY (double &x, double &y) override
	Get locus value for next N. More...

size_t	GetCount () const override

void	UpdateViewBoundary (wxCoord xnew, wxCoord ynew)
	Update label positioning data. More...

Protected Attributes
std::vector< double >	m_xs
	The internal copy of the set of data to draw. More...

std::vector< double >	m_ys

size_t	m_index
	The internal counter for the "GetNextXY" interface. More...

double	m_minX
	Loaded at SetData. More...

double	m_maxX

double	m_minY

double	m_maxY

int	m_flags

wxCoord	maxDrawX

wxCoord	minDrawX

wxCoord	maxDrawY

wxCoord	minDrawY

mpScaleBase *	m_scaleX

mpScaleBase *	m_scaleY

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

A class providing graphs functionality for a 2D plot (either continuous or a set of points), from vectors of data.

This class can be used directly, the user does not need to derive any new class. Simply pass the data as two vectors with the same length containing the X and Y coordinates to the method SetData.

To generate a graph with a set of points, call

layerVar->SetContinuity(false)

or

layerVar->SetContinuity(true)

to render the sequence of coordinates as a continuous line.

(Added: Jose Luis Blanco, AGO-2007)

Definition at line 1361 of file mathplot.h.

Constructor & Destructor Documentation

◆ mpFXYVector()

mpFXYVector::mpFXYVector	(	const wxString &	name = `wxEmptyString`,
		int	flags = `mpALIGN_NE`
	)

Parameters

name	Label
flags	Label alignment, pass one of mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE.

Definition at line 2349 of file mathplot.cpp.

References mpLAYER_PLOT.

◆ ~mpFXYVector()

virtual mpFXYVector::~mpFXYVector ( )

inlinevirtual

Definition at line 1369 of file mathplot.h.

Member Function Documentation

◆ Clear()

void mpFXYVector::Clear ( )

Clears all the data, leaving the layer empty.

See also: SetData

Definition at line 2430 of file mathplot.cpp.

References m_xs, and m_ys.

◆ GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const

inlineinherited

Get brush set for this layer.

Returns: brush.

Definition at line 299 of file mathplot.h.

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const

inlineinherited

Gets the 'continuity' property of the layer.

See also: SetContinuity

Definition at line 264 of file mathplot.h.

◆ GetCount()

size_t mpFXYVector::GetCount ( ) const

overrideprotectedvirtual

Implements mpFXY.

Definition at line 2409 of file mathplot.cpp.

References m_xs.

◆ GetDisplayName()

const wxString & mpLayer::GetDisplayName ( ) const

inlineinherited

Definition at line 241 of file mathplot.h.

Referenced by mpInfoLegend::Plot().

◆ GetFont()

const wxFont & mpLayer::GetFont ( ) const

inlineinherited

Get font set for this layer.

Returns: Font

Definition at line 249 of file mathplot.h.

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

Referenced by mpInfoLegend::Plot().

◆ GetMaxX()

double mpFXYVector::GetMaxX ( ) const

inlineoverridevirtual

Returns the actual maximum X data (loaded in SetData).

Reimplemented from mpLayer.

Definition at line 1420 of file mathplot.h.

◆ GetMaxY()

double mpFXYVector::GetMaxY ( ) const

inlineoverridevirtual

Returns the actual maximum Y data (loaded in SetData).

Reimplemented from mpLayer.

Definition at line 1424 of file mathplot.h.

◆ GetMinX()

double mpFXYVector::GetMinX ( ) const

inlineoverridevirtual

Returns the actual minimum X data (loaded in SetData).

Reimplemented from mpLayer.

Definition at line 1412 of file mathplot.h.

◆ GetMinY()

double mpFXYVector::GetMinY ( ) const

inlineoverridevirtual

Returns the actual minimum Y data (loaded in SetData).

Reimplemented from mpLayer.

Definition at line 1416 of file mathplot.h.

◆ GetName()

const wxString & mpLayer::GetName ( ) const

inlineinherited

Get layer name.

Returns: Name

Definition at line 239 of file mathplot.h.

Referenced by SIM_PLOT_TAB::GetLabelX(), SIM_PLOT_TAB::GetLabelY1(), SIM_PLOT_TAB::GetLabelY2(), SIM_PLOT_TAB::GetLabelY3(), and SIMULATOR_FRAME_UI::updatePlotCursors().

◆ GetNextXY()

bool mpFXYVector::GetNextXY	(	double &	x,
		double &	y
	)

overrideprotectedvirtual

Get locus value for next N.

Overridden in this implementation.

Parameters

x	Returns X value
y	Returns Y value

Implements mpFXY.

Definition at line 2415 of file mathplot.cpp.

References m_index, m_xs, and m_ys.

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const

inlineinherited

Get pen set for this layer.

Returns: Pen

Definition at line 254 of file mathplot.h.

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

◆ 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, and mpScaleY.

Definition at line 162 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 171 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 291 of file mathplot.h.

Referenced by SIM_PLOT_TAB::IsLegendShown(), and mpInfoLegend::Plot().

◆ Plot()

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

overridevirtualinherited

Layer plot handler.

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

Implements mpLayer.

Definition at line 439 of file mathplot.cpp.

References mpFXY::GetCount(), mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), mpFXY::GetNextXY(), mpWindow::GetScrX(), mpWindow::GetScrY(), mpLayer::m_continuous, mpFXY::m_flags, mpLayer::m_font, mpLayer::m_name, mpLayer::m_pen, mpFXY::m_scaleX, mpFXY::m_scaleY, mpLayer::m_showName, mpLayer::m_visible, mpFXY::maxDrawX, mpFXY::maxDrawY, mpFXY::minDrawX, mpFXY::minDrawY, mpALIGN_NE, mpALIGN_NW, mpALIGN_SE, mpALIGNMASK, mpFXY::Rewind(), mpScaleBase::TransformToPlot(), mpFXY::UpdateViewBoundary(), mpWindow::x2p(), and mpWindow::y2p().

◆ Rewind()

void mpFXYVector::Rewind ( )

overrideprotectedvirtual

Rewind value enumeration with mpFXY::GetNextXY.

Overridden in this implementation.

Implements mpFXY.

Definition at line 2403 of file mathplot.cpp.

References m_index.

◆ s2x()

double mpFXY::s2x ( double plotCoordX ) const

inherited

Definition at line 2502 of file mathplot.cpp.

References mpFXY::m_scaleX, and mpScaleBase::TransformFromPlot().

Referenced by CURSOR::Plot().

◆ s2y()

double mpFXY::s2y ( double plotCoordY ) const

inherited

Definition at line 2508 of file mathplot.cpp.

References mpFXY::m_scaleY, and mpScaleBase::TransformFromPlot().

◆ SetBrush()

void mpLayer::SetBrush ( const wxBrush & brush )

inlineinherited

Set layer brush.

Parameters

brush brush, will be copied to internal class member

Definition at line 303 of file mathplot.h.

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

Referenced by TRACE::TRACE().

◆ SetData()

void mpFXYVector::SetData	(	const std::vector< double > &	xs,
		const std::vector< double > &	ys
	)

virtual

Changes the internal data: the set of points to draw.

Both vectors MUST be of the same length. This method DOES NOT refresh the mpWindow; do it manually.

See also: Clear

Reimplemented in TRACE.

Definition at line 2437 of file mathplot.cpp.

References m_maxX, m_maxY, m_minX, m_minY, m_xs, and m_ys.

Referenced by TRACE::SetData().

◆ SetFont()

void mpLayer::SetFont ( const wxFont & font )

inlineinherited

Set layer font.

Parameters

font	Font, will be copied to internal class member

Definition at line 278 of file mathplot.h.

Referenced by SIM_PLOT_TAB::updateAxes().

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

References name.

Referenced by SIM_PLOT_TAB::prepareDCAxes(), TRACE::SetName(), and SIM_PLOT_TAB::updateAxes().

◆ SetPen()

void mpLayer::SetPen ( const wxPen & pen )

inlineinherited

Set layer pen.

Parameters

pen	Pen, will be copied to internal class member

Definition at line 283 of file mathplot.h.

Referenced by SIM_PLOT_TAB::UpdateTraceStyle().

◆ SetScale()

void mpFXY::SetScale	(	mpScaleBase *	scaleX,
		mpScaleBase *	scaleY
	)

virtualinherited

Definition at line 2483 of file mathplot.cpp.

References mpFXY::m_scaleX, mpFXY::m_scaleY, and mpFXY::UpdateScales().

Referenced by SIM_PLOT_TAB::SetTraceData().

◆ SetVisible()

void mpLayer::SetVisible ( bool show )

inlineinherited

Sets layer visibility.

Parameters

show	visibility bool.

Definition at line 295 of file mathplot.h.

Referenced by SIM_PLOT_TAB::ShowLegend(), and SIM_PLOT_TAB::SIM_PLOT_TAB().

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

Referenced by TRACE::TRACE().

◆ UpdateScales()

void mpFXY::UpdateScales ( )

inherited

Definition at line 2492 of file mathplot.cpp.

References mpScaleBase::ExtendDataRange(), mpLayer::GetMaxX(), mpLayer::GetMaxY(), mpLayer::GetMinX(), mpLayer::GetMinY(), mpFXY::m_scaleX, and mpFXY::m_scaleY.

Referenced by mpFXY::SetScale().

◆ UpdateViewBoundary()

void mpFXY::UpdateViewBoundary	(	wxCoord	xnew,
		wxCoord	ynew
	)

protectedinherited

Update label positioning data.

Parameters

xnew	New x coordinate
ynew	New y coordinate

Definition at line 428 of file mathplot.cpp.

References mpFXY::maxDrawX, mpFXY::maxDrawY, mpFXY::minDrawX, and mpFXY::minDrawY.

Referenced by mpFXY::Plot().

◆ x2s()

double mpFXY::x2s ( double x ) const

inherited

Definition at line 2514 of file mathplot.cpp.

References mpFXY::m_scaleX, and mpScaleBase::TransformToPlot().

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

◆ y2s()

double mpFXY::y2s ( double y ) const

inherited

Definition at line 2520 of file mathplot.cpp.

References mpFXY::m_scaleY, and mpScaleBase::TransformToPlot().

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

Member Data Documentation

◆ m_brush

wxBrush mpLayer::m_brush

protectedinherited

Definition at line 309 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous

protectedinherited

Definition at line 312 of file mathplot.h.

Referenced by CURSOR::Plot(), and mpFXY::Plot().

◆ m_displayName

wxString mpLayer::m_displayName

protectedinherited

Definition at line 311 of file mathplot.h.

Referenced by TRACE::SetName().

◆ m_flags

int mpFXY::m_flags

protectedinherited

Definition at line 580 of file mathplot.h.

Referenced by mpFXY::Plot().

◆ m_font

wxFont mpLayer::m_font

protectedinherited

Definition at line 307 of file mathplot.h.

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

◆ m_index

size_t mpFXYVector::m_index

protected

The internal counter for the "GetNextXY" interface.

Definition at line 1389 of file mathplot.h.

Referenced by GetNextXY(), and Rewind().

◆ m_maxX

double mpFXYVector::m_maxX

protected

Definition at line 1393 of file mathplot.h.

Referenced by SetData().

◆ m_maxY

double mpFXYVector::m_maxY

protected

Definition at line 1393 of file mathplot.h.

Referenced by SetData().

◆ m_minX

double mpFXYVector::m_minX

protected

Loaded at SetData.

Definition at line 1393 of file mathplot.h.

Referenced by SetData().

◆ m_minY

double mpFXYVector::m_minY

protected

Definition at line 1393 of file mathplot.h.

Referenced by SetData().

◆ m_name

wxString mpLayer::m_name

protectedinherited

Definition at line 310 of file mathplot.h.

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

◆ m_pen

wxPen mpLayer::m_pen

protectedinherited

Definition at line 308 of file mathplot.h.

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

◆ m_scaleX

mpScaleBase* mpFXY::m_scaleX

protectedinherited

Definition at line 585 of file mathplot.h.

Referenced by mpFXY::Plot(), mpFXY::s2x(), mpFXY::SetScale(), mpFXY::UpdateScales(), and mpFXY::x2s().

◆ m_scaleY

mpScaleBase * mpFXY::m_scaleY

protectedinherited

Definition at line 585 of file mathplot.h.

Referenced by mpFXY::Plot(), mpFXY::s2y(), mpFXY::SetScale(), mpFXY::UpdateScales(), and mpFXY::y2s().

◆ m_showName

bool mpLayer::m_showName

protectedinherited

Definition at line 313 of file mathplot.h.

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

◆ m_type

mpLayerType mpLayer::m_type

protectedinherited

Definition at line 314 of file mathplot.h.

Referenced by mpInfoLayer::mpInfoLayer().

◆ m_visible

bool mpLayer::m_visible

protectedinherited

Definition at line 315 of file mathplot.h.

Referenced by CURSOR::Plot(), mpInfoLayer::Plot(), mpInfoLegend::Plot(), mpFX::Plot(), mpFY::Plot(), mpFXY::Plot(), mpScaleXBase::Plot(), and mpScaleY::Plot().

◆ m_xs

std::vector<double> mpFXYVector::m_xs

protected

The internal copy of the set of data to draw.

Definition at line 1385 of file mathplot.h.

Referenced by Clear(), GetCount(), TRACE::GetDataX(), GetNextXY(), and SetData().

◆ m_ys

std::vector<double> mpFXYVector::m_ys

protected

Definition at line 1385 of file mathplot.h.

Referenced by Clear(), TRACE::GetDataY(), GetNextXY(), and SetData().

◆ maxDrawX

wxCoord mpFXY::maxDrawX

protectedinherited

Definition at line 583 of file mathplot.h.

Referenced by mpFXY::Plot(), and mpFXY::UpdateViewBoundary().

◆ maxDrawY

wxCoord mpFXY::maxDrawY

protectedinherited

Definition at line 583 of file mathplot.h.

Referenced by mpFXY::Plot(), and mpFXY::UpdateViewBoundary().

◆ minDrawX

wxCoord mpFXY::minDrawX

protectedinherited

Definition at line 583 of file mathplot.h.

Referenced by mpFXY::Plot(), and mpFXY::UpdateViewBoundary().

◆ minDrawY

wxCoord mpFXY::minDrawY

protectedinherited

Definition at line 583 of file mathplot.h.

Referenced by mpFXY::Plot(), and mpFXY::UpdateViewBoundary().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mpFXYVector()

◆ ~mpFXYVector()

Member Function Documentation

◆ Clear()

◆ GetBrush()

◆ GetContinuity()

◆ GetCount()

◆ GetDisplayName()

◆ GetFont()

◆ GetLayerType()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetNextXY()

◆ GetPen()

◆ HasBBox()

◆ IsInfo()

◆ IsVisible()

◆ Plot()

◆ Rewind()

◆ s2x()

◆ s2y()

◆ SetBrush()

◆ SetContinuity()

◆ SetData()

◆ SetFont()

◆ SetName()

◆ SetPen()

◆ SetScale()

◆ SetVisible()

◆ ShowName()

◆ UpdateScales()

◆ UpdateViewBoundary()

◆ x2s()

◆ y2s()

Member Data Documentation

◆ m_brush

◆ m_continuous

◆ m_displayName

◆ m_flags

◆ m_font

◆ m_index

◆ m_maxX

◆ m_maxY

◆ m_minX

◆ m_minY

◆ m_name

◆ m_pen

◆ m_scaleX

◆ m_scaleY

◆ m_showName

◆ m_type

◆ m_visible

◆ m_xs

◆ m_ys

◆ maxDrawX

◆ maxDrawY

◆ minDrawX

◆ minDrawY