mpFXYVector Class Reference

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.
void	SetSweepCount (int aSweepCount)
void	SetSweepSize (size_t aSweepSize)
void	Clear ()
	Clears all the data, leaving the layer empty.
double	GetMinX () const override
	Returns the actual minimum X data (loaded in SetData).
double	GetMinY () const override
	Returns the actual minimum Y data (loaded in SetData).
double	GetMaxX () const override
	Returns the actual maximum X data (loaded in SetData).
double	GetMaxY () const override
	Returns the actual maximum Y data (loaded in SetData).
virtual void	Plot (wxDC &dc, mpWindow &w) override
	Layer plot handler.
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.
virtual bool	IsInfo () const
	Check whether the layer is an info 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
void	Rewind () override
	Rewind value enumeration with mpFXY::GetNextXY.
void	SetSweepWindow (int aSweepIdx) override
bool	GetNextXY (double &x, double &y) override
	Get locus value for next N.
size_t	GetCount () const override
int	GetSweepCount () const override
void	UpdateViewBoundary (wxCoord xnew, wxCoord ynew)
	Update label positioning data.

Protected Attributes
std::vector< double >	m_xs
	The internal copy of the set of data to draw.
std::vector< double >	m_ys
size_t	m_index
size_t	m_sweepWindow
double	m_minX
	Loaded at SetData.
double	m_maxX
double	m_minY
double	m_maxY
int	m_sweepCount = 1
size_t	m_sweepSize = std::numeric_limits<size_t>::max()
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 1408 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 2570 of file mathplot.cpp.

References m_index, m_maxX, m_maxY, m_minX, m_minY, m_sweepWindow, mpLayer::m_type, mpFXY::mpFXY(), mpFXYVector(), mpLAYER_PLOT, and name.

Referenced by mpFXYVector(), and TRACE::TRACE().

~mpFXYVector()

virtual mpFXYVector::~mpFXYVector ( )

inlinevirtual

Definition at line 1416 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 2654 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.

References m_brush.

GetContinuity()

bool mpLayer::GetContinuity ( ) const

inlineinherited

Gets the 'continuity' property of the layer.

See also

SetContinuity

Definition at line 264 of file mathplot.h.

References m_continuous.

GetCount()

size_t mpFXYVector::GetCount ( ) const

inlineoverrideprotectedvirtual

Implements mpFXY.

Definition at line 1459 of file mathplot.h.

References m_xs.

GetDisplayName()

const wxString & mpLayer::GetDisplayName ( ) const

inlineinherited

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

References m_font.

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.

References m_type.

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

References m_maxX.

GetMaxY()

double mpFXYVector::GetMaxY ( ) const

inlineoverridevirtual

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

Reimplemented from mpLayer.

Definition at line 1477 of file mathplot.h.

References m_maxY.

GetMinX()

double mpFXYVector::GetMinX ( ) const

inlineoverridevirtual

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

Reimplemented from mpLayer.

Definition at line 1465 of file mathplot.h.

References m_minX.

GetMinY()

double mpFXYVector::GetMinY ( ) const

inlineoverridevirtual

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

Reimplemented from mpLayer.

Definition at line 1469 of file mathplot.h.

References m_minY.

GetName()

const wxString & mpLayer::GetName ( ) const

inlineinherited

Get layer name.

Returns

Name

Definition at line 239 of file mathplot.h.

References m_name.

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

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 2639 of file mathplot.cpp.

References m_index, m_sweepWindow, 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.

References m_pen.

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

GetSweepCount()

int mpFXYVector::GetSweepCount ( ) const

inlineoverrideprotectedvirtual

Reimplemented from mpFXY.

Definition at line 1460 of file mathplot.h.

References m_sweepCount.

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.

References m_visible.

Referenced by mpWindow::IsLayerVisible(), 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 445 of file mathplot.cpp.

References GetCount(), mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), GetNextXY(), mpWindow::GetScrX(), mpWindow::GetScrY(), GetSweepCount(), mpLayer::m_continuous, m_flags, mpLayer::m_font, mpLayer::m_name, mpLayer::m_pen, m_scaleX, m_scaleY, mpLayer::m_showName, mpLayer::m_visible, maxDrawX, maxDrawY, minDrawX, minDrawY, mpALIGN_NE, mpALIGN_NW, mpALIGN_SE, mpALIGNMASK, Rewind(), SetSweepWindow(), 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 2625 of file mathplot.cpp.

References m_index, and m_sweepWindow.

s2x()

double mpFXY::s2x ( double plotCoordX ) const

inherited

Definition at line 2726 of file mathplot.cpp.

References m_scaleX.

s2y()

double mpFXY::s2y ( double plotCoordY ) const

inherited

Definition at line 2732 of file mathplot.cpp.

References m_scaleY.

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.

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

References m_continuous.

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

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

References m_pen.

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

SetScale()

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

virtualinherited

Definition at line 2707 of file mathplot.cpp.

References m_scaleX, m_scaleY, and UpdateScales().

Referenced by SIM_PLOT_TAB::SetTraceData().

SetSweepCount()

void mpFXYVector::SetSweepCount ( int aSweepCount )

inline

Definition at line 1424 of file mathplot.h.

References m_sweepCount.

Referenced by SIM_PLOT_TAB::SetTraceData().

SetSweepSize()

void mpFXYVector::SetSweepSize ( size_t aSweepSize )

inline

Definition at line 1425 of file mathplot.h.

References m_sweepSize.

Referenced by SIM_PLOT_TAB::SetTraceData().

SetSweepWindow()

void mpFXYVector::SetSweepWindow ( int aSweepIdx )

overrideprotectedvirtual

Reimplemented from mpFXY.

Definition at line 2632 of file mathplot.cpp.

References m_index, m_sweepSize, and m_sweepWindow.

SetVisible()

void mpLayer::SetVisible ( bool show )

inlineinherited

Sets layer visibility.

Parameters

show	visibility bool.

Definition at line 295 of file mathplot.h.

References m_visible.

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.

References m_showName.

Referenced by TRACE::TRACE().

UpdateScales()

void mpFXY::UpdateScales ( )

inherited

Definition at line 2716 of file mathplot.cpp.

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

Referenced by 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 434 of file mathplot.cpp.

References maxDrawX, maxDrawY, minDrawX, and minDrawY.

Referenced by Plot().

x2s()

double mpFXY::x2s ( double x ) const

inherited

Definition at line 2738 of file mathplot.cpp.

References m_scaleX.

y2s()

double mpFXY::y2s ( double y ) const

inherited

Definition at line 2744 of file mathplot.cpp.

References m_scaleY.

Member Data Documentation

m_brush

wxBrush mpLayer::m_brush

protectedinherited

Definition at line 309 of file mathplot.h.

Referenced by GetBrush(), and SetBrush().

m_continuous

bool mpLayer::m_continuous

protectedinherited

Definition at line 312 of file mathplot.h.

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

m_displayName

wxString mpLayer::m_displayName

protectedinherited

Definition at line 311 of file mathplot.h.

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

m_flags

int mpFXY::m_flags

protectedinherited

Definition at line 582 of file mathplot.h.

Referenced by mpFXY(), and Plot().

m_font

wxFont mpLayer::m_font

protectedinherited

Definition at line 307 of file mathplot.h.

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

m_index

size_t mpFXYVector::m_index

protected

Definition at line 1437 of file mathplot.h.

Referenced by GetNextXY(), mpFXYVector(), Rewind(), and SetSweepWindow().

m_maxX

double mpFXYVector::m_maxX

protected

Definition at line 1442 of file mathplot.h.

Referenced by GetMaxX(), mpFXYVector(), and SetData().

m_maxY

double mpFXYVector::m_maxY

protected

Definition at line 1442 of file mathplot.h.

Referenced by GetMaxY(), mpFXYVector(), and SetData().

m_minX

double mpFXYVector::m_minX

protected

Loaded at SetData.

Definition at line 1442 of file mathplot.h.

Referenced by GetMinX(), mpFXYVector(), and SetData().

m_minY

double mpFXYVector::m_minY

protected

Definition at line 1442 of file mathplot.h.

Referenced by GetMinY(), mpFXYVector(), and SetData().

m_name

wxString mpLayer::m_name

protectedinherited

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

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

m_scaleX

mpScaleBase* mpFXY::m_scaleX

protectedinherited

Definition at line 587 of file mathplot.h.

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

m_scaleY

mpScaleBase * mpFXY::m_scaleY

protectedinherited

Definition at line 587 of file mathplot.h.

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

m_showName

bool mpLayer::m_showName

protectedinherited

Definition at line 313 of file mathplot.h.

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

m_sweepCount

int mpFXYVector::m_sweepCount = 1

protected

Definition at line 1443 of file mathplot.h.

Referenced by GetSweepCount(), and SetSweepCount().

m_sweepSize

size_t mpFXYVector::m_sweepSize = std::numeric_limits<size_t>::max()

protected

Definition at line 1444 of file mathplot.h.

Referenced by SetSweepSize(), and SetSweepWindow().

m_sweepWindow

size_t mpFXYVector::m_sweepWindow

protected

Definition at line 1438 of file mathplot.h.

Referenced by GetNextXY(), mpFXYVector(), Rewind(), and SetSweepWindow().

m_type

mpLayerType mpLayer::m_type

protectedinherited

Definition at line 314 of file mathplot.h.

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

m_visible

bool mpLayer::m_visible

protectedinherited

Definition at line 315 of file mathplot.h.

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

m_xs

std::vector<double> mpFXYVector::m_xs

protected

The internal copy of the set of data to draw.

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

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

maxDrawX

wxCoord mpFXY::maxDrawX

protectedinherited

Definition at line 585 of file mathplot.h.

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

maxDrawY

wxCoord mpFXY::maxDrawY

protectedinherited

Definition at line 585 of file mathplot.h.

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

minDrawX

wxCoord mpFXY::minDrawX

protectedinherited

Definition at line 585 of file mathplot.h.

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

minDrawY

wxCoord mpFXY::minDrawY

protectedinherited

Definition at line 585 of file mathplot.h.

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

---

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

• mathplot.h
• mathplot.cpp