KiCad PCB EDA Suite
BOARD_EXPORTER_BASE Class Referenceabstract

#include <board_exporter_base.h>

Inheritance diagram for BOARD_EXPORTER_BASE:
HYPERLYNX_EXPORTER

Public Member Functions

 BOARD_EXPORTER_BASE ()
 
virtual ~BOARD_EXPORTER_BASE ()
 
void SetOutputFilename (const wxFileName &aPath)
 
void SetBoard (BOARD *aBoard)
 
void SetReporter (REPORTER *aReporter)
 
void SetProgressReporter (PROGRESS_REPORTER *aProgressReporter)
 
virtual wxDialog * CreateSettingsDialog (PROPERTIES *aProperties)
 
virtual bool HasSettingsDialog () const
 
virtual bool Run ()=0
 

Protected Attributes

PROPERTIES m_properties
 
BOARDm_board = nullptr
 
wxFileName m_outputFilePath
 
REPORTERm_reporter = nullptr
 
PROGRESS_REPORTERm_progressReporter = nullptr
 

Detailed Description

Definition at line 36 of file board_exporter_base.h.

Constructor & Destructor Documentation

◆ BOARD_EXPORTER_BASE()

BOARD_EXPORTER_BASE::BOARD_EXPORTER_BASE ( )
inline

Definition at line 39 of file board_exporter_base.h.

40  {
41  };

◆ ~BOARD_EXPORTER_BASE()

virtual BOARD_EXPORTER_BASE::~BOARD_EXPORTER_BASE ( )
inlinevirtual

Definition at line 43 of file board_exporter_base.h.

44  {
45  };

Member Function Documentation

◆ CreateSettingsDialog()

virtual wxDialog* BOARD_EXPORTER_BASE::CreateSettingsDialog ( PROPERTIES aProperties)
inlinevirtual

Definition at line 70 of file board_exporter_base.h.

71  {
72  return nullptr;
73  }

◆ HasSettingsDialog()

virtual bool BOARD_EXPORTER_BASE::HasSettingsDialog ( ) const
inlinevirtual

Definition at line 75 of file board_exporter_base.h.

76  {
77  return false;
78  }

◆ Run()

virtual bool BOARD_EXPORTER_BASE::Run ( )
pure virtual

Implemented in HYPERLYNX_EXPORTER.

◆ SetBoard()

void BOARD_EXPORTER_BASE::SetBoard ( BOARD aBoard)
inline

Definition at line 52 of file board_exporter_base.h.

53  {
54  m_board = aBoard;
55  }

References m_board.

Referenced by ExportBoardToHyperlynx().

◆ SetOutputFilename()

void BOARD_EXPORTER_BASE::SetOutputFilename ( const wxFileName &  aPath)
inline

Definition at line 47 of file board_exporter_base.h.

48  {
49  m_outputFilePath = aPath;
50  }

References m_outputFilePath.

Referenced by ExportBoardToHyperlynx().

◆ SetProgressReporter()

void BOARD_EXPORTER_BASE::SetProgressReporter ( PROGRESS_REPORTER aProgressReporter)
inline

Definition at line 62 of file board_exporter_base.h.

63  {
64  m_progressReporter = aProgressReporter;
65  }
PROGRESS_REPORTER * m_progressReporter

References m_progressReporter.

◆ SetReporter()

void BOARD_EXPORTER_BASE::SetReporter ( REPORTER aReporter)
inline

Definition at line 57 of file board_exporter_base.h.

58  {
59  m_reporter = aReporter;
60  }

References m_reporter.

Member Data Documentation

◆ m_board

◆ m_outputFilePath

wxFileName BOARD_EXPORTER_BASE::m_outputFilePath
protected

Definition at line 85 of file board_exporter_base.h.

Referenced by HYPERLYNX_EXPORTER::Run(), and SetOutputFilename().

◆ m_progressReporter

PROGRESS_REPORTER* BOARD_EXPORTER_BASE::m_progressReporter = nullptr
protected

Definition at line 87 of file board_exporter_base.h.

Referenced by SetProgressReporter().

◆ m_properties

PROPERTIES BOARD_EXPORTER_BASE::m_properties
protected

Definition at line 83 of file board_exporter_base.h.

◆ m_reporter

REPORTER* BOARD_EXPORTER_BASE::m_reporter = nullptr
protected

Definition at line 86 of file board_exporter_base.h.

Referenced by HYPERLYNX_EXPORTER::formatPadShape(), and SetReporter().


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