KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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:
mpFXY mpLayer TRACE

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
 
mpScaleBasem_scaleX
 
mpScaleBasem_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
nameLabel
flagsLabel alignment, pass one of mpALIGN_NE, mpALIGN_NW, mpALIGN_SW, mpALIGN_SE.

Definition at line 2538 of file mathplot.cpp.

References mpLAYER_PLOT.

◆ ~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 2622 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
inlineoverrideprotectedvirtual

Implements mpFXY.

Definition at line 1459 of file mathplot.h.

◆ 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 1473 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 1477 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 1465 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 1469 of file mathplot.h.

◆ GetName()

const wxString & mpLayer::GetName ( ) const
inlineinherited

◆ GetNextXY()

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

Get locus value for next N.

Overridden in this implementation.

Parameters
xReturns X value
yReturns Y value

Implements mpFXY.

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

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.

◆ 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
trueHas bounding box
falseHas 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()

◆ Rewind()

void mpFXYVector::Rewind ( )
overrideprotectedvirtual

Rewind value enumeration with mpFXY::GetNextXY.

Overridden in this implementation.

Implements mpFXY.

Definition at line 2593 of file mathplot.cpp.

References m_index, and m_sweepWindow.

◆ s2x()

double mpFXY::s2x ( double  plotCoordX) const
inherited

Definition at line 2694 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 2700 of file mathplot.cpp.

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

◆ SetBrush()

void mpLayer::SetBrush ( const wxBrush &  brush)
inlineinherited

Set layer brush.

Parameters
brushbrush, 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 2629 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
fontFont, 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
nameName, 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
penPen, 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 2675 of file mathplot.cpp.

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

Referenced by SIM_PLOT_TAB::SetTraceData().

◆ SetSweepCount()

void mpFXYVector::SetSweepCount ( int  aSweepCount)
inline

Definition at line 1424 of file mathplot.h.

Referenced by SIM_PLOT_TAB::SetTraceData().

◆ SetSweepSize()

void mpFXYVector::SetSweepSize ( size_t  aSweepSize)
inline

Definition at line 1425 of file mathplot.h.

Referenced by SIM_PLOT_TAB::SetTraceData().

◆ SetSweepWindow()

void mpFXYVector::SetSweepWindow ( int  aSweepIdx)
overrideprotectedvirtual

Reimplemented from mpFXY.

Definition at line 2600 of file mathplot.cpp.

References m_index, m_sweepSize, and m_sweepWindow.

◆ SetVisible()

void mpLayer::SetVisible ( bool  show)
inlineinherited

Sets layer visibility.

Parameters
showvisibility 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

◆ UpdateViewBoundary()

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

Update label positioning data.

Parameters
xnewNew x coordinate
ynewNew 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

◆ y2s()

double mpFXY::y2s ( double  y) const
inherited

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

Referenced by mpFXY::Plot().

◆ m_font

wxFont mpLayer::m_font
protectedinherited

◆ m_index

size_t mpFXYVector::m_index
protected

Definition at line 1437 of file mathplot.h.

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

◆ m_maxX

double mpFXYVector::m_maxX
protected

Definition at line 1442 of file mathplot.h.

Referenced by SetData().

◆ m_maxY

double mpFXYVector::m_maxY
protected

Definition at line 1442 of file mathplot.h.

Referenced by SetData().

◆ m_minX

double mpFXYVector::m_minX
protected

Loaded at SetData.

Definition at line 1442 of file mathplot.h.

Referenced by SetData().

◆ m_minY

double mpFXYVector::m_minY
protected

Definition at line 1442 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

◆ m_scaleX

mpScaleBase* mpFXY::m_scaleX
protectedinherited

Definition at line 587 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 587 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_sweepCount

int mpFXYVector::m_sweepCount = 1
protected

Definition at line 1443 of file mathplot.h.

◆ m_sweepSize

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

Definition at line 1444 of file mathplot.h.

Referenced by SetSweepWindow().

◆ m_sweepWindow

size_t mpFXYVector::m_sweepWindow
protected

Definition at line 1438 of file mathplot.h.

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

◆ 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

◆ 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(), 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 mpFXY::UpdateViewBoundary().

◆ maxDrawY

wxCoord mpFXY::maxDrawY
protectedinherited

Definition at line 585 of file mathplot.h.

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

◆ minDrawX

wxCoord mpFXY::minDrawX
protectedinherited

Definition at line 585 of file mathplot.h.

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

◆ minDrawY

wxCoord mpFXY::minDrawY
protectedinherited

Definition at line 585 of file mathplot.h.

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


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