KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | List of all members
FIELDS_EDITOR_GRID_DATA_MODEL Class Reference

#include <fields_data_model.h>

Inheritance diagram for FIELDS_EDITOR_GRID_DATA_MODEL:
WX_GRID_TABLE_BASE

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 std::set< wxString > &aVariantNames)
 
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
 
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, std::set< wxString > &aVariantNames)
 
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 std::set< wxString > &aVariantNames)
 
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 std::set< wxString > &aVariantNames)
 
void SetColAttr (wxGridCellAttr *aAttr, int aCol) 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
 
std::vector< DATA_MODEL_COL > m_cols
 
std::vector< DATA_MODEL_ROW > m_rows
 
std::map< KIID, 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_SYMBOL &, const wxString &aAttributeName, const std::set< wxString > &aVariantNames)
 
bool setAttributeValue (SCH_SYMBOL &aSymbol, 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 std::set< wxString > &aVariantNames)
 

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 122 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 125 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 132 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_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 147 of file fields_data_model.h.

References m_urlEditor.

Member Function Documentation

◆ AddColumn()

void FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn ( const wxString & aFieldName,
const wxString & aLabel,
bool aAddedByUser,
const std::set< wxString > & aVariantNames )

Definition at line 187 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 1341 of file fields_data_model.cpp.

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

◆ ApplyBomPreset()

void FIELDS_EDITOR_GRID_DATA_MODEL::ApplyBomPreset ( const BOM_PRESET & preset,
const std::set< wxString > & aVariantNames )

Definition at line 1184 of file fields_data_model.cpp.

References AddColumn(), BOM_PRESET::excludeDNP, BOM_PRESET::fieldsOrdered, BOM_PRESET::filterString, GetCanonicalFieldName(), GetFieldNameCol(), BOM_FIELD::groupBy, BOM_PRESET::groupSymbols, BOM_PRESET::includeExcludedFromBOM, BOM_FIELD::label, m_cols, BOM_FIELD::name, RebuildRows(), REFERENCE, SetColLabelValue(), SetExcludeDNP(), SetFieldsOrder(), SetFilter(), SetGroupColumn(), SetGroupingEnabled(), SetIncludeExcludedFromBOM(), SetShowColumn(), SetSorting(), BOM_FIELD::show, BOM_PRESET::sortAsc, and BOM_PRESET::sortField.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ ApplyData()

void FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData ( SCH_COMMIT & aCommit,
TEMPLATES & aTemplateFieldnames,
std::set< wxString > & aVariantNames )

Definition at line 1009 of file fields_data_model.cpp.

References SCH_SYMBOL::AddField(), SCH_SYMBOL::AddVariant(), SCHEMATIC::ConvertRefsToKIIDs(), SCH_SYMBOL::GetField(), TEMPLATES::GetFieldName(), GetFieldNameCol(), SCH_SYMBOL::GetFields(), SCH_FIELD::GetId(), SCH_SYMBOL::GetPosition(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), SCH_SYMBOL::GetVariant(), isAttribute(), IsGeneratedField(), SCH_ITEM::IsPrivate(), m_cols, m_dataStore, m_edited, VARIANT::m_Fields, m_symbolsList, EDA_ITEM::m_Uuid, COMMIT::Modified(), multipleValues, name, REFERENCE, SCH_ITEM::Schematic(), setAttributeValue(), SCH_ITEM::SetPrivate(), SCH_FIELD::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetVisible(), and USER.

◆ 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 532 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 525 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 518 of file fields_data_model.cpp.

References ITEM_NUMBER_VARIABLE, and m_cols.

Referenced by GetValue().

◆ ColIsQuantity()

bool FIELDS_EDITOR_GRID_DATA_MODEL::ColIsQuantity ( int aCol)

Definition at line 511 of file fields_data_model.cpp.

References m_cols, and QUANTITY_VARIABLE.

Referenced by GetValue().

◆ ColIsReference()

bool FIELDS_EDITOR_GRID_DATA_MODEL::ColIsReference ( int aCol)

Definition at line 497 of file fields_data_model.cpp.

References GetCanonicalFieldName(), m_cols, and REFERENCE.

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

◆ ColIsValue()

bool FIELDS_EDITOR_GRID_DATA_MODEL::ColIsValue ( int aCol)

Definition at line 504 of file fields_data_model.cpp.

References GetCanonicalFieldName(), m_cols, and VALUE.

◆ CollapseForSort()

void FIELDS_EDITOR_GRID_DATA_MODEL::CollapseForSort ( )

Definition at line 986 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 955 of file fields_data_model.cpp.

References CHILD_ITEM, GROUP_COLLAPSED, and m_rows.

Referenced by CollapseForSort(), and ExpandCollapseRow().

◆ DisableRebuilds()

void FIELDS_EDITOR_GRID_DATA_MODEL::DisableRebuilds ( )

Definition at line 816 of file fields_data_model.cpp.

References m_rebuildsEnabled.

◆ EnableRebuilds()

void FIELDS_EDITOR_GRID_DATA_MODEL::EnableRebuilds ( )

Definition at line 810 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 46 of file wx_grid.cpp.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), FIELDS_GRID_TABLE::GetAttr(), LAYERS_GRID_TABLE::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 999 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 975 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 913 of file fields_data_model.cpp.

References CHILD_ITEM, 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 1265 of file fields_data_model.cpp.

References CHILD_ITEM, 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

Definition at line 352 of file fields_data_model.cpp.

References DATASHEET, WX_GRID_TABLE_BASE::enhanceAttr(), WX_GRID_TABLE_BASE::GetAttr(), GetCanonicalFieldName(), GetColFieldName(), GetValue(), IsURL(), m_rows, and m_urlEditor.

◆ getAttributeValue()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue ( const SCH_SYMBOL & aSymbol,
const wxString & aAttributeName,
const std::set< wxString > & aVariantNames )
private

Definition at line 729 of file fields_data_model.cpp.

References SCH_SYMBOL::GetDNP(), SYMBOL::GetExcludedFromBoard(), SCH_SYMBOL::GetExcludedFromBOM(), SCH_SYMBOL::GetExcludedFromSim(), and multipleValues.

Referenced by updateDataStoreSymbolField().

◆ GetBomSettings()

BOM_PRESET FIELDS_EDITOR_GRID_DATA_MODEL::GetBomSettings ( )

Definition at line 1246 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 195 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 189 of file fields_data_model.h.

References m_cols.

◆ GetDataWidth()

int FIELDS_EDITOR_GRID_DATA_MODEL::GetDataWidth ( int aCol)

Definition at line 1158 of file fields_data_model.cpp.

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

◆ GetExcludeDNP()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetExcludeDNP ( )
inline

Definition at line 296 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 220 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 287 of file fields_data_model.cpp.

References m_cols.

Referenced by AddColumn(), ApplyBomPreset(), ApplyData(), and groupMatch().

◆ getFieldShownText()

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

Definition at line 687 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 299 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 277 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 304 of file fields_data_model.h.

References m_cols.

◆ GetGroupingEnabled()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetGroupingEnabled ( )
inline

Definition at line 286 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 243 of file fields_data_model.h.

References m_rows.

◆ GetIncludeExcludedFromBOM()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetIncludeExcludedFromBOM ( )
inline

Definition at line 293 of file fields_data_model.h.

References m_includeExcluded.

Referenced by GetBomSettings().

◆ GetNumberCols()

int FIELDS_EDITOR_GRID_DATA_MODEL::GetNumberCols ( )
inlineoverride

Definition at line 181 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 180 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 283 of file fields_data_model.h.

References m_path.

◆ GetRowFlags()

GROUP_TYPE FIELDS_EDITOR_GRID_DATA_MODEL::GetRowFlags ( int aRow)
inline

Definition at line 228 of file fields_data_model.h.

References m_rows.

Referenced by Export().

◆ GetRowReferences()

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

Definition at line 230 of file fields_data_model.h.

References m_rows.

◆ GetScope()

SCOPE FIELDS_EDITOR_GRID_DATA_MODEL::GetScope ( )
inline

Definition at line 280 of file fields_data_model.h.

References m_scope.

◆ GetShowColumn()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetShowColumn ( int aCol)
inline

Definition at line 316 of file fields_data_model.h.

References m_cols.

◆ GetSortAsc()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetSortAsc ( )
inline

Definition at line 256 of file fields_data_model.h.

References m_sortAscending.

Referenced by GetBomSettings().

◆ GetSortCol()

int FIELDS_EDITOR_GRID_DATA_MODEL::GetSortCol ( )
inline

Definition at line 255 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 368 of file fields_data_model.cpp.

References CHILD_ITEM, ColIsItemNumber(), ColIsQuantity(), ColIsReference(), ExpandTextVars(), getFieldShownText(), SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), group, INDETERMINATE_STATE, IsGeneratedField(), m_cols, m_dataStore, EDA_ITEM::m_Uuid, 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 345 of file fields_data_model.cpp.

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

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

◆ groupMatch()

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

Definition at line 618 of file fields_data_model.cpp.

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

Referenced by RebuildRows().

◆ isAttribute()

bool FIELDS_EDITOR_GRID_DATA_MODEL::isAttribute ( const wxString & aFieldName)
private

Definition at line 720 of file fields_data_model.cpp.

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

◆ IsEdited()

bool FIELDS_EDITOR_GRID_DATA_MODEL::IsEdited ( )
inline

Definition at line 272 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 206 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 332 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 160 of file fields_data_model.h.

References m_cols.

◆ RebuildRows()

void FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows ( )

Definition at line 822 of file fields_data_model.cpp.

References CTX_SEARCH, EDA_COMBINED_MATCHER::Find(), SCH_SHEET_PATH::GetDNP(), SCH_SYMBOL::GetDNP(), SCH_SHEET_PATH::GetExcludedFromBOM(), SCH_SYMBOL::GetExcludedFromBOM(), SCH_REFERENCE::GetFullRef(), SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), GROUP_COLLAPSED, GROUP_SINGLETON, groupMatch(), SCH_SHEET_PATH::IsContainedWithin(), SCH_REFERENCE::IsMultiUnit(), m_excludeDNP, m_filter, m_groupingEnabled, m_includeExcluded, m_path, m_rebuildsEnabled, m_rows, m_scope, m_symbolsList, Sort(), and unitMatch().

Referenced by ApplyBomPreset().

◆ RemoveColumn()

void FIELDS_EDITOR_GRID_DATA_MODEL::RemoveColumn ( int aCol)

Definition at line 256 of file fields_data_model.cpp.

References m_cols, m_dataStore, and m_symbolsList.

◆ RemoveReferences()

void FIELDS_EDITOR_GRID_DATA_MODEL::RemoveReferences ( const SCH_REFERENCE_LIST & aRefs)

Definition at line 1391 of file fields_data_model.cpp.

References m_dataStore, and m_symbolsList.

◆ RemoveSymbol()

void FIELDS_EDITOR_GRID_DATA_MODEL::RemoveSymbol ( const SCH_SYMBOL & aSymbol)

Definition at line 1374 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 268 of file fields_data_model.cpp.

References m_cols, m_dataStore, m_symbolsList, and EDA_ITEM::m_Uuid.

◆ setAttributeValue()

bool FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue ( SCH_SYMBOL & aSymbol,
const wxString & aAttributeName,
const wxString & aValue,
const wxString & aVariantName = wxEmptyString )
private

Set the attribute value.

Parameters
aSymbolis the symbol to set the attribute.
aAttributeNameis the name of the symbol attribute.
aValueis the value to set the attribute.
aVariantNameis an optional variant name to set the variant attribute.
Return values
trueif the symbol attribute value has changed.
falseif the symbol attribute has not changed.

Definition at line 774 of file fields_data_model.cpp.

References SCH_SYMBOL::GetDNP(), SYMBOL::GetExcludedFromBoard(), SCH_SYMBOL::GetExcludedFromBOM(), SCH_SYMBOL::GetExcludedFromSim(), multipleValues, SCH_SYMBOL::SetDNP(), SYMBOL::SetExcludedFromBoard(), SCH_SYMBOL::SetExcludedFromBOM(), and SCH_SYMBOL::SetExcludedFromSim().

Referenced by ApplyData().

◆ SetColAttr()

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

Definition at line 61 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 183 of file fields_data_model.h.

References m_cols.

Referenced by ApplyBomPreset().

◆ SetExcludeDNP()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetExcludeDNP ( bool exclude)
inline

Definition at line 295 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 310 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 276 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 298 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 285 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 292 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 282 of file fields_data_model.h.

References m_path.

◆ SetScope()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetScope ( SCOPE aScope)
inline

Definition at line 279 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 310 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 248 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 477 of file fields_data_model.cpp.

References ColIsAttribute(), ColIsReference(), SCH_REFERENCE::GetSymbol(), IsGeneratedField(), m_cols, m_dataStore, m_edited, DATA_MODEL_ROW::m_Refs, m_rows, and EDA_ITEM::m_Uuid.

◆ Sort()

void FIELDS_EDITOR_GRID_DATA_MODEL::Sort ( )
private

Definition at line 574 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 608 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 std::set< wxString > & aVariantNames )
private

Definition at line 201 of file fields_data_model.cpp.

References SCHEMATIC::ConvertKIIDsToRefs(), getAttributeValue(), SCH_SYMBOL::GetField(), SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), SCH_SYMBOL::GetVariant(), isAttribute(), IsGeneratedField(), m_dataStore, EDA_ITEM::m_Uuid, multipleValues, and SCH_ITEM::Schematic().

Referenced by AddColumn(), and UpdateReferences().

◆ UpdateReferences()

void FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences ( const SCH_REFERENCE_LIST & aRefs,
const std::set< wxString > & aVariantNames )

Definition at line 1409 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 153 of file fields_data_model.h.

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

◆ m_colAttrs

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

Definition at line 86 of file wx_grid.h.

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

◆ m_cols

std::vector<DATA_MODEL_COL> FIELDS_EDITOR_GRID_DATA_MODEL::m_cols
protected

Definition at line 388 of file fields_data_model.h.

Referenced by AddColumn(), ApplyBomPreset(), ApplyData(), ColIsAttribute(), ColIsItemNumber(), ColIsQuantity(), ColIsReference(), ColIsValue(), Export(), GetColFieldName(), GetColLabelValue(), GetFieldNameCol(), GetFieldsOrdered(), GetGroupColumn(), GetNumberCols(), GetShowColumn(), GetValue(), groupMatch(), IsExpanderColumn(), MoveColumn(), RemoveColumn(), RenameColumn(), SetColLabelValue(), SetFieldsOrder(), SetGroupColumn(), SetShowColumn(), SetSorting(), SetValue(), and UpdateReferences().

◆ m_dataStore

std::map<KIID, std::map<wxString, wxString> > FIELDS_EDITOR_GRID_DATA_MODEL::m_dataStore
protected

Definition at line 394 of file fields_data_model.h.

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

◆ m_edited

bool FIELDS_EDITOR_GRID_DATA_MODEL::m_edited
protected

Definition at line 376 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 383 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 379 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 382 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 384 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 381 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 385 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 389 of file fields_data_model.h.

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

◆ m_scope

SCOPE FIELDS_EDITOR_GRID_DATA_MODEL::m_scope
protected

Definition at line 380 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 378 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 377 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 375 of file fields_data_model.h.

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

◆ m_urlEditor

wxGridCellAttr* FIELDS_EDITOR_GRID_DATA_MODEL::m_urlEditor
protected

Definition at line 386 of file fields_data_model.h.

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

◆ QUANTITY_VARIABLE

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

Definition at line 152 of file fields_data_model.h.

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

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