Bill of material output generator. More...

#include <bom_plugins.h>

Public Member Functions
	BOM_GENERATOR_HANDLER (const wxString &aFile)

bool	IsOk ()
	Return true if the plugin is ready to work, i.e.

const wxString &	GetInfo () const
	Return plugin description stored in the plugin header file (if available).

const wxFileName &	GetFile () const
	Return the file name of the plugin.

wxString	GetStoredPath () const

wxFileName	FindFilePath () const
	Returns the calculated path to the plugin: if the path is already absolute and exists, just return it.

const wxString &	GetName () const
	Return the customisable plugin name.

void	SetName (const wxString &aName)
	Set the customisable plugin name.

const wxString &	GetCommand () const
	Return the command to execute the plugin.

void	SetCommand (const wxString &aCommand)
	Set the command to execute the plugin.

wxArrayString &	Options ()
	Accessor to array of options.

Static Public Member Functions
static bool	IsValidGenerator (const wxString &aFile)
	Return true if a file name matches a recognized plugin format.

Protected Member Functions
wxString	readHeader (const wxString &aEndSection)
	Read the plugin file header.

Static Protected Member Functions
static wxString	getOutputExtension (const wxString &aHeader)
	Extracts the output BOM file's extension, including the '.

Protected Attributes
bool	m_isOk
	Path to the plugin.

wxFileName	m_file
	Path to the plugin stored in config (can be absolute or just a filename)

const wxString	m_storedPath
	User customisable name.

wxString	m_name
	Command to execute the plugin.

wxString	m_cmd
	Description of the plugin (normally from the plugin header)

wxString	m_info
	Plugin specific options.

wxArrayString	m_options

Detailed Description

Bill of material output generator.

A Material output generator is an external application called by Eeschema to create a BOM from our intermediate XML netlist. A generator can be a script or an executable that can read the intermediate XML netlist file and generates a output (the BOM file)

Definition at line 45 of file bom_plugins.h.

Constructor & Destructor Documentation

◆ BOM_GENERATOR_HANDLER()

BOM_GENERATOR_HANDLER::BOM_GENERATOR_HANDLER ( const wxString & aFile )

Parameters

aFile is path to the plugin file.

Definition at line 36 of file bom_plugins.cpp.

References _, BOM_TRACE, FindFilePath(), getOutputExtension(), m_cmd, m_file, m_info, m_isOk, m_name, m_storedPath, and readHeader().

Member Function Documentation

◆ FindFilePath()

wxFileName BOM_GENERATOR_HANDLER::FindFilePath ( ) const

Returns the calculated path to the plugin: if the path is already absolute and exists, just return it.

Otherwise if the path is just a filename, look for that file in the user and system plugin directories and return the first one found. If neither is found, just return m_file.

Returns: the full path to the plugin

Definition at line 198 of file bom_plugins.cpp.

References BOM_TRACE, PATHS::GetStockPluginsPath(), PATHS::GetUserPluginsPath(), and m_file.

Referenced by BOM_GENERATOR_HANDLER(), and DIALOG_BOM::pluginInit().

◆ GetCommand()

const wxString & BOM_GENERATOR_HANDLER::GetCommand ( ) const

inline

Return the command to execute the plugin.

Definition at line 114 of file bom_plugins.h.

References m_cmd.

Referenced by DIALOG_BOM::pluginInit().

◆ GetFile()

const wxFileName & BOM_GENERATOR_HANDLER::GetFile ( ) const

inline

Return the file name of the plugin.

Definition at line 76 of file bom_plugins.h.

References m_file.

Referenced by DIALOG_BOM::pluginInit().

◆ GetInfo()

const wxString & BOM_GENERATOR_HANDLER::GetInfo ( ) const

inline

Return plugin description stored in the plugin header file (if available).

Definition at line 68 of file bom_plugins.h.

References m_info.

Referenced by DIALOG_BOM::pluginInit().

◆ GetName()

const wxString & BOM_GENERATOR_HANDLER::GetName ( ) const

inline

Return the customisable plugin name.

Definition at line 96 of file bom_plugins.h.

References m_name.

Referenced by DIALOG_BOM::pluginInit().

◆ getOutputExtension()

wxString BOM_GENERATOR_HANDLER::getOutputExtension ( const wxString & aHeader )

staticprotected

Extracts the output BOM file's extension, including the '.

', from the plugin file header. If the output extension cannot be determined from the plugin header, returns wxEmptyString.

Parameters

aHeader is the plugin file's header, as returned by readHeader() true if the plugin is working (i.e. if the plugin file exists and was read

Definition at line 177 of file bom_plugins.cpp.

Referenced by BOM_GENERATOR_HANDLER().

◆ GetStoredPath()

wxString BOM_GENERATOR_HANDLER::GetStoredPath ( ) const

inline

Definition at line 81 of file bom_plugins.h.

References m_storedPath.

◆ IsOk()

bool BOM_GENERATOR_HANDLER::IsOk ( )

inline

Return true if the plugin is ready to work, i.e.

if the plugin file is found and readable.

Definition at line 56 of file bom_plugins.h.

References m_isOk.

Referenced by DIALOG_BOM::pluginInit().

◆ IsValidGenerator()

bool BOM_GENERATOR_HANDLER::IsValidGenerator ( const wxString & aFile )

static

Return true if a file name matches a recognized plugin format.

Parameters

aFile is path to the plugin file.

Definition at line 129 of file bom_plugins.cpp.

◆ Options()

wxArrayString & BOM_GENERATOR_HANDLER::Options ( )

inline

Accessor to array of options.

Definition at line 130 of file bom_plugins.h.

References m_options.

Referenced by DIALOG_BOM::pluginInit().

◆ readHeader()

wxString BOM_GENERATOR_HANDLER::readHeader ( const wxString & aEndSection )

protected

Read the plugin file header.

Parameters

aEndSection is a string marking end of the header.

Definition at line 144 of file bom_plugins.cpp.

References m_file.

Referenced by BOM_GENERATOR_HANDLER().

◆ SetCommand()

void BOM_GENERATOR_HANDLER::SetCommand ( const wxString & aCommand )

inline

Set the command to execute the plugin.

Definition at line 122 of file bom_plugins.h.

References m_cmd.

◆ SetName()

void BOM_GENERATOR_HANDLER::SetName ( const wxString & aName )

inline

Set the customisable plugin name.

Parameters

aName is the new name.

Definition at line 106 of file bom_plugins.h.

References m_name.

Member Data Documentation

◆ m_cmd

wxString BOM_GENERATOR_HANDLER::m_cmd

protected

Description of the plugin (normally from the plugin header)

Definition at line 164 of file bom_plugins.h.

Referenced by BOM_GENERATOR_HANDLER(), GetCommand(), and SetCommand().

◆ m_file

wxFileName BOM_GENERATOR_HANDLER::m_file

protected

Path to the plugin stored in config (can be absolute or just a filename)

Definition at line 155 of file bom_plugins.h.

Referenced by BOM_GENERATOR_HANDLER(), FindFilePath(), GetFile(), and readHeader().

◆ m_info

wxString BOM_GENERATOR_HANDLER::m_info

protected

Plugin specific options.

Definition at line 167 of file bom_plugins.h.

Referenced by BOM_GENERATOR_HANDLER(), and GetInfo().

◆ m_isOk

bool BOM_GENERATOR_HANDLER::m_isOk

protected

Path to the plugin.

Definition at line 152 of file bom_plugins.h.

Referenced by BOM_GENERATOR_HANDLER(), and IsOk().

◆ m_name

wxString BOM_GENERATOR_HANDLER::m_name

protected

Command to execute the plugin.

Definition at line 161 of file bom_plugins.h.

Referenced by BOM_GENERATOR_HANDLER(), GetName(), and SetName().

◆ m_options

wxArrayString BOM_GENERATOR_HANDLER::m_options

protected

Definition at line 170 of file bom_plugins.h.

Referenced by Options().

◆ m_storedPath

const wxString BOM_GENERATOR_HANDLER::m_storedPath

protected

User customisable name.

Definition at line 158 of file bom_plugins.h.

Referenced by BOM_GENERATOR_HANDLER(), and GetStoredPath().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BOM_GENERATOR_HANDLER()

Member Function Documentation

◆ FindFilePath()

◆ GetCommand()

◆ GetFile()

◆ GetInfo()

◆ GetName()

◆ getOutputExtension()

◆ GetStoredPath()

◆ IsOk()

◆ IsValidGenerator()

◆ Options()

◆ readHeader()

◆ SetCommand()

◆ SetName()

Member Data Documentation

◆ m_cmd

◆ m_file

◆ m_info

◆ m_isOk

◆ m_name

◆ m_options

◆ m_storedPath