KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
GENERATORS_MGR Class Reference

A factory which returns an instance of a PCB_GENERATOR. More...

#include <generators_mgr.h>

Classes

struct  ENTRY
 
struct  REGISTER
 Static helper to register a generator. More...
 

Public Member Functions

void Register (const wxString &aTypeStr, const wxString &aName, std::function< PCB_GENERATOR *(void)> aCreateFunc)
 Associate a type string to display name and create function.
 
PCB_GENERATOR * CreateFromType (const wxString &aTypeStr)
 

Static Public Member Functions

static GENERATORS_MGR & Instance ()
 

Private Attributes

std::map< wxString, ENTRY > m_registry
 

Detailed Description

A factory which returns an instance of a PCB_GENERATOR.

Definition at line 44 of file generators_mgr.h.

Member Function Documentation

◆ CreateFromType()

PCB_GENERATOR * GENERATORS_MGR::CreateFromType ( const wxString & aTypeStr)

Definition at line 50 of file generators_mgr.cpp.

References GENERATORS_MGR::ENTRY::m_createFunc, and m_registry.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::resolveGroups().

◆ Instance()

GENERATORS_MGR & GENERATORS_MGR::Instance ( )
static

Definition at line 28 of file generators_mgr.cpp.

Referenced by GENERATORS_MGR::REGISTER< T >::REGISTER(), REGISTER_LEGACY_TUNING_PATTERN< T >::REGISTER_LEGACY_TUNING_PATTERN(), and PCB_IO_KICAD_SEXPR_PARSER::resolveGroups().

◆ Register()

void GENERATORS_MGR::Register ( const wxString & aTypeStr,
const wxString & aName,
std::function< PCB_GENERATOR *(void)> aCreateFunc )

Associate a type string to display name and create function.

Parameters
aTypeStris the type identifier string.
aNameis the display name.
aCreateFuncis the create function.

Definition at line 35 of file generators_mgr.cpp.

References GENERATORS_MGR::ENTRY::m_createFunc, GENERATORS_MGR::ENTRY::m_displayName, m_registry, and GENERATORS_MGR::ENTRY::m_type.

Referenced by GENERATORS_MGR::REGISTER< T >::REGISTER(), and REGISTER_LEGACY_TUNING_PATTERN< T >::REGISTER_LEGACY_TUNING_PATTERN().

Member Data Documentation

◆ m_registry

std::map<wxString, ENTRY> GENERATORS_MGR::m_registry
private

Definition at line 86 of file generators_mgr.h.

Referenced by CreateFromType(), and Register().

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