#include <design_block_info_impl.h>

Inheritance diagram for DESIGN_BLOCK_INFO_IMPL:

Public Member Functions
	DESIGN_BLOCK_INFO_IMPL (DESIGN_BLOCK_LIST *aOwner, const wxString &aNickname, const wxString &aDesignBlockName)

	DESIGN_BLOCK_INFO_IMPL (const wxString &aNickname, const wxString &aDesignBlockName, const wxString &aDescription, const wxString &aKeywords, int aOrderNum)

	DESIGN_BLOCK_INFO_IMPL (const wxString &aNickname, const wxString &aDesignBlockName)

const wxString &	GetDesignBlockName () const

wxString	GetLibNickname () const override

wxString	GetName () const override

LIB_ID	GetLIB_ID () const override

wxString	GetDesc () override

void	SetDesc (const wxString &aDesc)

wxString	GetKeywords ()

std::vector< SEARCH_TERM >	GetSearchTerms () override

int	GetOrderNum ()

bool	InLibrary (const wxString &aLibrary) const
	Test if the DESIGN_BLOCK_INFO object was loaded from aLibrary.

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.

Protected Member Functions
virtual void	load () override
	lazily load stuff not filled in by constructor. This may throw IO_ERRORS.

void	ensure_loaded ()

Protected Attributes
DESIGN_BLOCK_LIST *	m_owner
	provides access to DESIGN_BLOCK_LIB_TABLE

bool	m_loaded

wxString	m_nickname
	library as known in DESIGN_BLOCK_LIB_TABLE

wxString	m_dbname
	Module name.

int	m_num
	Order number in the display list.

wxString	m_doc
	Design block description.

wxString	m_keywords
	Design block keywords.

Detailed Description

Definition at line 33 of file design_block_info_impl.h.

Constructor & Destructor Documentation

◆ DESIGN_BLOCK_INFO_IMPL() [1/3]

DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL	(	DESIGN_BLOCK_LIST *	aOwner,
		const wxString &	aNickname,
		const wxString &	aDesignBlockName )

inline

Definition at line 36 of file design_block_info_impl.h.

References DESIGN_BLOCK_INFO::load(), DESIGN_BLOCK_INFO::m_dbname, DESIGN_BLOCK_INFO::m_loaded, DESIGN_BLOCK_INFO::m_nickname, DESIGN_BLOCK_INFO::m_num, and DESIGN_BLOCK_INFO::m_owner.

◆ DESIGN_BLOCK_INFO_IMPL() [2/3]

DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL	(	const wxString &	aNickname,
		const wxString &	aDesignBlockName,
		const wxString &	aDescription,
		const wxString &	aKeywords,
		int	aOrderNum )

inline

Definition at line 49 of file design_block_info_impl.h.

References DESIGN_BLOCK_INFO::m_dbname, DESIGN_BLOCK_INFO::m_doc, DESIGN_BLOCK_INFO::m_keywords, DESIGN_BLOCK_INFO::m_loaded, DESIGN_BLOCK_INFO::m_nickname, DESIGN_BLOCK_INFO::m_num, and DESIGN_BLOCK_INFO::m_owner.

◆ DESIGN_BLOCK_INFO_IMPL() [3/3]

DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL	(	const wxString &	aNickname,
		const wxString &	aDesignBlockName )

inline

Definition at line 64 of file design_block_info_impl.h.

References DESIGN_BLOCK_INFO::m_dbname, DESIGN_BLOCK_INFO::m_loaded, DESIGN_BLOCK_INFO::m_nickname, and DESIGN_BLOCK_INFO::m_owner.

Member Function Documentation

◆ ensure_loaded()

void DESIGN_BLOCK_INFO::ensure_loaded ( )

inlineprotectedinherited

Definition at line 109 of file design_block_info.h.

References load(), and m_loaded.

Referenced by GetDesc(), GetKeywords(), and GetOrderNum().

◆ 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_INFO::GetDesc ( )

inlineoverridevirtualinherited

Implements LIB_TREE_ITEM.

Definition at line 71 of file design_block_info.h.

References ensure_loaded(), and m_doc.

Referenced by GetSearchTerms().

◆ GetDesignBlockName()

const wxString & DESIGN_BLOCK_INFO::GetDesignBlockName ( ) const

inlineinherited

Definition at line 63 of file design_block_info.h.

References m_dbname.

◆ 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()

wxString DESIGN_BLOCK_INFO::GetKeywords ( )

inlineinherited

Definition at line 79 of file design_block_info.h.

References ensure_loaded(), and m_keywords.

Referenced by GetSearchTerms().

◆ GetLIB_ID()

LIB_ID DESIGN_BLOCK_INFO::GetLIB_ID ( ) const

inlineoverridevirtualinherited

Implements LIB_TREE_ITEM.

Definition at line 69 of file design_block_info.h.

References m_dbname, and m_nickname.

Referenced by GetSearchTerms().

◆ GetLibNickname()

wxString DESIGN_BLOCK_INFO::GetLibNickname ( ) const

inlineoverridevirtualinherited

Implements LIB_TREE_ITEM.

Definition at line 65 of file design_block_info.h.

References m_nickname.

Referenced by GetSearchTerms().

◆ GetName()

wxString DESIGN_BLOCK_INFO::GetName ( ) const

inlineoverridevirtualinherited

Implements LIB_TREE_ITEM.

Definition at line 67 of file design_block_info.h.

References m_dbname.

Referenced by GetSearchTerms().

◆ GetOrderNum()

int DESIGN_BLOCK_INFO::GetOrderNum ( )

inlineinherited

Definition at line 87 of file design_block_info.h.

References ensure_loaded(), and m_num.

◆ 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().

◆ GetSearchTerms()

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

overridevirtualinherited

Reimplemented from LIB_TREE_ITEM.

Definition at line 71 of file design_block_info.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().

◆ InLibrary()

bool DESIGN_BLOCK_INFO::InLibrary ( const wxString & aLibrary ) const

inherited

Test if the DESIGN_BLOCK_INFO object was loaded from aLibrary.

Parameters

aLibrary is the nickname of the library to test.

Returns: true if the DESIGN_BLOCK_INFO object was loaded from aLibrary. Otherwise false.

Definition at line 92 of file design_block_info.cpp.

References m_nickname.

◆ 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().

◆ load()

void DESIGN_BLOCK_INFO_IMPL::load ( )

overrideprotectedvirtual

lazily load stuff not filled in by constructor. This may throw IO_ERRORS.

Reimplemented from DESIGN_BLOCK_INFO.

Definition at line 37 of file design_block_info_impl.cpp.

References DESIGN_BLOCK_LIB_TABLE::GetEnumeratedDesignBlock(), DESIGN_BLOCK_INFO::m_dbname, DESIGN_BLOCK_INFO::m_doc, DESIGN_BLOCK_INFO::m_keywords, DESIGN_BLOCK_INFO::m_loaded, DESIGN_BLOCK_INFO::m_nickname, and DESIGN_BLOCK_INFO::m_owner.

◆ SetDesc()

void DESIGN_BLOCK_INFO::SetDesc ( const wxString & aDesc )

inlineinherited

Definition at line 77 of file design_block_info.h.

References m_doc.

Member Data Documentation

◆ m_dbname

wxString DESIGN_BLOCK_INFO::m_dbname

protectedinherited

Module name.

Definition at line 124 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), GetDesignBlockName(), GetLIB_ID(), GetName(), DESIGN_BLOCK_INFO_IMPL::load(), and operator<.

◆ m_doc

wxString DESIGN_BLOCK_INFO::m_doc

protectedinherited

Design block description.

Definition at line 126 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), GetDesc(), DESIGN_BLOCK_INFO_IMPL::load(), and SetDesc().

◆ m_keywords

wxString DESIGN_BLOCK_INFO::m_keywords

protectedinherited

Design block keywords.

Definition at line 127 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), GetKeywords(), and DESIGN_BLOCK_INFO_IMPL::load().

◆ m_loaded

bool DESIGN_BLOCK_INFO::m_loaded

protectedinherited

Definition at line 121 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), ensure_loaded(), and DESIGN_BLOCK_INFO_IMPL::load().

◆ m_nickname

wxString DESIGN_BLOCK_INFO::m_nickname

protectedinherited

library as known in DESIGN_BLOCK_LIB_TABLE

Definition at line 123 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), GetLIB_ID(), GetLibNickname(), InLibrary(), DESIGN_BLOCK_INFO_IMPL::load(), and operator<.

◆ m_num

int DESIGN_BLOCK_INFO::m_num

protectedinherited

Order number in the display list.

Definition at line 125 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), and GetOrderNum().

◆ m_owner

DESIGN_BLOCK_LIST* DESIGN_BLOCK_INFO::m_owner

protectedinherited

provides access to DESIGN_BLOCK_LIB_TABLE

Definition at line 119 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL(), and DESIGN_BLOCK_INFO_IMPL::load().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DESIGN_BLOCK_INFO_IMPL() [1/3]

◆ DESIGN_BLOCK_INFO_IMPL() [2/3]

◆ DESIGN_BLOCK_INFO_IMPL() [3/3]

Member Function Documentation

◆ ensure_loaded()

◆ GetChooserFields()

◆ GetDesc()

◆ GetDesignBlockName()

◆ GetFootprint()

◆ GetKeywords()

◆ GetLIB_ID()

◆ GetLibNickname()

◆ GetName()

◆ GetOrderNum()

◆ GetPinCount()

◆ GetSearchTerms()

◆ GetSubUnitCount()

◆ GetUnitName()

◆ InLibrary()

◆ IsRoot()

◆ load()

◆ SetDesc()

Member Data Documentation

◆ m_dbname

◆ m_doc

◆ m_keywords

◆ m_loaded

◆ m_nickname

◆ m_num

◆ m_owner