KiCad PCB EDA Suite
TRACE_DESC Class Reference

Trace descriptor class

More...

#include <sim_plot_frame.h>

Public Member Functions

 TRACE_DESC (const NETLIST_EXPORTER_PSPICE_SIM &aExporter, const wxString &aName, SIM_PLOT_TYPE aType, const wxString &aParam)
 
 TRACE_DESC (const NETLIST_EXPORTER_PSPICE_SIM &aExporter, const TRACE_DESC &aDescription, SIM_PLOT_TYPE aNewType)
 

Modifies an existing TRACE_DESC simulation type

More...
 
const wxString & GetTitle () const
 
const wxString & GetName () const
 
const wxString & GetParam () const
 
SIM_PLOT_TYPE GetType () const
 

Private Attributes

wxString m_name
 

Name of the measured net/device

More...
 
SIM_PLOT_TYPE m_type
 

Type of the signal

More...
 
wxString m_param
 

Name of the signal parameter

More...
 
wxString m_title
 

Title displayed in the signal list/plot legend

More...
 

Detailed Description

Trace descriptor class

Definition at line 59 of file sim_plot_frame.h.

Constructor & Destructor Documentation

TRACE_DESC::TRACE_DESC ( const NETLIST_EXPORTER_PSPICE_SIM aExporter,
const wxString &  aName,
SIM_PLOT_TYPE  aType,
const wxString &  aParam 
)

Definition at line 93 of file sim_plot_frame.cpp.

References Format(), m_title, SPT_AC_MAG, and SPT_AC_PHASE.

95  : m_name( aName ), m_type( aType ), m_param( aParam )
96 {
97  // Title generation
98  m_title = wxString::Format( "%s(%s)", aParam, aName );
99 
100  if( aType & SPT_AC_MAG )
101  m_title += " (mag)";
102  else if( aType & SPT_AC_PHASE )
103  m_title += " (phase)";
104 }
wxString m_title
Title displayed in the signal list/plot legend
wxString m_param
Name of the signal parameter
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
SIM_PLOT_TYPE m_type
Type of the signal
wxString m_name
Name of the measured net/device
TRACE_DESC::TRACE_DESC ( const NETLIST_EXPORTER_PSPICE_SIM aExporter,
const TRACE_DESC aDescription,
SIM_PLOT_TYPE  aNewType 
)
inline

Modifies an existing TRACE_DESC simulation type

Definition at line 66 of file sim_plot_frame.h.

68  : TRACE_DESC( aExporter, aDescription.GetName(), aNewType, aDescription.GetParam() )
69  {
70  }
const wxString & GetName() const
const wxString & GetParam() const
TRACE_DESC(const NETLIST_EXPORTER_PSPICE_SIM &aExporter, const wxString &aName, SIM_PLOT_TYPE aType, const wxString &aParam)

Member Function Documentation

const wxString& TRACE_DESC::GetName ( void  ) const
inline

Definition at line 77 of file sim_plot_frame.h.

References m_name.

Referenced by SIM_PLOT_FRAME::updatePlot().

78  {
79  return m_name;
80  }
wxString m_name
Name of the measured net/device
const wxString& TRACE_DESC::GetParam ( ) const
inline

Definition at line 82 of file sim_plot_frame.h.

References m_param.

Referenced by SIM_PLOT_FRAME::updatePlot().

83  {
84  return m_param;
85  }
wxString m_param
Name of the signal parameter
const wxString& TRACE_DESC::GetTitle ( void  ) const
inline

Definition at line 72 of file sim_plot_frame.h.

References m_title.

Referenced by SIM_PLOT_FRAME::updatePlot().

73  {
74  return m_title;
75  }
wxString m_title
Title displayed in the signal list/plot legend
SIM_PLOT_TYPE TRACE_DESC::GetType ( ) const
inline

Definition at line 87 of file sim_plot_frame.h.

References m_type.

Referenced by SIM_PLOT_FRAME::addPlot(), and SIM_PLOT_FRAME::updatePlot().

88  {
89  return m_type;
90  }
SIM_PLOT_TYPE m_type
Type of the signal

Member Data Documentation

wxString TRACE_DESC::m_name
private

Name of the measured net/device

Definition at line 95 of file sim_plot_frame.h.

Referenced by GetName().

wxString TRACE_DESC::m_param
private

Name of the signal parameter

Definition at line 101 of file sim_plot_frame.h.

Referenced by GetParam().

wxString TRACE_DESC::m_title
private

Title displayed in the signal list/plot legend

Definition at line 105 of file sim_plot_frame.h.

Referenced by GetTitle(), and TRACE_DESC().

SIM_PLOT_TYPE TRACE_DESC::m_type
private

Type of the signal

Definition at line 98 of file sim_plot_frame.h.

Referenced by GetType().


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