43 m_cols.push_back( { aFieldName, aLabel, aAddedByUser,
false,
false } );
54 const wxString& aFieldName )
93 m_cols[aCol].m_fieldName = newName;
94 m_cols[aCol].m_label = newName;
100 for(
size_t i = 0; i <
m_cols.size(); i++ )
102 if(
m_cols[i].m_fieldName == aFieldName )
112 std::vector<BOM_FIELD> fields;
115 fields.push_back( { col.m_fieldName, col.m_label, col.m_show, col.m_group } );
123 size_t foundCount = 0;
125 for(
const wxString& newField : aNewOrder )
127 for(
size_t i = 0; i <
m_cols.size(); i++ )
129 if(
m_cols[i].m_fieldName == newField )
161 const wxString& refDelimiter,
162 const wxString& refRangeDelimiter,
165 std::vector<SCH_REFERENCE> references;
172 references.push_back( ref );
184 wxString refFieldValue;
197 if( &ref == &
group.m_Refs.front() )
198 fieldValue = refFieldValue;
199 else if( fieldValue != refFieldValue )
207 std::sort( references.begin(), references.end(),
210 wxString l_ref( l.GetRef() << l.GetRefNumber() );
211 wxString r_ref( r.GetRef() << r.GetRefNumber() );
212 return StrNumCmp( l_ref, r_ref, true ) < 0;
215 auto logicalEnd = std::unique( references.begin(), references.end(),
220 if( l.GetRefNumber() == wxT(
"?" ) )
223 wxString l_ref( l.GetRef() << l.GetRefNumber() );
224 wxString r_ref( r.GetRef() << r.GetRefNumber() );
225 return l_ref == r_ref;
228 references.erase( logicalEnd, references.end() );
234 fieldValue = wxString::Format( wxT(
"%d" ), (
int) references.size() );
236 fieldValue = wxString::Format( wxT(
"%d" ),
group.m_ItemNumber );
244 wxCHECK_RET( aCol >= 0 && aCol < (
int)
m_cols.size(), wxS(
"Invalid column number" ) );
264 wxCHECK( aCol >= 0 && aCol < (
int)
m_cols.size(),
false );
271 wxCHECK( aCol >= 0 && aCol < (
int)
m_cols.size(),
false );
278 wxCHECK( aCol >= 0 && aCol < (
int)
m_cols.size(),
false );
285 wxCHECK( aCol >= 0 && aCol < (
int)
m_cols.size(),
false );
292 wxCHECK( aCol >= 0 && aCol < (
int)
m_cols.size(),
false );
303 if( lhGroup.
m_Refs.size() == 0 )
305 else if( rhGroup.
m_Refs.size() == 0 )
311 [ ascending ](
const auto a,
const auto b )
326 wxString lhRef = lhGroup.
m_Refs[0].GetRef() + lhGroup.
m_Refs[0].GetRefNumber();
327 wxString rhRef = rhGroup.
m_Refs[0].GetRef() + rhGroup.
m_Refs[0].GetRefNumber();
328 return local_cmp(
StrNumCmp( lhRef, rhRef,
true ), 0 );
345 std::sort( row.m_Refs.begin(), row.m_Refs.end(),
348 wxString lhs_ref( lhs.GetRef() << lhs.GetRefNumber() );
349 wxString rhs_ref( rhs.GetRef() << rhs.GetRefNumber() );
350 return StrNumCmp( lhs_ref, rhs_ref, true ) < 0;
357 return cmp( lhs, rhs, this, m_sortColumn, m_sortAscending );
364 row.m_ItemNumber = itemNumber++;
387 bool matchFound =
false;
394 if(
m_cols[refCol].m_group )
407 for(
size_t i = 0; i <
m_cols.size(); ++i )
410 if( (
int) i == refCol )
438 wxString fieldName =
m_cols[i].m_fieldName;
451 const wxString& aFieldName )
465 std::function<bool( wxString* )> symbolResolver =
466 [&]( wxString* token ) ->
bool
474 return wxEmptyString;
480 return aFieldName == wxS(
"${DNP}" )
481 || aFieldName == wxS(
"${EXCLUDE_FROM_BOARD}" )
482 || aFieldName == wxS(
"${EXCLUDE_FROM_BOM}" )
483 || aFieldName == wxS(
"${EXCLUDE_FROM_SIM}" );
488 const wxString& aAttributeName )
490 if( aAttributeName == wxS(
"${DNP}" ) )
491 return aSymbol.
GetDNP() ? wxS(
"1" ) : wxS(
"0" );
493 if( aAttributeName == wxS(
"${EXCLUDE_FROM_BOARD}" ) )
496 if( aAttributeName == wxS(
"${EXCLUDE_FROM_BOM}" ) )
499 if( aAttributeName == wxS(
"${EXCLUDE_FROM_SIM}" ) )
506 const wxString& aAttributeName,
507 const wxString& aValue )
509 if( aAttributeName == wxS(
"${DNP}" ) )
510 aSymbol.
SetDNP( aValue == wxS(
"1" ) );
511 else if( aAttributeName == wxS(
"${EXCLUDE_FROM_BOARD}" ) )
513 else if( aAttributeName == wxS(
"${EXCLUDE_FROM_BOM}" ) )
515 else if( aAttributeName == wxS(
"${EXCLUDE_FROM_SIM}" ) )
541 static_cast<WX_GRID*
>( GetView() )->CommitPendingChanges(
true );
543 wxGridTableMessage msg(
this, wxGRIDTABLE_NOTIFY_ROWS_DELETED, 0,
m_rows.size() );
544 GetView()->ProcessTableMessage( msg );
565 || (
m_scope == SCOPE::SCOPE_SHEET_RECURSIVE
571 bool matchFound =
false;
589 row.m_Refs.push_back( ref );
595 row.m_Refs.push_back( ref );
607 wxGridTableMessage msg(
this, wxGRIDTABLE_NOTIFY_ROWS_APPENDED,
m_rows.size() );
608 GetView()->ProcessTableMessage( msg );
617 std::vector<DATA_MODEL_ROW> children;
621 bool matchFound =
false;
631 child.m_Refs.push_back( ref );
640 if( children.size() < 2 )
643 std::sort( children.begin(), children.end(),
646 return cmp( lhs, rhs, this, m_sortColumn, m_sortAscending );
650 m_rows.insert(
m_rows.begin() + aRow + 1, children.begin(), children.end() );
652 wxGridTableMessage msg(
this, wxGRIDTABLE_NOTIFY_ROWS_INSERTED, aRow, children.size() );
653 GetView()->ProcessTableMessage( msg );
659 auto firstChild =
m_rows.begin() + aRow + 1;
660 auto afterLastChild = firstChild;
663 while( afterLastChild !=
m_rows.end() && afterLastChild->m_Flag ==
CHILD_ITEM )
670 m_rows.erase( firstChild, afterLastChild );
672 wxGridTableMessage msg(
this, wxGRIDTABLE_NOTIFY_ROWS_DELETED, aRow + 1, deleted );
673 GetView()->ProcessTableMessage( msg );
690 for(
size_t i = 0; i <
m_rows.size(); ++i )
703 for(
size_t i = 0; i <
m_rows.size(); ++i )
718 symbolChangeHandler( symbol,
m_symbolsList[i].GetSheetPath() );
722 for(
const std::pair<wxString, wxString> srcData : fieldStore )
724 const wxString& srcName = srcData.first;
725 const wxString& srcValue = srcData.second;
741 bool userAdded = ( col != -1 &&
m_cols[col].m_userAdded );
744 bool createField = !destField && ( !srcValue.IsEmpty() || userAdded );
762 if( !srcValue.IsEmpty() )
771 destField->
SetText( srcValue );
777 if( fieldStore.count( symbol.
GetFields()[ii].GetName() ) == 0 )
815 for(
size_t i = 0; i <
m_cols.size(); i++ )
821 std::vector<wxString> order;
826 order.emplace_back( field.
name );
890 for(
size_t col = 0; col <
m_cols.size(); col++ )
893 last_col = (int) col;
900 auto formatField = [&]( wxString field,
bool last ) -> wxString
904 field.Replace( wxS(
"\r" ), wxS(
"" ) );
905 field.Replace( wxS(
"\n" ), wxS(
"" ) );
910 field.Replace( wxS(
"\t" ), wxS(
"" ) );
922 for(
size_t col = 0; col <
m_cols.size(); col++ )
927 out.Append( formatField(
m_cols[col].m_label, col == (
size_t) last_col ) );
931 for(
size_t row = 0; row <
m_rows.size(); row++ )
937 for(
size_t col = 0; col <
m_cols.size(); col++ )
945 col == (
size_t) last_col ) );
962 for(
const SCH_FIELD& field : ref.GetSymbol()->GetFields() )
963 m_dataStore[ref.GetSymbol()->m_Uuid][field.GetCanonicalName()] = field.GetText();
980 return ref.GetSymbol()->m_Uuid == aSymbol.m_Uuid;
997 if( ref.GetSymbol()->GetInstances().empty() )
wxString GetColFieldName(int aCol)
std::vector< DATA_MODEL_ROW > m_rows
int GetFieldNameCol(wxString aFieldName)
void ApplyBomPreset(const BOM_PRESET &preset)
void SetFieldsOrder(const std::vector< wxString > &aNewOrder)
SCH_REFERENCE_LIST m_symbolsList
void SetGroupingEnabled(bool group)
wxString getAttributeValue(const SCH_SYMBOL &, const wxString &aAttributeName)
bool ColIsItemNumber(int aCol)
bool ColIsQuantity(int aCol)
void updateDataStoreSymbolField(const SCH_SYMBOL &aSymbol, const wxString &aFieldName)
bool groupMatch(const SCH_REFERENCE &lhRef, const SCH_REFERENCE &rhRef)
BOM_PRESET GetBomSettings()
bool unitMatch(const SCH_REFERENCE &lhRef, const SCH_REFERENCE &rhRef)
bool ColIsReference(int aCol)
wxString GetExportValue(int aRow, int aCol, const wxString &refDelimiter, const wxString &refRangeDelimiter)
bool GetGroupingEnabled()
int GetNumberRows() override
void CollapseRow(int aRow)
wxString getFieldShownText(const SCH_REFERENCE &aRef, const wxString &aFieldName)
void RenameColumn(int aCol, const wxString &newName)
wxString Export(const BOM_FMT_PRESET &settings)
void AddColumn(const wxString &aFieldName, const wxString &aLabel, bool aAddedByUser)
std::vector< DATA_MODEL_COL > m_cols
void SetSorting(int aCol, bool ascending)
void ExpandCollapseRow(int aRow)
void SetFilter(const wxString &aFilter)
static bool cmp(const DATA_MODEL_ROW &lhGroup, const DATA_MODEL_ROW &rhGroup, FIELDS_EDITOR_GRID_DATA_MODEL *dataModel, int sortCol, bool ascending)
static const wxString ITEM_NUMBER_VARIABLE
void SetIncludeExcludedFromBOM(bool include)
bool isAttribute(const wxString &aFieldName)
wxString GetValue(int aRow, int aCol) override
int GetDataWidth(int aCol)
void UpdateReferences(const SCH_REFERENCE_LIST &aRefs)
void ApplyData(std::function< void(SCH_SYMBOL &, SCH_SHEET_PATH &)> symbolChangeHandler)
void RemoveColumn(int aCol)
GROUP_TYPE GetRowFlags(int aRow)
const wxString & GetFilter()
std::map< KIID, std::map< wxString, wxString > > m_dataStore
static const wxString QUANTITY_VARIABLE
bool ColIsValue(int aCol)
void SetGroupColumn(int aCol, bool group)
void SetExcludeDNP(bool exclude)
void RemoveSymbol(const SCH_SYMBOL &aSymbol)
void SetValue(int aRow, int aCol, const wxString &aValue) override
bool ColIsAttribute(int aCol)
void SetColLabelValue(int aCol, const wxString &aLabel) override
void RemoveReferences(const SCH_REFERENCE_LIST &aRefs)
void SetShowColumn(int aCol, bool show)
void setAttributeValue(SCH_SYMBOL &aSymbol, const wxString &aAttributeName, const wxString &aValue)
void AddReferences(const SCH_REFERENCE_LIST &aRefs)
const std::vector< BOM_FIELD > GetFieldsOrdered()
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const
void SetText(const wxString &aText) override
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
bool Contains(const SCH_REFERENCE &aItem) const
Return true if aItem exists in this list.
iterator erase(iterator position)
static wxString Shorthand(std::vector< SCH_REFERENCE > aList, const wxString &refDelimiter, const wxString &refRangeDelimiter)
Return a shorthand string representing all the references in the list.
int FindRefByFullPath(const wxString &aFullPath) const
Search the list for a symbol with the given KIID path (as string).
void AddItem(const SCH_REFERENCE &aItem)
void RemoveItem(unsigned int aIndex)
Remove an item from the list of references.
A helper to define a symbol's reference designator in a schematic.
const SCH_SHEET_PATH & GetSheetPath() const
wxString GetFullRef() const
SCH_SYMBOL * GetSymbol() const
wxString GetRefNumber() const
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
bool IsContainedWithin(const SCH_SHEET_PATH &aSheetPathToTest) const
Check if this path is contained inside aSheetPathToTest.
SCH_FIELD * GetFieldByName(const wxString &aFieldName)
Return a field in this symbol.
void SetValueFieldText(const wxString &aValue)
SCH_FIELD * FindField(const wxString &aFieldName, bool aIncludeDefaultFields=true, bool aCaseInsensitive=false)
Search for a SCH_FIELD with aFieldName.
void SetFootprintFieldText(const wxString &aFootprint)
VECTOR2I GetPosition() const override
bool ResolveTextVar(const SCH_SHEET_PATH *aPath, wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the symbol.
SCH_FIELD * AddField(const SCH_FIELD &aField)
Add a field to the symbol.
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with SCH_FIELDs.
bool GetExcludedFromBoard() const
bool GetExcludedFromBOM() const
void SetExcludedFromSim(bool aExcludeFromSim) override
Set or clear the exclude from simulation flag.
bool GetDNP() const
Set or clear the 'Do Not Populate' flaga.
void SetExcludedFromBOM(bool aExcludeFromBOM)
Set or clear the exclude from schematic bill of materials flag.
void SetExcludedFromBoard(bool aExcludeFromBoard)
Set or clear exclude from board netlist flag.
bool GetExcludedFromSim() const override
bool IsTextVar(const wxString &aSource)
Returns true if the string is a text var, e.g starts with ${.
wxString ExpandTextVars(const wxString &aSource, const PROJECT *aProject)
@ GROUP_COLLAPSED_DURING_SORT
KICOMMON_API wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currentl...
int StrNumCmp(const wxString &aString1, const wxString &aString2, bool aIgnoreCase)
Compare two strings with alphanumerical content.
bool WildCompareString(const wxString &pattern, const wxString &string_to_tst, bool case_sensitive)
Compare a string against wild card (* and ?) pattern using the usual rules.
int ValueStringCompare(const wxString &strFWord, const wxString &strSWord)
Compare strings like the strcmp function but handle numbers and modifiers within the string text corr...
wxString refRangeDelimiter
std::vector< BOM_FIELD > fieldsOrdered
bool includeExcludedFromBOM
std::vector< SCH_REFERENCE > m_Refs
wxString GetCanonicalFieldName(int idx)
@ FOOTPRINT_FIELD
Field Name Module PCB, i.e. "16DIP300".
@ VALUE_FIELD
Field Value of part, i.e. "3.3K".
@ MANDATORY_FIELDS
The first 5 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
@ REFERENCE_FIELD
Field Reference of part, i.e. "IC21".
#define INDETERMINATE_STATE
Used for holding indeterminate values, such as with multiple selections holding different values or c...