#include <design_block_info.h>

Inheritance diagram for DESIGN_BLOCK_INFO:

Public Member Functions
virtual	~DESIGN_BLOCK_INFO ()

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	GetUnitReference (int aUnit)
	For items with units, return an identifier for unit x.

virtual wxString	GetUnitDisplayName (int aUnit)
	For items with units, return a display name for unit x.

virtual bool	HasUnitDisplayName (int aUnit)
	For items with units, return true if a display name is set for x.

Protected Member Functions
void	ensure_loaded ()

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

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.

Friends
bool	operator< (const DESIGN_BLOCK_INFO &lhs, const DESIGN_BLOCK_INFO &rhs)
	Less than comparison operator, intended for sorting DESIGN_BLOCK_INFO objects.

Detailed Description

Definition at line 59 of file design_block_info.h.

Constructor & Destructor Documentation

◆ ~DESIGN_BLOCK_INFO()

virtual DESIGN_BLOCK_INFO::~DESIGN_BLOCK_INFO ( )

inlinevirtual

Definition at line 62 of file design_block_info.h.

Member Function Documentation

◆ ensure_loaded()

void DESIGN_BLOCK_INFO::ensure_loaded ( )

inlineprotected

Definition at line 113 of file design_block_info.h.

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

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 75 of file design_block_info.h.

Referenced by GetSearchTerms().

◆ GetDesignBlockName()

const wxString & DESIGN_BLOCK_INFO::GetDesignBlockName ( ) const

inline

Definition at line 67 of file design_block_info.h.

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

inline

Definition at line 83 of file design_block_info.h.

Referenced by GetSearchTerms().

◆ GetLIB_ID()

LIB_ID DESIGN_BLOCK_INFO::GetLIB_ID ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 73 of file design_block_info.h.

◆ GetLibNickname()

wxString DESIGN_BLOCK_INFO::GetLibNickname ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 69 of file design_block_info.h.

◆ GetName()

wxString DESIGN_BLOCK_INFO::GetName ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 71 of file design_block_info.h.

Referenced by GetSearchTerms().

◆ GetOrderNum()

int DESIGN_BLOCK_INFO::GetOrderNum ( )

inline

Definition at line 91 of file design_block_info.h.

◆ GetPinCount()

virtual int LIB_TREE_ITEM::GetPinCount ( )

inlinevirtualinherited

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

Reimplemented in LIB_SYMBOL, and FOOTPRINT_INFO.

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

overridevirtual

Reimplemented from LIB_TREE_ITEM.

Definition at line 71 of file design_block_info.cpp.

References GetDesc(), GetKeywords(), 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().

◆ GetUnitDisplayName()

virtual wxString LIB_TREE_ITEM::GetUnitDisplayName ( int aUnit )

inlinevirtualinherited

For items with units, return a display name for unit x.

Reimplemented in LIB_SYMBOL.

Definition at line 89 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().

◆ GetUnitReference()

virtual wxString LIB_TREE_ITEM::GetUnitReference ( int aUnit )

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

◆ HasUnitDisplayName()

virtual bool LIB_TREE_ITEM::HasUnitDisplayName ( int aUnit )

inlinevirtualinherited

For items with units, return true if a display name is set for x.

Reimplemented in LIB_SYMBOL.

Definition at line 94 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

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

virtual void DESIGN_BLOCK_INFO::load ( )

inlineprotectedvirtual

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

Reimplemented in DESIGN_BLOCK_INFO_IMPL.

Definition at line 120 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::DESIGN_BLOCK_INFO_IMPL().

◆ SetDesc()

void DESIGN_BLOCK_INFO::SetDesc ( const wxString & aDesc )

inline

Definition at line 81 of file design_block_info.h.

Friends And Related Function Documentation

◆ operator<

bool operator<	(	const DESIGN_BLOCK_INFO &	lhs,
		const DESIGN_BLOCK_INFO &	rhs
	)

friend

Less than comparison operator, intended for sorting DESIGN_BLOCK_INFO objects.

Definition at line 96 of file design_block_info.cpp.

Member Data Documentation

◆ m_dbname

wxString DESIGN_BLOCK_INFO::m_dbname

protected

Module name.

Definition at line 127 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::load().

◆ m_doc

wxString DESIGN_BLOCK_INFO::m_doc

protected

Design block description.

Definition at line 129 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::load().

◆ m_keywords

wxString DESIGN_BLOCK_INFO::m_keywords

protected

Design block keywords.

Definition at line 130 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::load().

◆ m_loaded

bool DESIGN_BLOCK_INFO::m_loaded

protected

Definition at line 124 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::load().

◆ m_nickname

wxString DESIGN_BLOCK_INFO::m_nickname

protected

library as known in DESIGN_BLOCK_LIB_TABLE

Definition at line 126 of file design_block_info.h.

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

◆ m_num

int DESIGN_BLOCK_INFO::m_num

protected

Order number in the display list.

Definition at line 128 of file design_block_info.h.

◆ m_owner

DESIGN_BLOCK_LIST* DESIGN_BLOCK_INFO::m_owner

protected

provides access to DESIGN_BLOCK_LIB_TABLE

Definition at line 122 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::load().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~DESIGN_BLOCK_INFO()

Member Function Documentation

◆ ensure_loaded()

◆ GetChooserFields()

◆ GetDesc()

◆ GetDesignBlockName()

◆ GetFootprint()

◆ GetKeywords()

◆ GetLIB_ID()

◆ GetLibNickname()

◆ GetName()

◆ GetOrderNum()

◆ GetPinCount()

◆ GetSearchTerms()

◆ GetSubUnitCount()

◆ GetUnitDisplayName()

◆ GetUnitReference()

◆ HasUnitDisplayName()

◆ InLibrary()

◆ IsRoot()

◆ load()

◆ SetDesc()

Friends And Related Function Documentation

◆ operator<

Member Data Documentation

◆ m_dbname

◆ m_doc

◆ m_keywords

◆ m_loaded

◆ m_nickname

◆ m_num

◆ m_owner