KiCad PCB EDA Suite
Loading...
Searching...
No Matches
TRACE Class Reference

#include <sim_plot_tab.h>

Inheritance diagram for TRACE:
mpFXYVector mpFXY mpLayer

Public Member Functions

 TRACE (const wxString &aName, SIM_TRACE_TYPE aType)
 
void SetName (const wxString &aName) override
 Set layer name. More...
 
void SetData (const std::vector< double > &aX, const std::vector< double > &aY) override
 Assigns new data set for the trace. More...
 
const std::vector< double > & GetDataX () const
 
const std::vector< double > & GetDataY () const
 
bool HasCursor (int aCursorId)
 
void SetCursor (int aCursorId, CURSOR *aCursor)
 
CURSORGetCursor (int aCursorId)
 
std::map< int, CURSOR * > & GetCursors ()
 
SIM_TRACE_TYPE GetType () const
 
void SetTraceColour (const wxColour &aColour)
 
wxColour GetTraceColour () const
 
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...
 
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::map< int, CURSOR * > m_cursors
 
SIM_TRACE_TYPE m_type
 
wxColour m_traceColour
 
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
 
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
 
bool m_visible
 

Detailed Description

Definition at line 123 of file sim_plot_tab.h.

Constructor & Destructor Documentation

◆ TRACE()

TRACE::TRACE ( const wxString &  aName,
SIM_TRACE_TYPE  aType 
)
inline

Definition at line 126 of file sim_plot_tab.h.

References mpLayer::SetContinuity(), SetName(), and mpLayer::ShowName().

Member Function Documentation

◆ Clear()

void mpFXYVector::Clear ( )
inherited

Clears all the data, leaving the layer empty.

See also
SetData

Definition at line 2361 of file mathplot.cpp.

References mpFXYVector::m_xs, and mpFXYVector::m_ys.

◆ GetBrush()

const wxBrush & mpLayer::GetBrush ( ) const
inlineinherited

Get brush set for this layer.

Returns
brush.

Definition at line 300 of file mathplot.h.

◆ GetContinuity()

bool mpLayer::GetContinuity ( ) const
inlineinherited

Gets the 'continuity' property of the layer.

See also
SetContinuity

Definition at line 265 of file mathplot.h.

◆ GetCount()

size_t mpFXYVector::GetCount ( ) const
overrideprotectedvirtualinherited

Implements mpFXY.

Definition at line 2340 of file mathplot.cpp.

References mpFXYVector::m_xs.

◆ GetCursor()

CURSOR * TRACE::GetCursor ( int  aCursorId)
inline

Definition at line 176 of file sim_plot_tab.h.

References m_cursors.

Referenced by SIM_PLOT_TAB::EnableCursor().

◆ GetCursors()

std::map< int, CURSOR * > & TRACE::GetCursors ( )
inline

Definition at line 177 of file sim_plot_tab.h.

References m_cursors.

Referenced by SIM_PLOT_TAB::DeleteTrace(), CURSOR::getID(), and SIM_PLOT_TAB::SetTraceData().

◆ GetDataX()

const std::vector< double > & TRACE::GetDataX ( ) const
inline

Definition at line 170 of file sim_plot_tab.h.

References mpFXYVector::m_xs.

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

◆ GetDataY()

const std::vector< double > & TRACE::GetDataY ( ) const
inline

Definition at line 171 of file sim_plot_tab.h.

References mpFXYVector::m_ys.

Referenced by CURSOR::doSetCoordX().

◆ GetDisplayName()

const wxString & mpLayer::GetDisplayName ( ) const
inlineinherited

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

Referenced by mpInfoLegend::Plot().

◆ GetMaxX()

double mpFXYVector::GetMaxX ( ) const
inlineoverridevirtualinherited

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

Reimplemented from mpLayer.

Definition at line 1408 of file mathplot.h.

◆ GetMaxY()

double mpFXYVector::GetMaxY ( ) const
inlineoverridevirtualinherited

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

Reimplemented from mpLayer.

Definition at line 1412 of file mathplot.h.

◆ GetMinX()

double mpFXYVector::GetMinX ( ) const
inlineoverridevirtualinherited

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

Reimplemented from mpLayer.

Definition at line 1400 of file mathplot.h.

◆ GetMinY()

double mpFXYVector::GetMinY ( ) const
inlineoverridevirtualinherited

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

Reimplemented from mpLayer.

Definition at line 1404 of file mathplot.h.

◆ GetName()

const wxString & mpLayer::GetName ( ) const
inlineinherited

◆ GetNextXY()

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

Get locus value for next N.

Overridden in this implementation.

Parameters
xReturns X value
yReturns Y value

Implements mpFXY.

Definition at line 2346 of file mathplot.cpp.

References mpFXYVector::m_index, mpFXYVector::m_xs, and mpFXYVector::m_ys.

◆ GetPen()

const wxPen & mpLayer::GetPen ( ) const
inlineinherited

Get pen set for this layer.

Returns
Pen

Definition at line 255 of file mathplot.h.

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

◆ GetTraceColour()

wxColour TRACE::GetTraceColour ( ) const
inline

◆ GetType()

SIM_TRACE_TYPE TRACE::GetType ( ) const
inline

Definition at line 179 of file sim_plot_tab.h.

References m_type.

Referenced by SIM_PLOT_TAB::SetTraceData(), and SIM_PLOT_TAB::UpdateTraceStyle().

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

◆ HasCursor()

bool TRACE::HasCursor ( int  aCursorId)
inline

Definition at line 173 of file sim_plot_tab.h.

References m_cursors.

Referenced by SIM_PLOT_TAB::EnableCursor().

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

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

◆ Plot()

◆ Rewind()

void mpFXYVector::Rewind ( )
overrideprotectedvirtualinherited

Rewind value enumeration with mpFXY::GetNextXY.

Overridden in this implementation.

Implements mpFXY.

Definition at line 2334 of file mathplot.cpp.

References mpFXYVector::m_index.

◆ s2x()

double mpFXY::s2x ( double  plotCoordX) const
inherited

Definition at line 2433 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 2439 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 304 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 260 of file mathplot.h.

Referenced by TRACE().

◆ SetCursor()

void TRACE::SetCursor ( int  aCursorId,
CURSOR aCursor 
)
inline

Definition at line 175 of file sim_plot_tab.h.

References m_cursors.

Referenced by SIM_PLOT_TAB::EnableCursor(), and SIMULATOR_FRAME_UI::parseTraceParams().

◆ SetData()

void TRACE::SetData ( const std::vector< double > &  aX,
const std::vector< double > &  aY 
)
inlineoverridevirtual

Assigns new data set for the trace.

aX and aY need to have the same length.

Parameters
aXare the X axis values.
aYare the Y axis values.

Reimplemented from mpFXYVector.

Definition at line 159 of file sim_plot_tab.h.

References cursor, m_cursors, and mpFXYVector::SetData().

Referenced by SIM_PLOT_TAB::SetTraceData().

◆ SetFont()

void mpLayer::SetFont ( const wxFont &  font)
inlineinherited

Set layer font.

Parameters
fontFont, will be copied to internal class member

Definition at line 279 of file mathplot.h.

Referenced by SIM_PLOT_TAB::updateAxes().

◆ SetName()

void TRACE::SetName ( const wxString &  name)
inlineoverridevirtual

Set layer name.

Parameters
nameName, will be copied to internal class member

Reimplemented from mpLayer.

Definition at line 135 of file sim_plot_tab.h.

References _, cursor, m_cursors, mpLayer::m_displayName, m_type, mpLayer::SetName(), SPT_AC_GAIN, and SPT_AC_PHASE.

Referenced by TRACE().

◆ SetPen()

void mpLayer::SetPen ( const wxPen &  pen)
inlineinherited

Set layer pen.

Parameters
penPen, will be copied to internal class member

Definition at line 284 of file mathplot.h.

Referenced by SIM_PLOT_TAB::UpdateTraceStyle().

◆ SetScale()

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

Definition at line 2414 of file mathplot.cpp.

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

Referenced by SIM_PLOT_TAB::SetTraceData().

◆ SetTraceColour()

void TRACE::SetTraceColour ( const wxColour &  aColour)
inline

◆ SetVisible()

void mpLayer::SetVisible ( bool  show)
inlineinherited

Sets layer visibility.

Parameters
showvisibility bool.

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

Referenced by 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 427 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 310 of file mathplot.h.

◆ m_continuous

bool mpLayer::m_continuous
protectedinherited

Definition at line 313 of file mathplot.h.

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

◆ m_cursors

std::map<int, CURSOR*> TRACE::m_cursors
protected

Definition at line 185 of file sim_plot_tab.h.

Referenced by GetCursor(), GetCursors(), HasCursor(), SetCursor(), SetData(), and SetName().

◆ m_displayName

wxString mpLayer::m_displayName
protectedinherited

Definition at line 312 of file mathplot.h.

Referenced by SetName().

◆ m_flags

int mpFXY::m_flags
protectedinherited

Definition at line 581 of file mathplot.h.

Referenced by mpFXY::Plot().

◆ m_font

wxFont mpLayer::m_font
protectedinherited

◆ m_index

size_t mpFXYVector::m_index
protectedinherited

The internal counter for the "GetNextXY" interface.

Definition at line 1377 of file mathplot.h.

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

◆ m_maxX

double mpFXYVector::m_maxX
protectedinherited

Definition at line 1381 of file mathplot.h.

Referenced by mpFXYVector::SetData().

◆ m_maxY

double mpFXYVector::m_maxY
protectedinherited

Definition at line 1381 of file mathplot.h.

Referenced by mpFXYVector::SetData().

◆ m_minX

double mpFXYVector::m_minX
protectedinherited

Loaded at SetData.

Definition at line 1381 of file mathplot.h.

Referenced by mpFXYVector::SetData().

◆ m_minY

double mpFXYVector::m_minY
protectedinherited

Definition at line 1381 of file mathplot.h.

Referenced by mpFXYVector::SetData().

◆ m_name

wxString mpLayer::m_name
protectedinherited

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

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

◆ m_traceColour

wxColour TRACE::m_traceColour
protected

Definition at line 187 of file sim_plot_tab.h.

Referenced by GetTraceColour(), and SetTraceColour().

◆ m_type

SIM_TRACE_TYPE TRACE::m_type
protected

Definition at line 186 of file sim_plot_tab.h.

Referenced by GetType(), and SetName().

◆ m_visible

bool mpLayer::m_visible
protectedinherited

◆ m_xs

std::vector<double> mpFXYVector::m_xs
protectedinherited

The internal copy of the set of data to draw.

Definition at line 1373 of file mathplot.h.

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

◆ m_ys

std::vector<double> mpFXYVector::m_ys
protectedinherited

◆ maxDrawX

wxCoord mpFXY::maxDrawX
protectedinherited

Definition at line 584 of file mathplot.h.

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

◆ maxDrawY

wxCoord mpFXY::maxDrawY
protectedinherited

Definition at line 584 of file mathplot.h.

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

◆ minDrawX

wxCoord mpFXY::minDrawX
protectedinherited

Definition at line 584 of file mathplot.h.

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

◆ minDrawY

wxCoord mpFXY::minDrawY
protectedinherited

Definition at line 584 of file mathplot.h.

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


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