#include <fields_data_model.h>

Inheritance diagram for FIELDS_EDITOR_GRID_DATA_MODEL:

Public Types
enum	SCOPE : int { SCOPE_ALL = 0 , SCOPE_SHEET , SCOPE_SHEET_RECURSIVE }

Public Member Functions
	FIELDS_EDITOR_GRID_DATA_MODEL (const SCH_REFERENCE_LIST &aSymbolsList, wxGridCellAttr *aURLEditor)

	~FIELDS_EDITOR_GRID_DATA_MODEL () override

void	AddColumn (const wxString &aFieldName, const wxString &aLabel, bool aAddedByUser, const wxString &aVariantName)

void	RemoveColumn (int aCol)

void	RenameColumn (int aCol, const wxString &newName)

void	MoveColumn (int aCol, int aNewPos)

int	GetNumberRows () override

int	GetNumberCols () override

void	SetColLabelValue (int aCol, const wxString &aLabel) override

wxString	GetColLabelValue (int aCol) override

wxString	GetColFieldName (int aCol)

int	GetFieldNameCol (const wxString &aFieldName) const

std::vector< BOM_FIELD >	GetFieldsOrdered ()

void	SetFieldsOrder (const std::vector< wxString > &aNewOrder)

bool	IsEmptyCell (int aRow, int aCol) override

wxString	GetValue (int aRow, int aCol) override

wxString	GetResolvedValue (int aRow, int aCol)

wxGridCellAttr *	GetAttr (int aRow, int aCol, wxGridCellAttr::wxAttrKind aKind) override

wxString	GetValue (const DATA_MODEL_ROW &group, int aCol, const wxString &refDelimiter=wxT(", "), const wxString &refRangDelimiter=wxT("-"), bool resolveVars=false, bool listMixedValues=false)

wxString	GetExportValue (int aRow, int aCol, const wxString &refDelimiter, const wxString &refRangeDelimiter)

void	SetValue (int aRow, int aCol, const wxString &aValue) override

GROUP_TYPE	GetRowFlags (int aRow)

std::vector< SCH_REFERENCE >	GetRowReferences (int aRow) const

bool	ColIsReference (int aCol)

bool	ColIsValue (int aCol)

bool	ColIsQuantity (int aCol)

bool	ColIsItemNumber (int aCol)

bool	ColIsAttribute (int aCol)

bool	IsExpanderColumn (int aCol) const override

GROUP_TYPE	GetGroupType (int aRow) const override

void	SetSorting (int aCol, bool ascending)

int	GetSortCol ()

bool	GetSortAsc ()

void	EnableRebuilds ()

void	DisableRebuilds ()

void	RebuildRows ()

void	ExpandRow (int aRow)

void	CollapseRow (int aRow)

void	ExpandCollapseRow (int aRow)

void	CollapseForSort ()

void	ExpandAfterSort ()

void	ApplyData (SCH_COMMIT &aCommit, TEMPLATES &aTemplateFieldnames, const wxString &aVariantName)

bool	IsEdited ()

int	GetDataWidth (int aCol)

void	SetFilter (const wxString &aFilter)

const wxString &	GetFilter ()

void	SetScope (SCOPE aScope)

SCOPE	GetScope ()

void	SetPath (const SCH_SHEET_PATH &aPath)

const SCH_SHEET_PATH &	GetPath ()

void	SetGroupingEnabled (bool group)

bool	GetGroupingEnabled ()

void	SetIncludeExcludedFromBOM (bool include)

bool	GetIncludeExcludedFromBOM ()

void	SetExcludeDNP (bool exclude)

bool	GetExcludeDNP ()

void	SetGroupColumn (int aCol, bool group)

bool	GetGroupColumn (int aCol)

void	SetShowColumn (int aCol, bool show)

bool	GetShowColumn (int aCol)

void	ApplyBomPreset (const BOM_PRESET &preset, const wxString &aVariantName)

BOM_PRESET	GetBomSettings ()

wxString	Export (const BOM_FMT_PRESET &settings)

void	AddReferences (const SCH_REFERENCE_LIST &aRefs)

void	RemoveReferences (const SCH_REFERENCE_LIST &aRefs)

void	RemoveSymbol (const SCH_SYMBOL &aSymbol)

void	UpdateReferences (const SCH_REFERENCE_LIST &aRefs, const wxString &aVariantName)

bool	DeleteRows (size_t aPosition=0, size_t aNumRows=1) override

const SCH_REFERENCE_LIST &	GetReferenceList () const

void	SetCurrentVariant (const wxString &aVariantName)
	Set the current variant name for highlighting purposes.

const wxString &	GetCurrentVariant () const

void	SetVariantNames (const std::vector< wxString > &aVariantNames)

const std::vector< wxString > &	GetVariantNames () const

void	SetColAttr (wxGridCellAttr *aAttr, int aCol) override

void	Clear () override

Static Public Attributes
static const wxString	QUANTITY_VARIABLE = wxS( "${QUANTITY}" )

static const wxString	ITEM_NUMBER_VARIABLE = wxS( "${ITEM_NUMBER}" )

Protected Member Functions
wxGridCellAttr *	enhanceAttr (wxGridCellAttr *aInputAttr, int aRow, int aCol, wxGridCellAttr::wxAttrKind aKind)

Protected Attributes
SCH_REFERENCE_LIST	m_symbolsList
	The flattened by hierarchy list of symbols.

bool	m_edited

int	m_sortColumn

bool	m_sortAscending

wxString	m_filter

SCOPE	m_scope

SCH_SHEET_PATH	m_path

bool	m_groupingEnabled

bool	m_excludeDNP

bool	m_includeExcluded

bool	m_rebuildsEnabled

wxGridCellAttr *	m_urlEditor

wxGridCellRenderer *	m_textVarRenderer
	Renderer for cells with text variable references.

wxString	m_currentVariant
	Current variant name for highlighting.

std::vector< wxString >	m_variantNames
	Variant names for multi-variant DNP filtering.

std::vector< DATA_MODEL_COL >	m_cols

std::vector< DATA_MODEL_ROW >	m_rows

std::map< KIID_PATH, std::map< wxString, wxString > >	m_dataStore

std::map< int, wxGridCellAttr * >	m_colAttrs

Private Member Functions
bool	unitMatch (const SCH_REFERENCE &lhRef, const SCH_REFERENCE &rhRef)

bool	groupMatch (const SCH_REFERENCE &lhRef, const SCH_REFERENCE &rhRef)

bool	isAttribute (const wxString &aFieldName)

wxString	getAttributeValue (const SCH_REFERENCE &aRef, const wxString &aAttributeName, const wxString &aVariantNames)

wxString	getDefaultFieldValue (const SCH_REFERENCE &aRef, const wxString &aFieldName)
	Get the default (non-variant) value for a field.

bool	setAttributeValue (SCH_REFERENCE &aRef, const wxString &aAttributeName, const wxString &aValue, const wxString &aVariantName=wxEmptyString)
	Set the attribute value.

wxString	getFieldShownText (const SCH_REFERENCE &aRef, const wxString &aFieldName)

void	Sort ()

void	updateDataStoreSymbolField (const SCH_REFERENCE &aSymbolRef, const wxString &aFieldName, const wxString &aVariantName)

Static Private Member Functions
static bool	cmp (const DATA_MODEL_ROW &lhGroup, const DATA_MODEL_ROW &rhGroup, FIELDS_EDITOR_GRID_DATA_MODEL *dataModel, int sortCol, bool ascending)

Detailed Description

Definition at line 136 of file fields_data_model.h.

Member Enumeration Documentation

◆ SCOPE

enum FIELDS_EDITOR_GRID_DATA_MODEL::SCOPE : int

Enumerator
SCOPE_ALL
SCOPE_SHEET
SCOPE_SHEET_RECURSIVE

Definition at line 139 of file fields_data_model.h.

Constructor & Destructor Documentation

◆ FIELDS_EDITOR_GRID_DATA_MODEL()

FIELDS_EDITOR_GRID_DATA_MODEL::FIELDS_EDITOR_GRID_DATA_MODEL	(	const SCH_REFERENCE_LIST &	aSymbolsList,
		wxGridCellAttr *	aURLEditor )

inline

Definition at line 146 of file fields_data_model.h.

References m_edited, m_excludeDNP, m_groupingEnabled, m_includeExcluded, m_rebuildsEnabled, m_scope, m_sortAscending, m_sortColumn, m_symbolsList, m_textVarRenderer, m_urlEditor, and SCOPE_ALL.

Referenced by cmp().

◆ ~FIELDS_EDITOR_GRID_DATA_MODEL()

FIELDS_EDITOR_GRID_DATA_MODEL::~FIELDS_EDITOR_GRID_DATA_MODEL ( )

inlineoverride

Definition at line 162 of file fields_data_model.h.

References m_textVarRenderer, and m_urlEditor.

Member Function Documentation

◆ AddColumn()

void FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn	(	const wxString &	aFieldName,
		const wxString &	aLabel,
		bool	aAddedByUser,
		const wxString &	aVariantName )

Definition at line 244 of file fields_data_model.cpp.

References GetFieldNameCol(), m_cols, m_symbolsList, and updateDataStoreSymbolField().

Referenced by ApplyBomPreset(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ AddReferences()

void FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences ( const SCH_REFERENCE_LIST & aRefs )

Definition at line 1575 of file fields_data_model.cpp.

References SCHEMATIC::ConvertKIIDsToRefs(), SCH_SYMBOL::GetFields(), m_dataStore, m_symbolsList, makeDataStoreKey(), name, and SCH_ITEM::Schematic().

◆ ApplyBomPreset()

void FIELDS_EDITOR_GRID_DATA_MODEL::ApplyBomPreset	(	const BOM_PRESET &	preset,
		const wxString &	aVariantName )

◆ ApplyData()

void FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData	(	SCH_COMMIT &	aCommit,
		TEMPLATES &	aTemplateFieldnames,
		const wxString &	aVariantName )

◆ Clear()

void WX_GRID_TABLE_BASE::Clear ( )

inlineoverrideinherited

Definition at line 82 of file wx_grid.h.

◆ cmp()

bool FIELDS_EDITOR_GRID_DATA_MODEL::cmp	(	const DATA_MODEL_ROW &	lhGroup,
		const DATA_MODEL_ROW &	rhGroup,
		FIELDS_EDITOR_GRID_DATA_MODEL *	dataModel,
		int	sortCol,
		bool	ascending )

staticprivate

Definition at line 747 of file fields_data_model.cpp.

References ColIsReference(), FIELDS_EDITOR_GRID_DATA_MODEL(), GetNumberCols(), GetValue(), DATA_MODEL_ROW::m_Refs, StrNumCmp(), and ValueStringCompare().

◆ ColIsAttribute()

bool FIELDS_EDITOR_GRID_DATA_MODEL::ColIsAttribute ( int aCol )

Definition at line 740 of file fields_data_model.cpp.

References isAttribute(), and m_cols.

Referenced by SetValue().

◆ ColIsItemNumber()

bool FIELDS_EDITOR_GRID_DATA_MODEL::ColIsItemNumber ( int aCol )

Definition at line 733 of file fields_data_model.cpp.

References ITEM_NUMBER_VARIABLE, and m_cols.

Referenced by GetAttr(), and GetValue().

◆ ColIsQuantity()

bool FIELDS_EDITOR_GRID_DATA_MODEL::ColIsQuantity ( int aCol )

Definition at line 726 of file fields_data_model.cpp.

References m_cols, and QUANTITY_VARIABLE.

Referenced by GetAttr(), and GetValue().

◆ ColIsReference()

bool FIELDS_EDITOR_GRID_DATA_MODEL::ColIsReference ( int aCol )

Definition at line 712 of file fields_data_model.cpp.

References GetCanonicalFieldName(), m_cols, and REFERENCE.

Referenced by cmp(), GetAttr(), GetDataWidth(), GetValue(), and SetValue().

◆ ColIsValue()

bool FIELDS_EDITOR_GRID_DATA_MODEL::ColIsValue ( int aCol )

Definition at line 719 of file fields_data_model.cpp.

References GetCanonicalFieldName(), m_cols, and VALUE.

◆ CollapseForSort()

void FIELDS_EDITOR_GRID_DATA_MODEL::CollapseForSort ( )

Definition at line 1243 of file fields_data_model.cpp.

References CollapseRow(), GROUP_COLLAPSED_DURING_SORT, GROUP_EXPANDED, and m_rows.

Referenced by Sort().

◆ CollapseRow()

void FIELDS_EDITOR_GRID_DATA_MODEL::CollapseRow ( int aRow )

Definition at line 1212 of file fields_data_model.cpp.

References GROUP_COLLAPSED, and m_rows.

Referenced by CollapseForSort(), and ExpandCollapseRow().

◆ DeleteRows()

bool FIELDS_EDITOR_GRID_DATA_MODEL::DeleteRows	(	size_t	aPosition = 0,
		size_t	aNumRows = 1 )

override

Definition at line 1685 of file fields_data_model.cpp.

References m_dataStore, and m_rows.

◆ DisableRebuilds()

void FIELDS_EDITOR_GRID_DATA_MODEL::DisableRebuilds ( )

Definition at line 1033 of file fields_data_model.cpp.

References m_rebuildsEnabled.

◆ EnableRebuilds()

void FIELDS_EDITOR_GRID_DATA_MODEL::EnableRebuilds ( )

Definition at line 1027 of file fields_data_model.cpp.

References m_rebuildsEnabled.

◆ enhanceAttr()

wxGridCellAttr * WX_GRID_TABLE_BASE::enhanceAttr	(	wxGridCellAttr *	aInputAttr,
		int	aRow,
		int	aCol,
		wxGridCellAttr::wxAttrKind	aKind )

protectedinherited

Definition at line 47 of file wx_grid.cpp.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), FIELDS_GRID_TABLE::GetAttr(), LAYERS_GRID_TABLE::GetAttr(), LIB_TABLE_GRID_DATA_MODEL::GetAttr(), PCB_FIELDS_GRID_TABLE::GetAttr(), SCH_PIN_TABLE_DATA_MODEL::GetAttr(), and GetAttr().

◆ ExpandAfterSort()

void FIELDS_EDITOR_GRID_DATA_MODEL::ExpandAfterSort ( )

Definition at line 1256 of file fields_data_model.cpp.

References ExpandRow(), GROUP_COLLAPSED_DURING_SORT, and m_rows.

Referenced by Sort().

◆ ExpandCollapseRow()

void FIELDS_EDITOR_GRID_DATA_MODEL::ExpandCollapseRow ( int aRow )

Definition at line 1232 of file fields_data_model.cpp.

References CollapseRow(), ExpandRow(), group, GROUP_COLLAPSED, GROUP_EXPANDED, and m_rows.

◆ ExpandRow()

void FIELDS_EDITOR_GRID_DATA_MODEL::ExpandRow ( int aRow )

Definition at line 1170 of file fields_data_model.cpp.

References GROUP_EXPANDED, m_rows, and unitMatch().

Referenced by ExpandAfterSort(), and ExpandCollapseRow().

◆ Export()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::Export ( const BOM_FMT_PRESET & settings )

Definition at line 1499 of file fields_data_model.cpp.

References BOM_FMT_PRESET::fieldDelimiter, GetExportValue(), GetRowFlags(), BOM_FMT_PRESET::keepLineBreaks, BOM_FMT_PRESET::keepTabs, m_cols, m_rows, BOM_FMT_PRESET::refDelimiter, BOM_FMT_PRESET::refRangeDelimiter, and BOM_FMT_PRESET::stringDelimiter.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ GetAttr()

wxGridCellAttr * FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr	(	int	aRow,
		int	aCol,
		wxGridCellAttr::wxAttrKind	aKind )

override

◆ getAttributeValue()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue	(	const SCH_REFERENCE &	aRef,
		const wxString &	aAttributeName,
		const wxString &	aVariantNames )

private

Definition at line 943 of file fields_data_model.cpp.

References SCH_REFERENCE::GetSymbolDNP(), SCH_REFERENCE::GetSymbolExcludedFromBoard(), SCH_REFERENCE::GetSymbolExcludedFromBOM(), and SCH_REFERENCE::GetSymbolExcludedFromSim().

Referenced by getDefaultFieldValue(), and updateDataStoreSymbolField().

◆ GetBomSettings()

BOM_PRESET FIELDS_EDITOR_GRID_DATA_MODEL::GetBomSettings ( )

Definition at line 1480 of file fields_data_model.cpp.

References BOM_PRESET::excludeDNP, BOM_PRESET::fieldsOrdered, BOM_PRESET::filterString, GetColFieldName(), GetExcludeDNP(), GetFieldsOrdered(), GetFilter(), GetGroupingEnabled(), GetIncludeExcludedFromBOM(), GetNumberCols(), GetSortAsc(), GetSortCol(), BOM_PRESET::groupSymbols, BOM_PRESET::includeExcludedFromBOM, BOM_PRESET::readOnly, BOM_PRESET::sortAsc, and BOM_PRESET::sortField.

◆ GetColFieldName()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::GetColFieldName ( int aCol )

inline

Definition at line 211 of file fields_data_model.h.

References m_cols.

Referenced by GetAttr(), GetBomSettings(), and GetDataWidth().

◆ GetColLabelValue()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::GetColLabelValue ( int aCol )

inlineoverride

Definition at line 205 of file fields_data_model.h.

References m_cols.

◆ GetCurrentVariant()

const wxString & FIELDS_EDITOR_GRID_DATA_MODEL::GetCurrentVariant ( ) const

inline

Definition at line 361 of file fields_data_model.h.

References m_currentVariant.

◆ GetDataWidth()

int FIELDS_EDITOR_GRID_DATA_MODEL::GetDataWidth ( int aCol )

Definition at line 1391 of file fields_data_model.cpp.

References ColIsReference(), GetColFieldName(), GetNumberRows(), KIUI::GetTextSize(), GetValue(), m_dataStore, m_symbolsList, makeDataStoreKey(), and text.

◆ getDefaultFieldValue()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::getDefaultFieldValue	(	const SCH_REFERENCE &	aRef,
		const wxString &	aFieldName )

private

Get the default (non-variant) value for a field.

This retrieves the field value as it would appear without any variant override.

Parameters

aRef	The symbol reference.
aFieldName	The name of the field.

Returns: The default field value.

Definition at line 962 of file fields_data_model.cpp.

References SCHEMATIC::ConvertKIIDsToRefs(), getAttributeValue(), SCH_SYMBOL::GetField(), SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), isAttribute(), IsGeneratedField(), and SCH_ITEM::Schematic().

Referenced by GetAttr().

◆ GetExcludeDNP()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetExcludeDNP ( )

inline

Definition at line 313 of file fields_data_model.h.

References m_excludeDNP.

Referenced by GetBomSettings().

◆ GetExportValue()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::GetExportValue	(	int	aRow,
		int	aCol,
		const wxString &	refDelimiter,
		const wxString &	refRangeDelimiter )

inline

Definition at line 237 of file fields_data_model.h.

References GetValue(), and m_rows.

Referenced by Export().

◆ GetFieldNameCol()

int FIELDS_EDITOR_GRID_DATA_MODEL::GetFieldNameCol ( const wxString & aFieldName ) const

Definition at line 340 of file fields_data_model.cpp.

References m_cols.

Referenced by AddColumn(), ApplyBomPreset(), ApplyData(), groupMatch(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ getFieldShownText()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::getFieldShownText	(	const SCH_REFERENCE &	aRef,
		const wxString &	aFieldName )

private

Definition at line 901 of file fields_data_model.cpp.

References ExpandTextVars(), SCH_SYMBOL::GetField(), SCH_REFERENCE::GetSheetPath(), SCH_FIELD::GetShownText(), SCH_REFERENCE::GetSymbol(), IsGeneratedField(), SCH_ITEM::IsPrivate(), path, and SCH_SYMBOL::ResolveTextVar().

Referenced by GetValue(), and groupMatch().

◆ GetFieldsOrdered()

std::vector< BOM_FIELD > FIELDS_EDITOR_GRID_DATA_MODEL::GetFieldsOrdered ( )

Definition at line 352 of file fields_data_model.cpp.

References m_cols.

Referenced by GetBomSettings(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ GetFilter()

const wxString & FIELDS_EDITOR_GRID_DATA_MODEL::GetFilter ( )

inline

Definition at line 294 of file fields_data_model.h.

References m_filter.

Referenced by GetBomSettings().

◆ GetGroupColumn()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetGroupColumn ( int aCol )

inline

Definition at line 321 of file fields_data_model.h.

References m_cols.

◆ GetGroupingEnabled()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetGroupingEnabled ( )

inline

Definition at line 303 of file fields_data_model.h.

References m_groupingEnabled.

Referenced by GetBomSettings().

◆ GetGroupType()

GROUP_TYPE FIELDS_EDITOR_GRID_DATA_MODEL::GetGroupType ( int aRow ) const

inlineoverridevirtual

Reimplemented from WX_GRID_TABLE_BASE.

Definition at line 260 of file fields_data_model.h.

References GROUP_TYPE, and m_rows.

◆ GetIncludeExcludedFromBOM()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetIncludeExcludedFromBOM ( )

inline

Definition at line 310 of file fields_data_model.h.

References m_includeExcluded.

Referenced by GetBomSettings().

◆ GetNumberCols()

int FIELDS_EDITOR_GRID_DATA_MODEL::GetNumberCols ( )

inlineoverride

Definition at line 197 of file fields_data_model.h.

References m_cols.

Referenced by cmp(), and GetBomSettings().

◆ GetNumberRows()

int FIELDS_EDITOR_GRID_DATA_MODEL::GetNumberRows ( )

inlineoverride

Definition at line 196 of file fields_data_model.h.

References m_rows.

Referenced by GetDataWidth().

◆ GetPath()

const SCH_SHEET_PATH & FIELDS_EDITOR_GRID_DATA_MODEL::GetPath ( )

inline

Definition at line 300 of file fields_data_model.h.

References m_path.

◆ GetReferenceList()

const SCH_REFERENCE_LIST & FIELDS_EDITOR_GRID_DATA_MODEL::GetReferenceList ( ) const

inline

Definition at line 350 of file fields_data_model.h.

References m_symbolsList.

◆ GetResolvedValue()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::GetResolvedValue	(	int	aRow,
		int	aCol )

Definition at line 405 of file fields_data_model.cpp.

References GetValue(), and m_rows.

◆ GetRowFlags()

GROUP_TYPE FIELDS_EDITOR_GRID_DATA_MODEL::GetRowFlags ( int aRow )

inline

Definition at line 245 of file fields_data_model.h.

References GROUP_TYPE, and m_rows.

Referenced by Export().

◆ GetRowReferences()

std::vector< SCH_REFERENCE > FIELDS_EDITOR_GRID_DATA_MODEL::GetRowReferences ( int aRow ) const

inline

Definition at line 247 of file fields_data_model.h.

References m_rows.

◆ GetScope()

SCOPE FIELDS_EDITOR_GRID_DATA_MODEL::GetScope ( )

inline

Definition at line 297 of file fields_data_model.h.

References m_scope.

◆ GetShowColumn()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetShowColumn ( int aCol )

inline

Definition at line 333 of file fields_data_model.h.

References m_cols.

◆ GetSortAsc()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetSortAsc ( )

inline

Definition at line 273 of file fields_data_model.h.

References m_sortAscending.

Referenced by GetBomSettings().

◆ GetSortCol()

int FIELDS_EDITOR_GRID_DATA_MODEL::GetSortCol ( )

inline

Definition at line 272 of file fields_data_model.h.

References m_sortColumn.

Referenced by GetBomSettings().

◆ GetValue() [1/2]

wxString FIELDS_EDITOR_GRID_DATA_MODEL::GetValue	(	const DATA_MODEL_ROW &	group,
		int	aCol,
		const wxString &	refDelimiter = wxT( ", " ),
		const wxString &	refRangDelimiter = wxT( "-" ),
		bool	resolveVars = false,
		bool	listMixedValues = false )

Definition at line 546 of file fields_data_model.cpp.

References ColIsItemNumber(), ColIsQuantity(), ColIsReference(), ExpandTextVars(), getFieldShownText(), SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), group, INDETERMINATE_STATE, IsGeneratedField(), m_cols, m_dataStore, makeDataStoreKey(), SCH_SYMBOL::ResolveTextVar(), and SCH_REFERENCE_LIST::Shorthand().

◆ GetValue() [2/2]

wxString FIELDS_EDITOR_GRID_DATA_MODEL::GetValue	(	int	aRow,
		int	aCol )

override

Definition at line 398 of file fields_data_model.cpp.

References GetValue(), IsExpanderColumn(), and m_rows.

Referenced by cmp(), GetAttr(), GetDataWidth(), GetExportValue(), GetResolvedValue(), and GetValue().

◆ GetVariantNames()

const std::vector< wxString > & FIELDS_EDITOR_GRID_DATA_MODEL::GetVariantNames ( ) const

inline

Definition at line 364 of file fields_data_model.h.

References m_variantNames.

◆ groupMatch()

bool FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch	(	const SCH_REFERENCE &	lhRef,
		const SCH_REFERENCE &	rhRef )

private

Definition at line 834 of file fields_data_model.cpp.

References GetCanonicalFieldName(), GetFieldNameCol(), getFieldShownText(), SCH_REFERENCE::GetRef(), SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), IsGeneratedField(), m_cols, m_dataStore, makeDataStoreKey(), and REFERENCE.

Referenced by RebuildRows().

◆ isAttribute()

bool FIELDS_EDITOR_GRID_DATA_MODEL::isAttribute ( const wxString & aFieldName )

private

Definition at line 934 of file fields_data_model.cpp.

Referenced by ApplyData(), ColIsAttribute(), getDefaultFieldValue(), and updateDataStoreSymbolField().

◆ IsEdited()

bool FIELDS_EDITOR_GRID_DATA_MODEL::IsEdited ( )

inline

Definition at line 289 of file fields_data_model.h.

References m_edited.

◆ IsEmptyCell()

bool FIELDS_EDITOR_GRID_DATA_MODEL::IsEmptyCell	(	int	aRow,
		int	aCol )

inlineoverride

Definition at line 222 of file fields_data_model.h.

◆ IsExpanderColumn()

bool FIELDS_EDITOR_GRID_DATA_MODEL::IsExpanderColumn ( int aCol ) const

overridevirtual

Reimplemented from WX_GRID_TABLE_BASE.

Definition at line 385 of file fields_data_model.cpp.

References m_cols.

Referenced by GetValue().

◆ MoveColumn()

void FIELDS_EDITOR_GRID_DATA_MODEL::MoveColumn	(	int	aCol,
		int	aNewPos )

inline

Definition at line 176 of file fields_data_model.h.

References m_cols.

◆ RebuildRows()

void FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows ( )

◆ RemoveColumn()

void FIELDS_EDITOR_GRID_DATA_MODEL::RemoveColumn ( int aCol )

Definition at line 299 of file fields_data_model.cpp.

References grid, m_cols, m_dataStore, m_symbolsList, and makeDataStoreKey().

◆ RemoveReferences()

void FIELDS_EDITOR_GRID_DATA_MODEL::RemoveReferences ( const SCH_REFERENCE_LIST & aRefs )

Definition at line 1640 of file fields_data_model.cpp.

References index, m_dataStore, m_symbolsList, and makeDataStoreKey().

◆ RemoveSymbol()

void FIELDS_EDITOR_GRID_DATA_MODEL::RemoveSymbol ( const SCH_SYMBOL & aSymbol )

Definition at line 1610 of file fields_data_model.cpp.

References m_dataStore, m_symbolsList, and EDA_ITEM::m_Uuid.

◆ RenameColumn()

void FIELDS_EDITOR_GRID_DATA_MODEL::RenameColumn	(	int	aCol,
		const wxString &	newName )

Definition at line 320 of file fields_data_model.cpp.

References m_cols, m_dataStore, m_symbolsList, and makeDataStoreKey().

◆ setAttributeValue()

bool FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue	(	SCH_REFERENCE &	aRef,
		const wxString &	aAttributeName,
		const wxString &	aValue,
		const wxString &	aVariantName = wxEmptyString )

private

Set the attribute value.

Parameters

aReference	is a reference to the symbol to set the attribute.
aAttributeName	is the name of the symbol attribute.
aValue	is the value to set the attribute.
aVariantName	is an optional variant name to set the variant attribute.

Return values

true	if the symbol attribute value has changed.
false	if the symbol attribute has not changed.

Definition at line 994 of file fields_data_model.cpp.

References SCH_REFERENCE::GetSymbolDNP(), SCH_REFERENCE::GetSymbolExcludedFromBoard(), SCH_REFERENCE::GetSymbolExcludedFromBOM(), SCH_REFERENCE::GetSymbolExcludedFromSim(), SCH_REFERENCE::SetSymbolDNP(), SCH_REFERENCE::SetSymbolExcludedFromBoard(), SCH_REFERENCE::SetSymbolExcludedFromBOM(), and SCH_REFERENCE::SetSymbolExcludedFromSim().

Referenced by ApplyData().

◆ SetColAttr()

void WX_GRID_TABLE_BASE::SetColAttr	(	wxGridCellAttr *	aAttr,
		int	aCol )

inlineoverrideinherited

Definition at line 62 of file wx_grid.h.

References m_colAttrs.

◆ SetColLabelValue()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetColLabelValue	(	int	aCol,
		const wxString &	aLabel )

inlineoverride

Definition at line 199 of file fields_data_model.h.

References m_cols.

Referenced by ApplyBomPreset().

◆ SetCurrentVariant()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetCurrentVariant ( const wxString & aVariantName )

inline

Set the current variant name for highlighting purposes.

When a variant is set, cells that differ from the default (non-variant) value will be highlighted.

Parameters

aVariantName The name of the current variant, or empty string for default.

Definition at line 360 of file fields_data_model.h.

References m_currentVariant.

Referenced by ApplyBomPreset(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ SetExcludeDNP()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetExcludeDNP ( bool exclude )

inline

Definition at line 312 of file fields_data_model.h.

References m_excludeDNP.

Referenced by ApplyBomPreset().

◆ SetFieldsOrder()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetFieldsOrder ( const std::vector< wxString > & aNewOrder )

Definition at line 363 of file fields_data_model.cpp.

References m_cols.

Referenced by ApplyBomPreset().

◆ SetFilter()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetFilter ( const wxString & aFilter )

inline

Definition at line 293 of file fields_data_model.h.

References m_filter.

Referenced by ApplyBomPreset().

◆ SetGroupColumn()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetGroupColumn	(	int	aCol,
		bool	group )

inline

Definition at line 315 of file fields_data_model.h.

References group, and m_cols.

Referenced by ApplyBomPreset().

◆ SetGroupingEnabled()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetGroupingEnabled ( bool group )

inline

Definition at line 302 of file fields_data_model.h.

References group, and m_groupingEnabled.

Referenced by ApplyBomPreset().

◆ SetIncludeExcludedFromBOM()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetIncludeExcludedFromBOM ( bool include )

inline

Definition at line 309 of file fields_data_model.h.

References m_includeExcluded.

Referenced by ApplyBomPreset().

◆ SetPath()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetPath ( const SCH_SHEET_PATH & aPath )

inline

Definition at line 299 of file fields_data_model.h.

References m_path.

◆ SetScope()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetScope ( SCOPE aScope )

inline

Definition at line 296 of file fields_data_model.h.

References m_scope.

◆ SetShowColumn()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetShowColumn	(	int	aCol,
		bool	show )

inline

Definition at line 327 of file fields_data_model.h.

References m_cols.

Referenced by ApplyBomPreset().

◆ SetSorting()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetSorting	(	int	aCol,
		bool	ascending )

inline

Definition at line 265 of file fields_data_model.h.

References m_cols, m_sortAscending, and m_sortColumn.

Referenced by ApplyBomPreset().

◆ SetValue()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetValue	(	int	aRow,
		int	aCol,
		const wxString &	aValue )

override

Definition at line 655 of file fields_data_model.cpp.

References ColIsAttribute(), ColIsReference(), SCH_SCREEN::GetRefCount(), SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), GROUP_SINGLETON, IsGeneratedField(), m_cols, m_dataStore, m_edited, DATA_MODEL_ROW::m_Flag, DATA_MODEL_ROW::m_Refs, m_rows, and makeDataStoreKey().

◆ SetVariantNames()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetVariantNames ( const std::vector< wxString > & aVariantNames )

inline

Definition at line 363 of file fields_data_model.h.

References m_variantNames.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ Sort()

void FIELDS_EDITOR_GRID_DATA_MODEL::Sort ( )

private

Definition at line 789 of file fields_data_model.cpp.

References CollapseForSort(), ExpandAfterSort(), and m_rows.

Referenced by RebuildRows().

◆ unitMatch()

bool FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch	(	const SCH_REFERENCE &	lhRef,
		const SCH_REFERENCE &	rhRef )

private

Definition at line 824 of file fields_data_model.cpp.

References SCH_REFERENCE::GetRef(), and SCH_REFERENCE::GetRefNumber().

Referenced by ExpandRow(), and RebuildRows().

◆ updateDataStoreSymbolField()

void FIELDS_EDITOR_GRID_DATA_MODEL::updateDataStoreSymbolField	(	const SCH_REFERENCE &	aSymbolRef,
		const wxString &	aFieldName,
		const wxString &	aVariantName )

private

Definition at line 258 of file fields_data_model.cpp.

References SCHEMATIC::ConvertKIIDsToRefs(), SCH_SYMBOL::FindFieldCaseInsensitive(), getAttributeValue(), SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), isAttribute(), IsGeneratedField(), m_dataStore, makeDataStoreKey(), and SCH_ITEM::Schematic().

Referenced by AddColumn(), and UpdateReferences().

◆ UpdateReferences()

void FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences	(	const SCH_REFERENCE_LIST &	aRefs,
		const wxString &	aVariantName )

Definition at line 1656 of file fields_data_model.cpp.

References m_cols, m_symbolsList, and updateDataStoreSymbolField().

Member Data Documentation

◆ ITEM_NUMBER_VARIABLE

const wxString FIELDS_EDITOR_GRID_DATA_MODEL::ITEM_NUMBER_VARIABLE = wxS( "${ITEM_NUMBER}" )

static

Definition at line 169 of file fields_data_model.h.

Referenced by ColIsItemNumber(), EESCHEMA_JOBS_HANDLER::JobExportBom(), and DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames().

◆ m_colAttrs

std::map<int, wxGridCellAttr*> WX_GRID_TABLE_BASE::m_colAttrs

protectedinherited

Definition at line 93 of file wx_grid.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), GetAttr(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::RemoveColumn(), SetColAttr(), and ~WX_GRID_TABLE_BASE().

◆ m_cols

std::vector<DATA_MODEL_COL> FIELDS_EDITOR_GRID_DATA_MODEL::m_cols

protected

◆ m_currentVariant

wxString FIELDS_EDITOR_GRID_DATA_MODEL::m_currentVariant

protected

Current variant name for highlighting.

Definition at line 434 of file fields_data_model.h.

Referenced by GetAttr(), GetCurrentVariant(), RebuildRows(), and SetCurrentVariant().

◆ m_dataStore

std::map<KIID_PATH, std::map<wxString, wxString> > FIELDS_EDITOR_GRID_DATA_MODEL::m_dataStore

protected

Definition at line 444 of file fields_data_model.h.

Referenced by AddReferences(), ApplyData(), DeleteRows(), GetAttr(), GetDataWidth(), GetValue(), groupMatch(), RemoveColumn(), RemoveReferences(), RemoveSymbol(), RenameColumn(), SetValue(), and updateDataStoreSymbolField().

◆ m_edited

bool FIELDS_EDITOR_GRID_DATA_MODEL::m_edited

protected

Definition at line 422 of file fields_data_model.h.

Referenced by ApplyData(), FIELDS_EDITOR_GRID_DATA_MODEL(), IsEdited(), and SetValue().

◆ m_excludeDNP

bool FIELDS_EDITOR_GRID_DATA_MODEL::m_excludeDNP

protected

Definition at line 429 of file fields_data_model.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL(), GetExcludeDNP(), RebuildRows(), and SetExcludeDNP().

◆ m_filter

wxString FIELDS_EDITOR_GRID_DATA_MODEL::m_filter

protected

Definition at line 425 of file fields_data_model.h.

Referenced by GetFilter(), RebuildRows(), and SetFilter().

◆ m_groupingEnabled

bool FIELDS_EDITOR_GRID_DATA_MODEL::m_groupingEnabled

protected

Definition at line 428 of file fields_data_model.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL(), GetGroupingEnabled(), RebuildRows(), and SetGroupingEnabled().

◆ m_includeExcluded

bool FIELDS_EDITOR_GRID_DATA_MODEL::m_includeExcluded

protected

Definition at line 430 of file fields_data_model.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL(), GetIncludeExcludedFromBOM(), RebuildRows(), and SetIncludeExcludedFromBOM().

◆ m_path

SCH_SHEET_PATH FIELDS_EDITOR_GRID_DATA_MODEL::m_path

protected

Definition at line 427 of file fields_data_model.h.

Referenced by GetPath(), RebuildRows(), and SetPath().

◆ m_rebuildsEnabled

bool FIELDS_EDITOR_GRID_DATA_MODEL::m_rebuildsEnabled

protected

Definition at line 431 of file fields_data_model.h.

Referenced by DisableRebuilds(), EnableRebuilds(), FIELDS_EDITOR_GRID_DATA_MODEL(), and RebuildRows().

◆ m_rows

std::vector<DATA_MODEL_ROW> FIELDS_EDITOR_GRID_DATA_MODEL::m_rows

protected

Definition at line 438 of file fields_data_model.h.

Referenced by CollapseForSort(), CollapseRow(), DeleteRows(), ExpandAfterSort(), ExpandCollapseRow(), ExpandRow(), Export(), GetAttr(), GetExportValue(), GetGroupType(), GetNumberRows(), GetResolvedValue(), GetRowFlags(), GetRowReferences(), GetValue(), RebuildRows(), SetValue(), and Sort().

◆ m_scope

SCOPE FIELDS_EDITOR_GRID_DATA_MODEL::m_scope

protected

Definition at line 426 of file fields_data_model.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL(), GetScope(), RebuildRows(), and SetScope().

◆ m_sortAscending

bool FIELDS_EDITOR_GRID_DATA_MODEL::m_sortAscending

protected

Definition at line 424 of file fields_data_model.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL(), GetSortAsc(), and SetSorting().

◆ m_sortColumn

int FIELDS_EDITOR_GRID_DATA_MODEL::m_sortColumn

protected

Definition at line 423 of file fields_data_model.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL(), GetSortCol(), and SetSorting().

◆ m_symbolsList

SCH_REFERENCE_LIST FIELDS_EDITOR_GRID_DATA_MODEL::m_symbolsList

protected

The flattened by hierarchy list of symbols.

Warning: This list must be kept sorted by symbol pointer. Otherwise, the undo/redo commit actions will be broken.

Definition at line 421 of file fields_data_model.h.

Referenced by AddColumn(), AddReferences(), ApplyData(), FIELDS_EDITOR_GRID_DATA_MODEL(), GetDataWidth(), GetReferenceList(), RebuildRows(), RemoveColumn(), RemoveReferences(), RemoveSymbol(), RenameColumn(), and UpdateReferences().

◆ m_textVarRenderer

wxGridCellRenderer* FIELDS_EDITOR_GRID_DATA_MODEL::m_textVarRenderer

protected

Renderer for cells with text variable references.

Definition at line 433 of file fields_data_model.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL(), GetAttr(), and ~FIELDS_EDITOR_GRID_DATA_MODEL().

◆ m_urlEditor

wxGridCellAttr* FIELDS_EDITOR_GRID_DATA_MODEL::m_urlEditor

protected

Definition at line 432 of file fields_data_model.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL(), GetAttr(), and ~FIELDS_EDITOR_GRID_DATA_MODEL().

◆ m_variantNames

std::vector<wxString> FIELDS_EDITOR_GRID_DATA_MODEL::m_variantNames

protected

Variant names for multi-variant DNP filtering.

Definition at line 435 of file fields_data_model.h.

Referenced by GetVariantNames(), RebuildRows(), and SetVariantNames().

◆ QUANTITY_VARIABLE

const wxString FIELDS_EDITOR_GRID_DATA_MODEL::QUANTITY_VARIABLE = wxS( "${QUANTITY}" )

static

Definition at line 168 of file fields_data_model.h.

Referenced by ColIsQuantity(), EESCHEMA_JOBS_HANDLER::JobExportBom(), and DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames().

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ SCOPE

Constructor & Destructor Documentation

◆ FIELDS_EDITOR_GRID_DATA_MODEL()

◆ ~FIELDS_EDITOR_GRID_DATA_MODEL()

Member Function Documentation

◆ AddColumn()

◆ AddReferences()

◆ ApplyBomPreset()

◆ ApplyData()

◆ Clear()

◆ cmp()

◆ ColIsAttribute()

◆ ColIsItemNumber()

◆ ColIsQuantity()

◆ ColIsReference()

◆ ColIsValue()

◆ CollapseForSort()

◆ CollapseRow()

◆ DeleteRows()

◆ DisableRebuilds()

◆ EnableRebuilds()

◆ enhanceAttr()

◆ ExpandAfterSort()

◆ ExpandCollapseRow()

◆ ExpandRow()

◆ Export()

◆ GetAttr()

◆ getAttributeValue()

◆ GetBomSettings()

◆ GetColFieldName()

◆ GetColLabelValue()

◆ GetCurrentVariant()

◆ GetDataWidth()

◆ getDefaultFieldValue()

◆ GetExcludeDNP()

◆ GetExportValue()

◆ GetFieldNameCol()

◆ getFieldShownText()

◆ GetFieldsOrdered()

◆ GetFilter()

◆ GetGroupColumn()

◆ GetGroupingEnabled()

◆ GetGroupType()

◆ GetIncludeExcludedFromBOM()

◆ GetNumberCols()

◆ GetNumberRows()

◆ GetPath()

◆ GetReferenceList()

◆ GetResolvedValue()

◆ GetRowFlags()

◆ GetRowReferences()

◆ GetScope()

◆ GetShowColumn()

◆ GetSortAsc()

◆ GetSortCol()

◆ GetValue() [1/2]

◆ GetValue() [2/2]

◆ GetVariantNames()

◆ groupMatch()

◆ isAttribute()

◆ IsEdited()

◆ IsEmptyCell()

◆ IsExpanderColumn()

◆ MoveColumn()

◆ RebuildRows()

◆ RemoveColumn()

◆ RemoveReferences()

◆ RemoveSymbol()

◆ RenameColumn()

◆ setAttributeValue()

◆ SetColAttr()