KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
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 bool Run ()=0
 

Protected Attributes

std::map< std::string, UTF8 > m_properties
 
BOARD * m_board = nullptr
 
wxFileName m_outputFilePath
 
REPORTER * m_reporter = nullptr
 
PROGRESS_REPORTER * m_progressReporter = nullptr
 

Detailed Description

Definition at line 31 of file board_exporter_base.h.

Constructor & Destructor Documentation

◆ BOARD_EXPORTER_BASE()

BOARD_EXPORTER_BASE::BOARD_EXPORTER_BASE ( )
inline

Definition at line 34 of file board_exporter_base.h.

◆ ~BOARD_EXPORTER_BASE()

virtual BOARD_EXPORTER_BASE::~BOARD_EXPORTER_BASE ( )
inlinevirtual

Definition at line 38 of file board_exporter_base.h.

Member Function Documentation

◆ 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 47 of file board_exporter_base.h.

References m_board.

Referenced by ExportBoardToHyperlynxFile().

◆ SetOutputFilename()

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

Definition at line 42 of file board_exporter_base.h.

References m_outputFilePath.

Referenced by ExportBoardToHyperlynxFile().

◆ SetProgressReporter()

void BOARD_EXPORTER_BASE::SetProgressReporter ( PROGRESS_REPORTER * aProgressReporter)
inline

Definition at line 57 of file board_exporter_base.h.

References m_progressReporter.

◆ SetReporter()

void BOARD_EXPORTER_BASE::SetReporter ( REPORTER * aReporter)
inline

Definition at line 52 of file board_exporter_base.h.

References m_reporter.

Member Data Documentation

◆ m_board

BOARD* BOARD_EXPORTER_BASE::m_board = nullptr
protected

Definition at line 66 of file board_exporter_base.h.

Referenced by HYPERLYNX_EXPORTER::collectNetObjects(), SetBoard(), HYPERLYNX_EXPORTER::writeBoardInfo(), HYPERLYNX_EXPORTER::writeDevices(), HYPERLYNX_EXPORTER::writeNetObjects(), HYPERLYNX_EXPORTER::writeNets(), HYPERLYNX_EXPORTER::writePadStacks(), HYPERLYNX_EXPORTER::writeSinglePadStack(), and HYPERLYNX_EXPORTER::writeStackupInfo().

◆ m_outputFilePath

wxFileName BOARD_EXPORTER_BASE::m_outputFilePath
protected

Definition at line 67 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 69 of file board_exporter_base.h.

Referenced by SetProgressReporter().

◆ m_properties

std::map<std::string, UTF8> BOARD_EXPORTER_BASE::m_properties
protected

Definition at line 65 of file board_exporter_base.h.

◆ m_reporter

REPORTER* BOARD_EXPORTER_BASE::m_reporter = nullptr
protected

Definition at line 68 of file board_exporter_base.h.

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

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