#include <design_block_info_impl.h>

Inheritance diagram for DESIGN_BLOCK_LIST_IMPL:

Public Member Functions
	DESIGN_BLOCK_LIST_IMPL ()

virtual	~DESIGN_BLOCK_LIST_IMPL ()

bool	ReadDesignBlockFiles (DESIGN_BLOCK_LIB_TABLE aTable, const wxString aNickname=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr) override
	Read all the design blocks provided by the combination of aTable and aNickname.

unsigned	GetCount () const

const std::vector< std::unique_ptr< DESIGN_BLOCK_INFO > > &	GetList () const
	Was forced to add this by modview_frame.cpp.

void	Clear ()

DESIGN_BLOCK_INFO *	GetDesignBlockInfo (const wxString &aDesignBlockName)
	Get info for a design block by id.

DESIGN_BLOCK_INFO *	GetDesignBlockInfo (const wxString &aLibNickname, const wxString &aDesignBlockName)
	Get info for a design block by libNickname/designBlockName.

DESIGN_BLOCK_INFO &	GetItem (unsigned aIdx) const
	Get info for a design block by index.

unsigned	GetErrorCount () const

std::unique_ptr< IO_ERROR >	PopError ()

DESIGN_BLOCK_LIB_TABLE *	GetTable () const

Protected Member Functions
void	loadDesignBlocks ()

Protected Attributes
DESIGN_BLOCK_LIB_TABLE *	m_lib_table = nullptr
	no ownership

std::vector< std::unique_ptr< DESIGN_BLOCK_INFO > >	m_list

SYNC_QUEUE< std::unique_ptr< IO_ERROR > >	m_errors
	some can be PARSE_ERRORs also

Private Member Functions
bool	CatchErrors (const std::function< void()> &aFunc)
	Call aFunc, pushing any IO_ERRORs and std::exceptions it throws onto m_errors.

Private Attributes
SYNC_QUEUE< wxString >	m_queue

long long	m_list_timestamp

PROGRESS_REPORTER *	m_progress_reporter

std::atomic_bool	m_cancelled

std::mutex	m_join

Detailed Description

Definition at line 80 of file design_block_info_impl.h.

Constructor & Destructor Documentation

◆ DESIGN_BLOCK_LIST_IMPL()

DESIGN_BLOCK_LIST_IMPL::DESIGN_BLOCK_LIST_IMPL ( )

Definition at line 234 of file design_block_info_impl.cpp.

◆ ~DESIGN_BLOCK_LIST_IMPL()

virtual DESIGN_BLOCK_LIST_IMPL::~DESIGN_BLOCK_LIST_IMPL ( )

inlinevirtual

Definition at line 84 of file design_block_info_impl.h.

Member Function Documentation

◆ CatchErrors()

bool DESIGN_BLOCK_LIST_IMPL::CatchErrors ( const std::function< void()> & aFunc )

private

Call aFunc, pushing any IO_ERRORs and std::exceptions it throws onto m_errors.

Returns: true if no error occurred.

Definition at line 59 of file design_block_info_impl.cpp.

References DESIGN_BLOCK_LIST::m_errors, SYNC_QUEUE< T >::move_push(), and THROW_IO_ERROR.

Referenced by loadDesignBlocks(), and ReadDesignBlockFiles().

◆ Clear()

void DESIGN_BLOCK_LIST::Clear ( )

inlineinherited

Returns: Clears the design block info cache

Definition at line 156 of file design_block_info.h.

◆ GetCount()

unsigned DESIGN_BLOCK_LIST::GetCount ( ) const

inlineinherited

Returns: the number of items stored in list

Definition at line 148 of file design_block_info.h.

◆ GetDesignBlockInfo() [1/2]

DESIGN_BLOCK_INFO * DESIGN_BLOCK_LIST::GetDesignBlockInfo ( const wxString & aDesignBlockName )

inherited

Get info for a design block by id.

Definition at line 57 of file design_block_info.cpp.

References DESIGN_BLOCK_LIST::GetDesignBlockInfo(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), and LIB_ID::Parse().

Referenced by DESIGN_BLOCK_LIST::GetDesignBlockInfo(), and PANEL_DESIGN_BLOCK_CHOOSER::rebuildHistoryNode().

◆ GetDesignBlockInfo() [2/2]

DESIGN_BLOCK_INFO * DESIGN_BLOCK_LIST::GetDesignBlockInfo	(	const wxString &	aLibNickname,
		const wxString &	aDesignBlockName
	)

inherited

Get info for a design block by libNickname/designBlockName.

Definition at line 41 of file design_block_info.cpp.

References DESIGN_BLOCK_LIST::m_list.

◆ GetErrorCount()

unsigned DESIGN_BLOCK_LIST::GetErrorCount ( ) const

inlineinherited

Definition at line 177 of file design_block_info.h.

◆ GetItem()

DESIGN_BLOCK_INFO & DESIGN_BLOCK_LIST::GetItem ( unsigned aIdx ) const

inlineinherited

Get info for a design block by index.

Parameters

aIdx	index of the given item.

Returns: the aIdx item in list.

Definition at line 175 of file design_block_info.h.

◆ GetList()

const std::vector< std::unique_ptr< DESIGN_BLOCK_INFO > > & DESIGN_BLOCK_LIST::GetList ( ) const

inlineinherited

Was forced to add this by modview_frame.cpp.

Definition at line 151 of file design_block_info.h.

Referenced by DESIGN_BLOCK_TREE_MODEL_ADAPTER::getDesignBlocks().

◆ GetTable()

DESIGN_BLOCK_LIB_TABLE * DESIGN_BLOCK_LIST::GetTable ( ) const

inlineinherited

Definition at line 203 of file design_block_info.h.

Referenced by DESIGN_BLOCK_INFO_IMPL::load().

◆ loadDesignBlocks()

void DESIGN_BLOCK_LIST_IMPL::loadDesignBlocks ( )

protected

Definition at line 152 of file design_block_info_impl.cpp.

References PROGRESS_REPORTER::AdvanceProgress(), CatchErrors(), DESIGN_BLOCK_LIB_TABLE::DesignBlockEnumerate(), GetKiCadThreadPool(), PROGRESS_REPORTER::KeepRefreshing(), m_cancelled, DESIGN_BLOCK_LIST::m_lib_table, DESIGN_BLOCK_LIST::m_list, m_progress_reporter, m_queue, SYNC_QUEUE< T >::move_push(), SYNC_QUEUE< T >::pop(), SYNC_QUEUE< T >::size(), and tp.

Referenced by ReadDesignBlockFiles().

◆ PopError()

std::unique_ptr< IO_ERROR > DESIGN_BLOCK_LIST::PopError ( )

inlineinherited

Definition at line 179 of file design_block_info.h.

◆ ReadDesignBlockFiles()

bool DESIGN_BLOCK_LIST_IMPL::ReadDesignBlockFiles	(	DESIGN_BLOCK_LIB_TABLE *	aTable,
		const wxString *	aNickname = `nullptr`,
		PROGRESS_REPORTER *	aProgressReporter = `nullptr`
	)

overridevirtual

Read all the design blocks provided by the combination of aTable and aNickname.

Parameters

aTable	defines all the libraries.
aNickname	is the library to read from, or if NULL means read all design blocks from all known libraries in aTable.
aProgressReporter	is an optional progress reporter. ReadDesignBlockFiles() will use 2 phases within the reporter.

Returns: true if it ran to completion, else false if it aborted after some number of errors. If true, it does not mean there were no errors, check GetErrorCount() for that, should be zero to indicate success.

Implements DESIGN_BLOCK_LIST.

Definition at line 90 of file design_block_info_impl.cpp.

References _, PROGRESS_REPORTER::AdvancePhase(), CatchErrors(), SYNC_QUEUE< T >::clear(), SYNC_QUEUE< T >::empty(), DESIGN_BLOCK_LIB_TABLE::GenerateTimestamp(), LIB_TABLE::GetLogicalLibs(), loadDesignBlocks(), m_cancelled, DESIGN_BLOCK_LIST::m_errors, DESIGN_BLOCK_LIST::m_lib_table, DESIGN_BLOCK_LIST::m_list, m_list_timestamp, m_progress_reporter, m_queue, SYNC_QUEUE< T >::push(), PROGRESS_REPORTER::Report(), PROGRESS_REPORTER::SetMaxProgress(), and SYNC_QUEUE< T >::size().

Referenced by PANEL_DESIGN_BLOCK_CHOOSER::PANEL_DESIGN_BLOCK_CHOOSER(), and PANEL_DESIGN_BLOCK_CHOOSER::RefreshLibs().

Member Data Documentation

◆ m_cancelled

std::atomic_bool DESIGN_BLOCK_LIST_IMPL::m_cancelled

private

Definition at line 104 of file design_block_info_impl.h.

Referenced by loadDesignBlocks(), and ReadDesignBlockFiles().

◆ m_errors

SYNC_QUEUE<std::unique_ptr<IO_ERROR> > DESIGN_BLOCK_LIST::m_errors

protectedinherited

some can be PARSE_ERRORs also

Definition at line 209 of file design_block_info.h.

Referenced by CatchErrors(), and ReadDesignBlockFiles().

◆ m_join

std::mutex DESIGN_BLOCK_LIST_IMPL::m_join

private

Definition at line 105 of file design_block_info_impl.h.

◆ m_lib_table

DESIGN_BLOCK_LIB_TABLE* DESIGN_BLOCK_LIST::m_lib_table = nullptr

protectedinherited

no ownership

Definition at line 206 of file design_block_info.h.

Referenced by loadDesignBlocks(), and ReadDesignBlockFiles().

◆ m_list

std::vector<std::unique_ptr<DESIGN_BLOCK_INFO> > DESIGN_BLOCK_LIST::m_list

protectedinherited

Definition at line 208 of file design_block_info.h.

Referenced by DESIGN_BLOCK_LIST::GetDesignBlockInfo(), loadDesignBlocks(), and ReadDesignBlockFiles().

◆ m_list_timestamp

long long DESIGN_BLOCK_LIST_IMPL::m_list_timestamp

private

Definition at line 102 of file design_block_info_impl.h.

Referenced by ReadDesignBlockFiles().

◆ m_progress_reporter

PROGRESS_REPORTER* DESIGN_BLOCK_LIST_IMPL::m_progress_reporter

private

Definition at line 103 of file design_block_info_impl.h.

Referenced by loadDesignBlocks(), and ReadDesignBlockFiles().

◆ m_queue

SYNC_QUEUE<wxString> DESIGN_BLOCK_LIST_IMPL::m_queue

private

Definition at line 101 of file design_block_info_impl.h.

Referenced by loadDesignBlocks(), and ReadDesignBlockFiles().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DESIGN_BLOCK_LIST_IMPL()

◆ ~DESIGN_BLOCK_LIST_IMPL()

Member Function Documentation

◆ CatchErrors()

◆ Clear()

◆ GetCount()

◆ GetDesignBlockInfo() [1/2]

◆ GetDesignBlockInfo() [2/2]

◆ GetErrorCount()

◆ GetItem()

◆ GetList()

◆ GetTable()

◆ loadDesignBlocks()

◆ PopError()

◆ ReadDesignBlockFiles()

Member Data Documentation

◆ m_cancelled

◆ m_errors

◆ m_join

◆ m_lib_table

◆ m_list

◆ m_list_timestamp

◆ m_progress_reporter

◆ m_queue