#include <design_block.h>

Inheritance diagram for DESIGN_BLOCK:

Public Member Functions
LIB_ID	GetLIB_ID () const override

wxString	GetName () const override

wxString	GetLibNickname () const override

wxString	GetDesc () override

std::vector< SEARCH_TERM >	GetSearchTerms () override

void	SetLibId (const LIB_ID &aName)

const LIB_ID &	GetLibId () const

LIB_ID &	GetLibId ()

const wxString &	GetLibDescription () const

void	SetLibDescription (const wxString &aDesc)

const wxString &	GetKeywords () const

void	SetKeywords (const wxString &aKeywords)

const wxString &	GetSchematicFile () const

void	SetSchematicFile (const wxString &aFile)

const wxString &	GetBoardFile () const

void	SetBoardFile (const wxString &aFile)

const nlohmann::ordered_map< wxString, wxString > &	GetFields () const

nlohmann::ordered_map< wxString, wxString > &	GetFields ()

	DESIGN_BLOCK ()=default

	DESIGN_BLOCK (DESIGN_BLOCK &&aOther)=delete
	This is the only way to get m_fields to compile as a class member.

virtual void	GetChooserFields (std::map< wxString, wxString > &aColumnMap)
	Retrieves a key/value map of the fields on this item that should be exposed to the library browser/chooser for displaying in columns, searching, etc.

virtual bool	IsRoot () const
	For items having aliases, IsRoot() indicates the principal item.

virtual wxString	GetFootprint ()
	For items with footprint fields.

virtual int	GetPinCount ()
	The pin count for symbols or the unique pad count for footprints.

virtual int	GetSubUnitCount () const
	For items with units, return the number of units.

virtual wxString	GetUnitName (int aUnit) const
	For items with units, return an identifier for unit x.

Private Attributes
LIB_ID	m_lib_id

wxString	m_schematicFile
	File name and path for schematic file.

wxString	m_boardFile
	File name and path for board file.

wxString	m_libDescription
	File name and path for documentation file.

wxString	m_keywords
	Search keywords to find design block in library.

nlohmann::ordered_map< wxString, wxString >	m_fields

Detailed Description

Definition at line 34 of file design_block.h.

Constructor & Destructor Documentation

◆ DESIGN_BLOCK() [1/2]

DESIGN_BLOCK::DESIGN_BLOCK ( )

default

Referenced by DESIGN_BLOCK().

◆ DESIGN_BLOCK() [2/2]

DESIGN_BLOCK::DESIGN_BLOCK ( DESIGN_BLOCK && aOther )

delete

This is the only way to get m_fields to compile as a class member.

References DESIGN_BLOCK().

Member Function Documentation

◆ GetBoardFile()

const wxString & DESIGN_BLOCK::GetBoardFile ( ) const

inline

Definition at line 57 of file design_block.h.

References m_boardFile.

Referenced by DESIGN_BLOCK_IO::DesignBlockSave(), and PCB_DESIGN_BLOCK_PREVIEW_WIDGET::DisplayDesignBlock().

◆ GetChooserFields()

virtual void LIB_TREE_ITEM::GetChooserFields ( std::map< wxString, wxString > & aColumnMap )

inlinevirtualinherited

Retrieves a key/value map of the fields on this item that should be exposed to the library browser/chooser for displaying in columns, searching, etc.

Reimplemented in LIB_SYMBOL.

Definition at line 57 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ GetDesc()

wxString DESIGN_BLOCK::GetDesc ( )

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 41 of file design_block.h.

References GetLibDescription().

Referenced by GetSearchTerms().

◆ GetFields() [1/2]

nlohmann::ordered_map< wxString, wxString > & DESIGN_BLOCK::GetFields ( )

inline

Definition at line 61 of file design_block.h.

References m_fields.

◆ GetFields() [2/2]

const nlohmann::ordered_map< wxString, wxString > & DESIGN_BLOCK::GetFields ( ) const

inline

Definition at line 60 of file design_block.h.

References m_fields.

Referenced by DESIGN_BLOCK_IO::DesignBlockLoad(), DESIGN_BLOCK_IO::DesignBlockSave(), DESIGN_BLOCK_TREE_MODEL_ADAPTER::GenerateInfo(), and SCH_EDIT_FRAME::SaveSheetAsDesignBlock().

◆ GetFootprint()

virtual wxString LIB_TREE_ITEM::GetFootprint ( )

inlinevirtualinherited

For items with footprint fields.

Reimplemented in LIB_SYMBOL.

Definition at line 69 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM().

◆ GetKeywords()

const wxString & DESIGN_BLOCK::GetKeywords ( ) const

inline

Definition at line 51 of file design_block.h.

References m_keywords.

Referenced by DESIGN_BLOCK_IO::DesignBlockSave(), DESIGN_BLOCK_TREE_MODEL_ADAPTER::GenerateInfo(), and GetSearchTerms().

◆ GetLIB_ID()

LIB_ID DESIGN_BLOCK::GetLIB_ID ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 38 of file design_block.h.

References GetLibId().

Referenced by GetSearchTerms().

◆ GetLibDescription()

const wxString & DESIGN_BLOCK::GetLibDescription ( ) const

inline

Definition at line 48 of file design_block.h.

References m_libDescription.

Referenced by DESIGN_BLOCK_IO::DesignBlockSave(), DESIGN_BLOCK_TREE_MODEL_ADAPTER::GenerateInfo(), and GetDesc().

◆ GetLibId() [1/2]

LIB_ID & DESIGN_BLOCK::GetLibId ( )

inline

Definition at line 46 of file design_block.h.

References m_lib_id.

◆ GetLibId() [2/2]

const LIB_ID & DESIGN_BLOCK::GetLibId ( ) const

inline

Definition at line 45 of file design_block.h.

References m_lib_id.

Referenced by PCB_CONTROL::AppendBoard(), DESIGN_BLOCK_IO::DesignBlockSave(), GetLIB_ID(), DESIGN_BLOCK_LIBRARY_ADAPTER::LoadDesignBlock(), PCB_EDIT_FRAME::SaveBoardAsDesignBlock(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_EDIT_FRAME::saveSelectionToDesignBlock(), and SCH_EDIT_FRAME::SaveSheetAsDesignBlock().

◆ GetLibNickname()

wxString DESIGN_BLOCK::GetLibNickname ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 40 of file design_block.h.

References m_lib_id.

Referenced by GetSearchTerms().

◆ GetName()

wxString DESIGN_BLOCK::GetName ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 39 of file design_block.h.

References m_lib_id.

Referenced by GetSearchTerms(), and DESIGN_BLOCK_LIBRARY_ADAPTER::SaveDesignBlock().

◆ GetPinCount()

virtual int LIB_TREE_ITEM::GetPinCount ( )

inlinevirtualinherited

The pin count for symbols or the unique pad count for footprints.

Reimplemented in FOOTPRINT_INFO, and LIB_SYMBOL.

Definition at line 74 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM().

◆ GetSchematicFile()

const wxString & DESIGN_BLOCK::GetSchematicFile ( ) const

inline

Definition at line 54 of file design_block.h.

References m_schematicFile.

Referenced by DESIGN_BLOCK_IO::DesignBlockSave(), and SCH_DESIGN_BLOCK_PREVIEW_WIDGET::DisplayDesignBlock().

◆ GetSearchTerms()

std::vector< SEARCH_TERM > DESIGN_BLOCK::GetSearchTerms ( )

overridevirtual

Reimplemented from LIB_TREE_ITEM.

Definition at line 25 of file design_block.cpp.

References Format(), GetDesc(), GetKeywords(), GetLIB_ID(), GetLibNickname(), and GetName().

◆ GetSubUnitCount()

virtual int LIB_TREE_ITEM::GetSubUnitCount ( ) const

inlinevirtualinherited

For items with units, return the number of units.

Reimplemented in LIB_SYMBOL.

Definition at line 79 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ GetUnitName()

virtual wxString LIB_TREE_ITEM::GetUnitName ( int aUnit ) const

inlinevirtualinherited

For items with units, return an identifier for unit x.

Reimplemented in LIB_SYMBOL.

Definition at line 84 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().

◆ IsRoot()

virtual bool LIB_TREE_ITEM::IsRoot ( ) const

inlinevirtualinherited

For items having aliases, IsRoot() indicates the principal item.

Reimplemented in LIB_SYMBOL.

Definition at line 64 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ SetBoardFile()

void DESIGN_BLOCK::SetBoardFile ( const wxString & aFile )

inline

Definition at line 58 of file design_block.h.

References m_boardFile.

Referenced by DESIGN_BLOCK_IO::DesignBlockLoad(), PCB_EDIT_FRAME::SaveBoardAsDesignBlock(), and PCB_EDIT_FRAME::saveSelectionToDesignBlock().

◆ SetKeywords()

void DESIGN_BLOCK::SetKeywords ( const wxString & aKeywords )

inline

Definition at line 52 of file design_block.h.

References m_keywords.

Referenced by DESIGN_BLOCK_IO::DesignBlockLoad().

◆ SetLibDescription()

void DESIGN_BLOCK::SetLibDescription ( const wxString & aDesc )

inline

Definition at line 49 of file design_block.h.

References m_libDescription.

Referenced by DESIGN_BLOCK_IO::DesignBlockLoad().

◆ SetLibId()

void DESIGN_BLOCK::SetLibId ( const LIB_ID & aName )

inline

Definition at line 44 of file design_block.h.

References m_lib_id.

Referenced by DESIGN_BLOCK_IO::DesignBlockLoad(), PCB_EDIT_FRAME::SaveBoardAsDesignBlock(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), and SCH_EDIT_FRAME::SaveSheetAsDesignBlock().

◆ SetSchematicFile()

void DESIGN_BLOCK::SetSchematicFile ( const wxString & aFile )

inline

Definition at line 55 of file design_block.h.

References m_schematicFile.

Referenced by DESIGN_BLOCK_IO::DesignBlockLoad(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), and SCH_EDIT_FRAME::SaveSheetAsDesignBlock().

Member Data Documentation

◆ m_boardFile

wxString DESIGN_BLOCK::m_boardFile

private

File name and path for board file.

Definition at line 71 of file design_block.h.

Referenced by GetBoardFile(), and SetBoardFile().

◆ m_fields

nlohmann::ordered_map<wxString, wxString> DESIGN_BLOCK::m_fields

private

Definition at line 75 of file design_block.h.

Referenced by GetFields(), and GetFields().

◆ m_keywords

wxString DESIGN_BLOCK::m_keywords

private

Search keywords to find design block in library.

Definition at line 73 of file design_block.h.

Referenced by GetKeywords(), and SetKeywords().

◆ m_lib_id

LIB_ID DESIGN_BLOCK::m_lib_id

private

Definition at line 69 of file design_block.h.

Referenced by GetLibId(), GetLibId(), GetLibNickname(), GetName(), and SetLibId().

◆ m_libDescription

wxString DESIGN_BLOCK::m_libDescription

private

File name and path for documentation file.

Definition at line 72 of file design_block.h.

Referenced by GetLibDescription(), and SetLibDescription().

◆ m_schematicFile

wxString DESIGN_BLOCK::m_schematicFile

private

File name and path for schematic file.

Definition at line 70 of file design_block.h.

Referenced by GetSchematicFile(), and SetSchematicFile().

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DESIGN_BLOCK() [1/2]

◆ DESIGN_BLOCK() [2/2]

Member Function Documentation

◆ GetBoardFile()

◆ GetChooserFields()

◆ GetDesc()

◆ GetFields() [1/2]

◆ GetFields() [2/2]

◆ GetFootprint()

◆ GetKeywords()

◆ GetLIB_ID()

◆ GetLibDescription()

◆ GetLibId() [1/2]

◆ GetLibId() [2/2]

◆ GetLibNickname()

◆ GetName()

◆ GetPinCount()

◆ GetSchematicFile()

◆ GetSearchTerms()

◆ GetSubUnitCount()

◆ GetUnitName()

◆ IsRoot()

◆ SetBoardFile()

◆ SetKeywords()

◆ SetLibDescription()

◆ SetLibId()

◆ SetSchematicFile()

Member Data Documentation

◆ m_boardFile

◆ m_fields

◆ m_keywords

◆ m_lib_id

◆ m_libDescription

◆ m_schematicFile