KiCad PCB EDA Suite
Loading...
Searching...
No Matches
lib_symbol.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2004-2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
6 * Copyright (C) 2022 CERN
7 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#ifndef LIB_SYMBOL_H
28#define LIB_SYMBOL_H
29
30#include <embedded_files.h>
31#include <symbol.h>
32#include <sch_field.h>
33#include <sch_pin.h>
34#include <lib_tree_item.h>
35#include <vector>
36#include <core/multivector.h>
37
38class LINE_READER;
39class OUTPUTFORMATTER;
40class REPORTER;
41class SYMBOL_LIB;
42class LIB_SYMBOL;
43class OUTLINE_FONT;
45
46namespace KIFONT
47{
48 class OUTLINE_FONT;
49}
50
51
52typedef std::shared_ptr<LIB_SYMBOL> LIB_SYMBOL_SPTR;
53typedef std::weak_ptr<LIB_SYMBOL> LIB_SYMBOL_REF;
56
57
58/* values for member .m_options */
60{
61 ENTRY_NORMAL, // Libentry is a standard symbol (real or alias)
62 ENTRY_GLOBAL_POWER, // Libentry is a power symbol
63 ENTRY_LOCAL_POWER // Libentry is a local power symbol
64};
65
66
67extern bool operator<( const LIB_SYMBOL& aItem1, const LIB_SYMBOL& aItem2 );
68
69
71{
72 int m_unit;
74 std::vector<SCH_ITEM*> m_items;
75};
76
77
84class LIB_SYMBOL : public SYMBOL, public LIB_TREE_ITEM, public EMBEDDED_FILES
85{
86public:
87 LIB_SYMBOL( const wxString& aName, LIB_SYMBOL* aParent = nullptr,
88 SYMBOL_LIB* aLibrary = nullptr );
89
90 LIB_SYMBOL( const LIB_SYMBOL& aSymbol, SYMBOL_LIB* aLibrary = nullptr );
91
92 virtual ~LIB_SYMBOL() = default;
93
95 LIB_SYMBOL_SPTR SharedPtr() const { return m_me; }
96
100 virtual LIB_SYMBOL* Duplicate() const
101 {
102 LIB_SYMBOL* dupe = new LIB_SYMBOL( *this, m_library );
103 const_cast<KIID&>( dupe->m_Uuid ) = KIID();
104
105 for( SCH_ITEM& item : dupe->m_drawings )
106 const_cast<KIID&>( item.m_Uuid ) = KIID();
107
108 return dupe;
109 }
110
114 static LIB_SYMBOL* GetDummy();
115
116 void SetParent( LIB_SYMBOL* aParent = nullptr );
118 const LIB_SYMBOL_REF& GetParent() const { return m_parent; }
119
125 unsigned GetInheritanceDepth() const;
126
136
137 virtual wxString GetClass() const override
138 {
139 return wxT( "LIB_SYMBOL" );
140 }
141
142 static inline bool ClassOf( const EDA_ITEM* aItem )
143 {
144 return aItem && aItem->Type() == LIB_SYMBOL_T;
145 }
146
147 virtual void SetName( const wxString& aName );
148 wxString GetName() const override { return m_name; }
149
150 LIB_ID GetLIB_ID() const override { return m_libId; }
151 wxString GetDesc() override { return GetDescription(); }
152 int GetSubUnitCount() const override { return GetUnitCount(); }
153
154 const LIB_ID& GetLibId() const override { return m_libId; }
155 void SetLibId( const LIB_ID& aLibId ) { m_libId = aLibId; }
156
158 void SetSourceLibId( const LIB_ID& aLibId ) { m_sourceLibId = aLibId; }
159
160 wxString GetLibNickname() const override { return GetLibraryName(); }
161
163 void SetDescription( const wxString& aDescription )
164 {
165 GetDescriptionField().SetText( aDescription );
166 }
167
169 wxString GetDescription() const override
170 {
171 if( GetDescriptionField().GetText().IsEmpty() && IsDerived() )
172 {
173 if( LIB_SYMBOL_SPTR parent = m_parent.lock() )
174 return parent->GetDescription();
175 }
176
177 return GetDescriptionField().GetText();
178 }
179
180 void SetKeyWords( const wxString& aKeyWords ) { m_keyWords = aKeyWords; }
181
182 wxString GetKeyWords() const override
183 {
184 if( m_keyWords.IsEmpty() && IsDerived() )
185 {
186 if( LIB_SYMBOL_SPTR parent = m_parent.lock() )
187 return parent->GetKeyWords();
188 }
189
190 return m_keyWords;
191 }
192
193 std::vector<SEARCH_TERM> GetSearchTerms() override;
194
195 wxString GetFootprint() override
196 {
197 return GetFootprintField().GetText();
198 }
199
200 void GetChooserFields( std::map<wxString , wxString>& aColumnMap ) override;
201
205 bool IsRoot() const override { return m_parent.use_count() == 0; }
206 bool IsDerived() const { return !m_parent.expired() && m_parent.use_count() > 0; }
207
208 const wxString GetLibraryName() const;
209
210 SYMBOL_LIB* GetLib() const { return m_library; }
211 void SetLib( SYMBOL_LIB* aLibrary ) { m_library = aLibrary; }
212
214
215 void SetFPFilters( const wxArrayString& aFilters ) { m_fpFilters = aFilters; }
216
217 wxArrayString GetFPFilters() const
218 {
219 if( m_fpFilters.IsEmpty() && IsDerived() )
220 {
221 if( LIB_SYMBOL_SPTR parent = m_parent.lock() )
222 return parent->GetFPFilters();
223 }
224
225 return m_fpFilters;
226 }
227
240 const BOX2I GetUnitBoundingBox( int aUnit, int aBodyStyle,
241 bool aIgnoreHiddenFields = true,
242 bool aIgnoreLabelsOnInvisiblePins = true ) const;
243
244 const BOX2I GetBoundingBox() const override
245 {
246 return GetUnitBoundingBox( 0, 0 );
247 }
248
259 const BOX2I GetBodyBoundingBox( int aUnit, int aBodyStyle, bool aIncludePins,
260 bool aIncludePrivateItems ) const;
261
262 BOX2I GetBodyBoundingBox() const override
263 {
264 return GetBodyBoundingBox( m_previewUnit, m_previewBodyStyle, false, false );
265 }
266
268 {
270 }
271
272 bool IsGlobalPower() const override;
273 bool IsLocalPower() const override;
274 bool IsPower() const override;
275 bool IsNormal() const override;
276
277 void SetGlobalPower();
278 void SetLocalPower();
279 void SetNormal();
280
285 void LockUnits( bool aLockUnits ) { m_unitsLocked = aLockUnits; }
286
291 bool UnitsLocked() const { return m_unitsLocked; }
292
298 void SetFields( const std::vector<SCH_FIELD>& aFieldsList );
299
305 void GetFields( std::vector<SCH_FIELD*>& aList, bool aVisibleOnly = false ) const override;
306
310 void CopyFields( std::vector<SCH_FIELD>& aList );
311
315 void AddField( SCH_FIELD* aField );
316
317 void AddField( SCH_FIELD& aField ) { AddField( new SCH_FIELD( aField ) ); }
318
322 int GetNextFieldOrdinal() const;
323
327 SCH_FIELD* GetField( const wxString& aFieldName );
328 const SCH_FIELD* GetField( const wxString& aFieldName ) const;
329
330 SCH_FIELD* FindFieldCaseInsensitive( const wxString& aFieldName );
331
332 const SCH_FIELD* GetField( FIELD_T aFieldType ) const;
333 SCH_FIELD* GetField( FIELD_T aFieldType );
334
337 const SCH_FIELD& GetValueField() const;
338
341 const SCH_FIELD& GetReferenceField() const;
342
345 const SCH_FIELD& GetFootprintField() const;
346
349 const SCH_FIELD& GetDatasheetField() const;
350
353 const SCH_FIELD& GetDescriptionField() const;
354
355 wxString GetPrefix();
356
357 const wxString GetRef( const SCH_SHEET_PATH* aSheet, bool aIncludeUnit = false ) const override
358 {
359 return GetReferenceField().GetText();
360 }
361
362 const wxString GetValue( bool aResolve, const SCH_SHEET_PATH* aPath,
363 bool aAllowExtraText ) const override
364 {
365 return GetValueField().GetText();
366 }
367
368 std::set<KIFONT::OUTLINE_FONT*> GetFonts() const override;
369
371 const EMBEDDED_FILES* GetEmbeddedFiles() const;
372
373 void EmbedFonts() override;
374
381 void AutoplaceFields( SCH_SCREEN* aScreen, AUTOPLACE_ALGO aAlgo ) override;
382
383 void RunOnChildren( const std::function<void( SCH_ITEM* )>& aFunction, RECURSE_MODE aMode ) override;
384
390 bool ResolveTextVar( wxString* token, int aDepth = 0 ) const;
391
392 void Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
393 int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed ) override;
394
398 void PlotFields( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
399 int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed );
400
407 void AddDrawItem( SCH_ITEM* aItem, bool aSort = true );
408
414 void RemoveDrawItem( SCH_ITEM* aItem );
415
416 void RemoveField( SCH_FIELD* aField ) { RemoveDrawItem( aField ); }
417
426 std::vector<SCH_PIN*> GetGraphicalPins( int aUnit = 0, int aBodyStyle = 0 ) const;
427
433 {
435 wxString number;
436 };
437
442 std::vector<LOGICAL_PIN> GetLogicalPins( int aUnit, int aBodyStyle ) const;
443
445 {
446 wxString m_unitName;
447 std::vector<wxString> m_pinNumbers;
448 };
449
453 std::vector<UNIT_PIN_INFO> GetUnitPinInfo() const;
454
455 // Deprecated: use GetGraphicalPins(). This override remains to satisfy SYMBOL's pure virtual.
456 std::vector<SCH_PIN*> GetPins() const override;
457
461 int GetPinCount() override;
462
471 SCH_PIN* GetPin( const wxString& aNumber, int aUnit = 0, int aBodyStyle = 0 ) const;
472
484 bool PinsConflictWith( const LIB_SYMBOL& aOtherSymbol, bool aTestNums, bool aTestNames,
485 bool aTestType, bool aTestOrientation, bool aTestLength ) const;
486
492 void Move( const VECTOR2I& aOffset ) override;
493
500 bool HasLegacyAlternateBodyStyle() const;
501
506 int GetMaxPinNumber() const;
507
511 void ClearTempFlags() override;
512 void ClearEditFlags() override;
513
523 SCH_ITEM* LocateDrawItem( int aUnit, int aBodyStyle, KICAD_T aType, const VECTOR2I& aPoint );
524
535 SCH_ITEM* LocateDrawItem( int aUnit, int aBodyStyle, KICAD_T aType, const VECTOR2I& aPoint,
536 const TRANSFORM& aTransform );
537
544 const LIB_ITEMS_CONTAINER& GetDrawItems() const { return m_drawings; }
545
550 void FixupDrawItems();
551
552 INSPECT_RESULT Visit( INSPECTOR inspector, void* testData,
553 const std::vector<KICAD_T>& aScanTypes ) override;
554
566 void SetUnitCount( int aCount, bool aDuplicateDrawItems );
567 int GetUnitCount() const override;
568
569 wxString GetUnitName( int aUnit ) const override
570 {
571 return GetUnitDisplayName( aUnit, true );
572 }
573
577 wxString GetUnitDisplayName( int aUnit, bool aLabel ) const override;
578
579 wxString GetBodyStyleDescription( int aBodyStyle, bool aLabel ) const override;
580
581 std::map<int, wxString>& GetUnitDisplayNames() { return m_unitDisplayNames; }
582 const std::map<int, wxString>& GetUnitDisplayNames() const { return m_unitDisplayNames; }
583
586
591 std::vector<std::set<wxString>>& JumperPinGroups() { return m_jumperPinGroups; }
592 const std::vector<std::set<wxString>>& JumperPinGroups() const { return m_jumperPinGroups; }
593
595 std::optional<const std::set<wxString>> GetJumperPinGroup( const wxString& aPinNumber ) const;
596
601 bool IsMultiUnit() const override { return m_unitCount > 1; }
602
603 static wxString LetterSubReference( int aUnit, wxChar aInitialLetter );
604
605 bool IsMultiBodyStyle() const override { return GetBodyStyleCount() > 1; }
606
607 int GetBodyStyleCount() const override
608 {
609 if( m_demorgan )
610 return 2;
611 else
612 return std::max( 1, (int) m_bodyStyleNames.size() );
613 }
614
615 bool HasDeMorganBodyStyles() const override { return m_demorgan; }
616 void SetHasDeMorganBodyStyles( bool aFlag ) { m_demorgan = aFlag; }
617
618 const std::vector<wxString>& GetBodyStyleNames() const { return m_bodyStyleNames; }
619 void SetBodyStyleNames( const std::vector<wxString>& aBodyStyleNames ) { m_bodyStyleNames = aBodyStyleNames; }
620
632 void SetBodyStyleCount( int aCount, bool aDuplicateDrawItems, bool aDuplicatePins );
633
643 int Compare( const LIB_SYMBOL& aRhs, int aCompareFlags = 0,
644 REPORTER* aReporter = nullptr ) const;
645
646 const LIB_SYMBOL& operator=( const LIB_SYMBOL& aSymbol );
647
655 std::unique_ptr< LIB_SYMBOL > Flatten() const;
656
663 std::vector<struct LIB_SYMBOL_UNIT> GetUnitDrawItems();
664
675 std::vector<SCH_ITEM*> GetUnitDrawItems( int aUnit, int aBodyStyle );
676
683 double Similarity( const SCH_ITEM& aSymbol ) const override;
684#if defined(DEBUG)
685 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
686#endif
687
688private:
689 // We create a different set parent function for this class, so we hide the inherited one.
691
697 int compare( const SCH_ITEM& aOther,
698 int aCompareFlags = SCH_ITEM::COMPARE_FLAGS::EQUALITY ) const override;
699
700 void deleteAllFields();
701
702private:
708
712
716
718
720
722 wxString m_name;
723 wxString m_keyWords;
724 wxArrayString m_fpFilters;
726
729 std::vector<std::set<wxString> > m_jumperPinGroups;
730
734
735 std::map<int, wxString> m_unitDisplayNames;
736 std::vector<wxString> m_bodyStyleNames;
737};
738
739#endif // CLASS_LIBENTRY_H
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
const KIID m_Uuid
Definition eda_item.h:516
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
virtual void SetParent(EDA_ITEM *aParent)
Definition eda_item.h:113
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType, bool isSCH_ITEM=false, bool isBOARD_ITEM=false)
Definition eda_item.cpp:39
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition eda_text.h:98
bool IsEmpty() const
EMBEDDED_FILES()=default
Class OUTLINE_FONT implements outline font drawing.
Definition kiid.h:49
A logical library item identifier and consists of various portions much like a URI.
Definition lib_id.h:49
Define a library symbol object.
Definition lib_symbol.h:85
LIB_ITEMS_CONTAINER m_drawings
Definition lib_symbol.h:719
bool ResolveTextVar(wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the symbol.
SCH_FIELD & GetDescriptionField()
Return reference to the description field.
Definition lib_symbol.h:352
wxString GetDescription() const override
Definition lib_symbol.h:169
const LIB_ID & GetLibId() const override
Definition lib_symbol.h:154
const BOX2I GetUnitBoundingBox(int aUnit, int aBodyStyle, bool aIgnoreHiddenFields=true, bool aIgnoreLabelsOnInvisiblePins=true) const
Get the bounding box for the symbol.
wxString GetKeyWords() const override
Definition lib_symbol.h:182
void SetGlobalPower()
virtual ~LIB_SYMBOL()=default
LIBRENTRYOPTIONS m_options
Special symbol features such as POWER or NORMAL.
Definition lib_symbol.h:717
bool PinsConflictWith(const LIB_SYMBOL &aOtherSymbol, bool aTestNums, bool aTestNames, bool aTestType, bool aTestOrientation, bool aTestLength) const
Return true if this symbol's pins do not match another symbol's pins.
const std::map< int, wxString > & GetUnitDisplayNames() const
Definition lib_symbol.h:582
void GetFields(std::vector< SCH_FIELD * > &aList, bool aVisibleOnly=false) const override
Populate a std::vector with SCH_FIELDs, sorted in ordinal order.
bool IsPower() const override
wxString GetPrefix()
void SetSourceLibId(const LIB_ID &aLibId)
Definition lib_symbol.h:158
bool UnitsLocked() const
Check whether symbol units are interchangeable.
Definition lib_symbol.h:291
SCH_FIELD & GetDatasheetField()
Return reference to the datasheet field.
Definition lib_symbol.h:348
bool IsRoot() const override
For symbols derived from other symbols, IsRoot() indicates no derivation.
Definition lib_symbol.h:205
std::vector< struct LIB_SYMBOL_UNIT > GetUnitDrawItems()
Return a list of SCH_ITEM objects separated by unit and convert number.
void RemoveField(SCH_FIELD *aField)
Definition lib_symbol.h:416
std::map< int, wxString > m_unitDisplayNames
Definition lib_symbol.h:735
std::vector< std::set< wxString > > m_jumperPinGroups
A list of jumper pin groups, each of which is a set of pin numbers that should be jumpered together (...
Definition lib_symbol.h:729
void ClearTempFlags() override
Clears the status flag all draw objects in this symbol.
bool IsDerived() const
Definition lib_symbol.h:206
std::map< int, wxString > & GetUnitDisplayNames()
Definition lib_symbol.h:581
SYMBOL_LIB * m_library
Definition lib_symbol.h:721
void SetDuplicatePinNumbersAreJumpers(bool aEnabled)
Definition lib_symbol.h:585
bool m_demorgan
True if there are two body styles: normal and De Morgan If false, the body style count is taken from ...
Definition lib_symbol.h:713
wxString GetFootprint() override
For items with footprint fields.
Definition lib_symbol.h:195
const wxString GetLibraryName() const
void SetFields(const std::vector< SCH_FIELD > &aFieldsList)
Overwrite all the existing fields in this symbol with fields supplied in aFieldsList.
std::vector< SEARCH_TERM > GetSearchTerms() override
timestamp_t GetLastModDate() const
Definition lib_symbol.h:213
LIB_ID GetSourceLibId() const
Definition lib_symbol.h:157
bool IsMultiBodyStyle() const override
Definition lib_symbol.h:605
int GetMaxPinNumber() const
virtual LIB_SYMBOL * Duplicate() const
Create a copy of a LIB_SYMBOL and assigns unique KIIDs to the copy and its children.
Definition lib_symbol.h:100
LIB_SYMBOL(const wxString &aName, LIB_SYMBOL *aParent=nullptr, SYMBOL_LIB *aLibrary=nullptr)
LIB_SYMBOL_SPTR m_me
Definition lib_symbol.h:703
void Plot(PLOTTER *aPlotter, bool aBackground, const SCH_PLOT_OPTS &aPlotOpts, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aDimmed) override
Plot the item to aPlotter.
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition lib_symbol.h:244
SCH_FIELD * GetField(const wxString &aFieldName)
Find a field within this symbol matching aFieldName; return nullptr if not found.
SCH_FIELD & GetFootprintField()
Return reference to the footprint field.
Definition lib_symbol.h:344
int Compare(const LIB_SYMBOL &aRhs, int aCompareFlags=0, REPORTER *aReporter=nullptr) const
Comparison test that can be used for operators.
void FixupDrawItems()
This function finds the filled draw items that are covering up smaller draw items and replaces their ...
void SetBodyStyleNames(const std::vector< wxString > &aBodyStyleNames)
Definition lib_symbol.h:619
SCH_PIN * GetPin(const wxString &aNumber, int aUnit=0, int aBodyStyle=0) const
Return pin object with the requested pin aNumber.
bool IsNormal() const override
wxString m_name
Definition lib_symbol.h:722
std::set< KIFONT::OUTLINE_FONT * > GetFonts() const override
static bool ClassOf(const EDA_ITEM *aItem)
Definition lib_symbol.h:142
SCH_FIELD * FindFieldCaseInsensitive(const wxString &aFieldName)
const std::vector< std::set< wxString > > & JumperPinGroups() const
Definition lib_symbol.h:592
wxString m_keyWords
Search keywords.
Definition lib_symbol.h:723
SCH_ITEM * LocateDrawItem(int aUnit, int aBodyStyle, KICAD_T aType, const VECTOR2I &aPoint)
Locate a draw object.
static wxString LetterSubReference(int aUnit, wxChar aInitialLetter)
double Similarity(const SCH_ITEM &aSymbol) const override
Return a measure of similarity between this symbol and aSymbol.
static LIB_SYMBOL * GetDummy()
Returns a dummy LIB_SYMBOL, used when one is missing in the schematic.
void PlotFields(PLOTTER *aPlotter, bool aBackground, const SCH_PLOT_OPTS &aPlotOpts, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aDimmed)
Plot symbol fields.
void LockUnits(bool aLockUnits)
Set interchangeable the property for symbol units.
Definition lib_symbol.h:285
LIB_ITEMS_CONTAINER & GetDrawItems()
Return a reference to the draw item list.
Definition lib_symbol.h:543
void SetParent(LIB_SYMBOL *aParent=nullptr)
std::vector< UNIT_PIN_INFO > GetUnitPinInfo() const
Return pin-number lists for each unit, ordered consistently for gate swapping.
wxString GetUnitName(int aUnit) const override
For items with units, return an identifier for unit x.
Definition lib_symbol.h:569
wxString GetName() const override
Definition lib_symbol.h:148
void SetUnitCount(int aCount, bool aDuplicateDrawItems)
Set the units per symbol count.
void SetDescription(const wxString &aDescription)
Gets the Description field text value *‍/.
Definition lib_symbol.h:163
const LIB_SYMBOL_REF & GetParent() const
Definition lib_symbol.h:118
void SetKeyWords(const wxString &aKeyWords)
Definition lib_symbol.h:180
SCH_FIELD & GetValueField()
Return reference to the value field.
Definition lib_symbol.h:336
bool IsLocalPower() const override
wxArrayString GetFPFilters() const
Definition lib_symbol.h:217
void RemoveDrawItem(SCH_ITEM *aItem)
Remove draw aItem from list.
void GetChooserFields(std::map< wxString, wxString > &aColumnMap) override
Retrieves a key/value map of the fields on this item that should be exposed to the library browser/ch...
bool HasLegacyAlternateBodyStyle() const
Before V10 we didn't store the number of body styles in a symbol – we just looked through all its dra...
void SetHasDeMorganBodyStyles(bool aFlag)
Definition lib_symbol.h:616
const std::vector< wxString > & GetBodyStyleNames() const
Definition lib_symbol.h:618
int compare(const SCH_ITEM &aOther, int aCompareFlags=SCH_ITEM::COMPARE_FLAGS::EQUALITY) const override
The library symbol specific sort order is as follows:
timestamp_t m_lastModDate
Definition lib_symbol.h:707
std::optional< const std::set< wxString > > GetJumperPinGroup(const wxString &aPinNumber) const
Retrieves the jumper group containing the specified pin number, if one exists.
LIB_ID m_libId
Definition lib_symbol.h:705
void SetLocalPower()
void SetLib(SYMBOL_LIB *aLibrary)
Definition lib_symbol.h:211
std::vector< SCH_PIN * > GetPins() const override
int GetSubUnitCount() const override
For items with units, return the number of units.
Definition lib_symbol.h:152
void SetBodyStyleCount(int aCount, bool aDuplicateDrawItems, bool aDuplicatePins)
Set or clear the alternate body style (DeMorgan) for the symbol.
wxString GetLibNickname() const override
Sets the Description field text value.
Definition lib_symbol.h:160
void AutoplaceFields(SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo) override
Automatically orient all the fields in the symbol.
std::vector< LOGICAL_PIN > GetLogicalPins(int aUnit, int aBodyStyle) const
Return all logical pins (expanded) filtered by unit/body.
bool HasDeMorganBodyStyles() const override
Definition lib_symbol.h:615
const LIB_SYMBOL & operator=(const LIB_SYMBOL &aSymbol)
bool m_unitsLocked
True if symbol has multiple units and changing one unit does not automatically change another unit.
Definition lib_symbol.h:710
wxArrayString m_fpFilters
List of suitable footprint names for the symbol (wild card names accepted).
Definition lib_symbol.h:724
void Move(const VECTOR2I &aOffset) override
Move the symbol aOffset.
void SetFPFilters(const wxArrayString &aFilters)
Definition lib_symbol.h:215
bool IsMultiUnit() const override
Definition lib_symbol.h:601
void CopyFields(std::vector< SCH_FIELD > &aList)
Create a copy of the SCH_FIELDs, sorted in ordinal order.
void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode) override
std::vector< SCH_PIN * > GetGraphicalPins(int aUnit=0, int aBodyStyle=0) const
Graphical pins: Return schematic pin objects as drawn (unexpanded), filtered by unit/body.
LIB_SYMBOL_SPTR SharedPtr() const
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared.
Definition lib_symbol.h:95
const wxString GetValue(bool aResolve, const SCH_SHEET_PATH *aPath, bool aAllowExtraText) const override
Definition lib_symbol.h:362
int GetBodyStyleCount() const override
Definition lib_symbol.h:607
wxString GetDesc() override
Definition lib_symbol.h:151
INSPECT_RESULT Visit(INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes) override
May be re-implemented for each derived class in order to handle all the types given by its member dat...
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override
Definition lib_symbol.h:357
EMBEDDED_FILES * GetEmbeddedFiles() override
void AddField(SCH_FIELD &aField)
Definition lib_symbol.h:317
int m_unitCount
Number of units (parts) per package.
Definition lib_symbol.h:709
virtual wxString GetClass() const override
Return the class name.
Definition lib_symbol.h:137
bool IsGlobalPower() const override
LIB_ID m_sourceLibId
For database library symbols; the original symbol.
Definition lib_symbol.h:706
wxString GetBodyStyleDescription(int aBodyStyle, bool aLabel) const override
unsigned GetInheritanceDepth() const
Get the number of parents for this symbol.
int GetUnitCount() const override
LIB_SYMBOL_REF m_parent
Use for inherited symbols.
Definition lib_symbol.h:704
std::vector< wxString > m_bodyStyleNames
Definition lib_symbol.h:736
std::unique_ptr< LIB_SYMBOL > Flatten() const
Return a flattened symbol inheritance to the caller.
BOX2I GetBodyBoundingBox() const override
Return a bounding box for the symbol body but not the pins or fields.
Definition lib_symbol.h:262
SYMBOL_LIB * GetLib() const
Definition lib_symbol.h:210
int GetPinCount() override
BOX2I GetBodyAndPinsBoundingBox() const override
Return a bounding box for the symbol body and pins but not the fields.
Definition lib_symbol.h:267
void SetLibId(const LIB_ID &aLibId)
Definition lib_symbol.h:155
void AddField(SCH_FIELD *aField)
Add a field.
void ClearEditFlags() override
bool GetDuplicatePinNumbersAreJumpers() const
Definition lib_symbol.h:584
void deleteAllFields()
LIB_ID GetLIB_ID() const override
Definition lib_symbol.h:150
LIB_SYMBOL_REF & GetParent()
Definition lib_symbol.h:117
bool m_duplicatePinNumbersAreJumpers
Flag that this symbol should automatically treat sets of two or more pins with the same number as jum...
Definition lib_symbol.h:733
LIB_SYMBOL_SPTR GetRootSymbol() const
Get the parent symbol that does not have another parent.
std::vector< std::set< wxString > > & JumperPinGroups()
Each jumper pin group is a set of pin numbers that should be treated as internally connected.
Definition lib_symbol.h:591
void AddDrawItem(SCH_ITEM *aItem, bool aSort=true)
Add a new draw aItem to the draw object list and sort according to aSort.
wxString GetUnitDisplayName(int aUnit, bool aLabel) const override
Return the user-defined display name for aUnit for symbols with units.
void EmbedFonts() override
virtual void SetName(const wxString &aName)
void SetNormal()
SCH_FIELD & GetReferenceField()
Return reference to the reference designator field.
Definition lib_symbol.h:340
const LIB_ITEMS_CONTAINER & GetDrawItems() const
Definition lib_symbol.h:544
int GetNextFieldOrdinal() const
Return the next ordinal for a user field for this symbol.
A mix-in to provide polymorphism between items stored in libraries (symbols, aliases and footprints).
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition richio.h:93
Multivector container type.
Definition multivector.h:47
boost::ptr_vector< SCH_ITEM > ITEM_PTR_VECTOR
Definition multivector.h:65
An interface used to output 8 bit text in a convenient way.
Definition richio.h:322
Base plotter engine class.
Definition plotter.h:121
A pure virtual class used to derive REPORTER objects from.
Definition reporter.h:73
void SetText(const wxString &aText) override
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition sch_item.h:167
friend class LIB_SYMBOL
Definition sch_item.h:759
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType, int aUnit=0, int aBodyStyle=0)
Definition sch_item.cpp:51
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Object used to load, save, search, and otherwise manipulate symbol library files.
SYMBOL(KICAD_T idType)
Definition symbol.h:65
int m_previewBodyStyle
Definition symbol.h:235
int m_previewUnit
Definition symbol.h:234
for transforming drawing coordinates for a wxDC device context.
Definition transform.h:46
RECURSE_MODE
Definition eda_item.h:50
INSPECT_RESULT
Definition eda_item.h:44
const INSPECTOR_FUNC & INSPECTOR
std::function passed to nested users by ref, avoids copying std::function.
Definition eda_item.h:91
uint32_t timestamp_t
timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the ti...
Definition kiid.h:46
LIBRENTRYOPTIONS
Definition lib_symbol.h:60
@ ENTRY_NORMAL
Definition lib_symbol.h:61
@ ENTRY_LOCAL_POWER
Definition lib_symbol.h:63
@ ENTRY_GLOBAL_POWER
Definition lib_symbol.h:62
std::weak_ptr< LIB_SYMBOL > LIB_SYMBOL_REF
weak pointer to LIB_SYMBOL
Definition lib_symbol.h:53
MULTIVECTOR< SCH_ITEM, SCH_SHAPE_T, SCH_PIN_T > LIB_ITEMS_CONTAINER
Definition lib_symbol.h:54
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
Definition lib_symbol.h:52
LIB_ITEMS_CONTAINER::ITEM_PTR_VECTOR LIB_ITEMS
Definition lib_symbol.h:55
bool operator<(const LIB_SYMBOL &aItem1, const LIB_SYMBOL &aItem2)
AUTOPLACE_ALGO
Definition sch_item.h:68
Logical pins: Return expanded logical pins based on stacked-pin notation.
Definition lib_symbol.h:433
wxString number
expanded logical pin number
Definition lib_symbol.h:435
SCH_PIN * pin
pointer to the base graphical pin
Definition lib_symbol.h:434
std::vector< wxString > m_pinNumbers
Definition lib_symbol.h:447
int m_bodyStyle
The alternate body style of the unit.
Definition lib_symbol.h:73
std::vector< SCH_ITEM * > m_items
The items unique to this unit and alternate body style.
Definition lib_symbol.h:74
int m_unit
The unit number.
Definition lib_symbol.h:72
FIELD_T
The set of all field indices assuming an array like sequence that a SCH_COMPONENT or LIB_PART can hol...
@ DESCRIPTION
Field Description of part, i.e. "1/4W 1% Metal Film Resistor".
@ FOOTPRINT
Field Name Module PCB, i.e. "16DIP300".
@ DATASHEET
name of datasheet
@ REFERENCE
Field Reference of part, i.e. "IC21".
@ VALUE
Field Value of part, i.e. "3.3K".
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition typeinfo.h:78
@ LIB_SYMBOL_T
Definition typeinfo.h:150
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695