KiCad PCB EDA Suite
sch_component.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) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2014 Dick Hollenbeck, dick@softplc.com
6  * Copyright (C) 2015 Wayne Stambaugh <stambaughw@gmail.com>
7  * Copyright (C) 1992-2017 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 
32 #ifndef COMPONENT_CLASS_H
33 #define COMPONENT_CLASS_H
34 
35 #include <lib_id.h>
36 
37 #include <sch_field.h>
38 #include <transform.h>
39 #include <general.h>
40 #include <vector>
41 #include <lib_draw_item.h>
42 
43 class SCH_SCREEN;
44 class SCH_SHEET_PATH;
45 class LIB_ITEM;
46 class LIB_PIN;
47 class LIB_PART;
49 class PART_LIB;
50 class PART_LIBS;
51 class SCH_COLLECTOR;
52 class SCH_SCREEN;
54 
55 
57 typedef std::vector<SCH_FIELD> SCH_FIELDS;
58 
59 typedef std::weak_ptr<LIB_PART> PART_REF;
60 
61 
62 extern std::string toUTFTildaText( const wxString& txt );
63 
64 
69 class SCH_COMPONENT : public SCH_ITEM
70 {
72 
73 public:
75 private:
76 
78 
81 
82  int m_unit;
83  int m_convert;
84  wxString m_prefix;
92 
94 
95  std::vector<bool> m_isDangling;
96  std::vector<wxPoint> m_Pins;
97 
99 
107 
114  wxArrayString m_PathsAndReferences;
115 
116  void Init( const wxPoint& pos = wxPoint( 0, 0 ) );
117 
118 public:
119  SCH_COMPONENT( const wxPoint& pos = wxPoint( 0, 0 ), SCH_ITEM* aParent = NULL );
120 
133  SCH_COMPONENT( LIB_PART& aPart, SCH_SHEET_PATH* aSheet,
134  int unit = 0, int convert = 0,
135  const wxPoint& pos = wxPoint( 0, 0 ),
136  bool setNewItemFlag = false );
137 
147  SCH_COMPONENT( const SCH_COMPONENT& aComponent );
148 
150 
151  wxString GetClass() const override
152  {
153  return wxT( "SCH_COMPONENT" );
154  }
155 
156  const wxArrayString& GetPathsAndReferences() const { return m_PathsAndReferences; }
157 
167  bool IsMovableFromAnchorPoint() override { return false; }
168 
169  void SetLibId( const LIB_ID& aName, PART_LIBS* aLibs=NULL );
170  void SetLibId( const LIB_ID& aLibId, SYMBOL_LIB_TABLE* aSymLibTable, PART_LIB* aCacheLib );
171 
172  const LIB_ID& GetLibId() const { return m_lib_id; }
173 
174  PART_REF& GetPartRef() { return m_part; }
175 
179  wxString GetAliasDescription() const;
180 
184  wxString GetAliasDocumentation() const;
185 
191  bool Resolve( PART_LIBS* aLibs );
192 
193  bool Resolve( SYMBOL_LIB_TABLE& aLibTable, PART_LIB* aCacheLib = NULL );
194 
195  static void ResolveAll( const SCH_COLLECTOR& aComponents, PART_LIBS* aLibs );
196 
197  static void ResolveAll( const SCH_COLLECTOR& aComponents, SYMBOL_LIB_TABLE& aLibTable,
198  PART_LIB* aCacheLib = NULL );
199 
200  int GetUnit() const { return m_unit; }
201 
205  void UpdatePinCache();
206 
212  static void UpdateAllPinCaches( const SCH_COLLECTOR& aComponents );
213 
223  void SetUnit( int aUnit );
224 
233  void UpdateUnit( int aUnit );
234 
235  int GetConvert() const { return m_convert; }
236 
237  void SetConvert( int aConvert );
238 
239  wxString GetPrefix() const { return m_prefix; }
240 
241  void SetPrefix( const wxString& aPrefix ) { m_prefix = aPrefix; }
242 
243  TRANSFORM& GetTransform() const { return const_cast< TRANSFORM& >( m_transform ); }
244 
245  void SetTransform( const TRANSFORM& aTransform );
246 
252  int GetUnitCount() const;
253 
260  void SetOrientation( int aOrientation );
261 
277  int GetOrientation();
278 
288  wxPoint GetScreenCoord( const wxPoint& aPoint );
289 
290  void GetMsgPanelInfo( std::vector< MSG_PANEL_ITEM >& aList ) override;
291 
300  void ClearAnnotation( SCH_SHEET_PATH* aSheetPath );
301 
309  void SetTimeStamp( timestamp_t aNewTimeStamp );
310 
311  const EDA_RECT GetBoundingBox() const override;
312 
317 
318 
319  //-----<Fields>-----------------------------------------------------------
320 
328  SCH_FIELD* GetField( int aFieldNdx ) const;
329 
337  wxString GetFieldText( const wxString& aFieldName, bool aIncludeDefaultFields = true ) const;
338 
345  void GetFields( std::vector<SCH_FIELD*>& aVector, bool aVisibleOnly );
346 
354  SCH_FIELD* AddField( const SCH_FIELD& aField );
355 
364  SCH_FIELD* FindField( const wxString& aFieldName, bool aIncludeDefaultFields = true );
365 
371  void SetFields( const SCH_FIELDS& aFields )
372  {
373  m_Fields = aFields; // vector copying, length is changed possibly
374  }
375 
381  void UpdateFields( bool aResetStyle, bool aResetRef = false );
382 
386  int GetFieldCount() const { return (int)m_Fields.size(); }
387 
392 
396  void ClearFieldsAutoplaced() { m_fieldsAutoplaced = AUTOPLACED_NO; }
397 
407  void AutoplaceFields( SCH_SCREEN* aScreen, bool aManual );
408 
418  {
419  if( GetFieldsAutoplaced() )
420  AutoplaceFields( aScreen, GetFieldsAutoplaced() == AUTOPLACED_MANUAL );
421  }
422 
423 
424  //-----</Fields>----------------------------------------------------------
425 
426 
434  LIB_PIN* GetPin( const wxString& number );
435 
441  void GetPins( std::vector<LIB_PIN*>& aPinsList );
442 
443  void Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset,
444  GR_DRAWMODE aDrawMode, COLOR4D aColor = COLOR4D::UNSPECIFIED ) override
445  {
446  Draw( aPanel, aDC, aOffset, aDrawMode, aColor, true );
447  }
448 
462  void Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset,
463  GR_DRAWMODE aDrawMode, COLOR4D aColor,
464  bool aDrawPinText );
465 
466  void SwapData( SCH_ITEM* aItem ) override;
467 
468  // returns a unique ID, in the form of a path.
469  wxString GetPath( const SCH_SHEET_PATH* sheet ) const;
470 
480  static bool IsReferenceStringValid( const wxString& aReferenceString );
481 
482  void SetCurrentSheetPath( const SCH_SHEET_PATH* aSheetPath )
483  {
484  m_currentSheetPath = aSheetPath;
485  }
486 
492  const wxString GetRef( const SCH_SHEET_PATH* aSheet );
493 
500  void SetRef( const SCH_SHEET_PATH* aSheet, const wxString& aReference );
501 
510  void AddHierarchicalReference( const wxString& aPath,
511  const wxString& aRef,
512  int aMulti );
513 
514  // returns the unit selection, for the given sheet path.
515  int GetUnitSelection( SCH_SHEET_PATH* aSheet );
516 
517  // Set the unit selection, for the given sheet path.
518  void SetUnitSelection( SCH_SHEET_PATH* aSheet, int aUnitSelection );
519 
520  // Geometric transforms (used in block operations):
521 
522  void Move( const wxPoint& aMoveVector ) override
523  {
524  if( aMoveVector == wxPoint( 0, 0 ) )
525  return;
526 
527  m_Pos += aMoveVector;
528 
529  for( int ii = 0; ii < GetFieldCount(); ii++ )
530  GetField( ii )->Move( aMoveVector );
531 
532  SetModified();
533  }
534 
535  void MirrorY( int aYaxis_position ) override;
536 
537  void MirrorX( int aXaxis_position ) override;
538 
539  void Rotate( wxPoint aPosition ) override;
540 
541  bool Matches( wxFindReplaceData& aSearchData, void* aAuxData, wxPoint* aFindLocation ) override;
542 
543  void GetEndPoints( std::vector<DANGLING_END_ITEM>& aItemList ) override;
544 
556  bool IsDanglingStateChanged( std::vector<DANGLING_END_ITEM>& aItemList ) override;
557 
565  bool IsDangling() const override;
566 
567  wxPoint GetPinPhysicalPosition( const LIB_PIN* Pin ) const;
568 
569  bool IsSelectStateChanged( const wxRect& aRect ) override;
570 
571  bool IsConnectable() const override { return true; }
572 
573  bool CanConnect( const SCH_ITEM* aItem ) const override
574  {
575  return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
576  ( aItem->Type() == SCH_NO_CONNECT_T ) ||
577  ( aItem->Type() == SCH_JUNCTION_T );
578  }
579 
585  bool IsInNetlist() const;
586 
587  void GetConnectionPoints( std::vector<wxPoint>& aPoints ) const override;
588 
589  SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] ) override;
590 
599  LIB_ITEM* GetDrawItem( const wxPoint& aPosition, KICAD_T aType = TYPE_NOT_INIT );
600 
601  wxString GetSelectMenuText() const override;
602 
603  BITMAP_DEF GetMenuImage() const override;
604 
605  void GetNetListItem( NETLIST_OBJECT_LIST& aNetListItems,
606  SCH_SHEET_PATH* aSheetPath ) override;
607 
608  bool operator <( const SCH_ITEM& aItem ) const override;
609 
610  bool operator==( const SCH_COMPONENT& aComponent) const;
611  bool operator!=( const SCH_COMPONENT& aComponent) const;
612 
613  SCH_ITEM& operator=( const SCH_ITEM& aItem );
614 
615  bool IsReplaceable() const override { return true; }
616 
617  wxPoint GetPosition() const override { return m_Pos; }
618 
619  void SetPosition( const wxPoint& aPosition ) override { Move( aPosition - m_Pos ); }
620 
621  bool HitTest( const wxPoint& aPosition, int aAccuracy ) const override;
622 
623  bool HitTest( const EDA_RECT& aRect, bool aContained = false, int aAccuracy = 0 ) const override;
624 
625  void Plot( PLOTTER* aPlotter ) override;
626 
627  EDA_ITEM* Clone() const override;
628 
629 #if defined(DEBUG)
630  void Show( int nestLevel, std::ostream& os ) const override;
631 #endif
632 
633 private:
634  bool doIsConnected( const wxPoint& aPosition ) const override;
635 };
636 
637 
638 #endif /* COMPONENT_CLASS_H */
void UpdateFields(bool aResetStyle, bool aResetRef=false)
Restores fields to the original library values.
void Move(const wxPoint &aMoveVector) override
Function Move moves the item by aMoveVector to a new position.
Definition: sch_field.h:148
bool HitTest(const wxPoint &aPosition, int aAccuracy) const override
Function HitTest tests if aPosition is contained within or on the bounding box of an item...
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
void SetTimeStamp(timestamp_t aNewTimeStamp)
Change the time stamp to aNewTimeStamp and updates the reference path.
Class SCH_FIELD instances are attached to a component and provide a place for the component&#39;s value...
Definition: sch_field.h:56
void SetModified()
long timestamp_t
timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the ti...
Definition: base_struct.h:155
void GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it&#39;s internal state for displ...
void Rotate(wxPoint aPosition) override
Function Rotate rotates the item around aPosition 90 degrees in the clockwise direction.
void AutoAutoplaceFields(SCH_SCREEN *aScreen)
Autoplace fields only if correct to do so automatically.
SCH_FIELD * FindField(const wxString &aFieldName, bool aIncludeDefaultFields=true)
Search for a SCH_FIELD with aFieldName.
wxString GetAliasDescription() const
Return information about the aliased parts.
void Plot(PLOTTER *aPlotter) override
Function Plot plots the schematic item to aPlotter.
PART_REF & GetPartRef()
TRANSFORM & GetTransform() const
void SetTransform(const TRANSFORM &aTransform)
PNG memory record (file in memory).
Definition: bitmap_types.h:41
void UpdateUnit(int aUnit)
Change the unit number to aUnit without setting any internal flags.
wxString GetPath(const SCH_SHEET_PATH *sheet) const
int GetOrientation()
Get the display symbol orientation.
AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
std::string toUTFTildaText(const wxString &txt)
Function toUTFTildaText convert a wxString to UTF8 and replace any control characters with a ~...
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:91
const SCH_SHEET_PATH * m_currentSheetPath
A temporary sheet path is required to generate the correct reference designator string in complex hie...
wxPoint GetScreenCoord(const wxPoint &aPoint)
Returns the coordinate points relative to the orientation of the symbol to aPoint.
bool Resolve(PART_LIBS *aLibs)
Assigns the current LIB_PART from aLibs which this symbol is based on.
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
bool IsConnectable() const override
Function IsConnectable returns true if the schematic item can connect to another schematic item...
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
void GetConnectionPoints(std::vector< wxPoint > &aPoints) const override
Function GetConnectionPoints add all the connection points for this item to aPoints.
std::weak_ptr< LIB_PART > PART_REF
weak pointer to LIB_PART
wxString GetPrefix() const
int GetUnitSelection(SCH_SHEET_PATH *aSheet)
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Function GetEndPoints adds the schematic item end points to aItemList if the item has end points...
wxString GetFieldText(const wxString &aFieldName, bool aIncludeDefaultFields=true) const
Search for a field named aFieldName and returns text associated with this field.
void MirrorX(int aXaxis_position) override
Function MirrorX mirrors item relative to the X axis about aXaxis_position.
void SetPosition(const wxPoint &aPosition) override
Function SetPosition set the schematic item position to aPosition.
LIB_PIN * GetPin(const wxString &number)
Find a symbol pin by number.
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
LIB_ITEM * GetDrawItem(const wxPoint &aPosition, KICAD_T aType=TYPE_NOT_INIT)
Return the component library item at aPosition that is part of this component.
void SetUnitSelection(SCH_SHEET_PATH *aSheet, int aUnitSelection)
void SwapData(SCH_ITEM *aItem) override
Function SwapData swap the internal data structures aItem with the schematic item.
int GetUnitCount() const
Return the number of units per package of the symbol.
std::vector< bool > m_isDangling
One isDangling per pin.
Definition: sch_component.h:95
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
std::vector< wxPoint > m_Pins
Definition: sch_component.h:96
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
bool CanConnect(const SCH_ITEM *aItem) const override
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populates a std::vector with SCH_FIELDs.
wxString GetAliasDocumentation() const
Return the documentation text for the given part alias.
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
void ClearFieldsAutoplaced()
Set fields automatically placed flag false.
Class NETLIST_OBJECT_LIST is a container holding and owning NETLIST_OBJECTs, which are connected item...
void SetConvert(int aConvert)
bool IsSelectStateChanged(const wxRect &aRect) override
Function IsSelectStateChanged checks if the selection state of an item inside aRect has changed...
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
void SetCurrentSheetPath(const SCH_SHEET_PATH *aSheetPath)
const INSPECTOR_FUNC & INSPECTOR
Definition: base_struct.h:100
Class SCH_COLLECTOR.
int GetConvert() const
void SetLibId(const LIB_ID &aName, PART_LIBS *aLibs=NULL)
void Move(const wxPoint &aMoveVector) override
Function Move moves the item by aMoveVector to a new position.
void UpdatePinCache()
Updates the local cache of pin positions.
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:93
bool IsMovableFromAnchorPoint() override
Return true for items which are moved with the anchor point at mouse cursor and false for items moved...
void SetFields(const SCH_FIELDS &aFields)
Set multiple schematic fields.
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
static void ResolveAll(const SCH_COLLECTOR &aComponents, PART_LIBS *aLibs)
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:37
std::vector< SCH_FIELD > SCH_FIELDS
A container for several SCH_FIELD items.
Definition: sch_component.h:53
bool operator<(const SCH_ITEM &aItem) const override
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
const wxArrayString & GetPathsAndReferences() const
SCH_COMPONENT(const wxPoint &pos=wxPoint(0, 0), SCH_ITEM *aParent=NULL)
Define a library symbol object.
SCH_FIELD * AddField(const SCH_FIELD &aField)
Add a field to the symbol.
bool IsDangling() const override
Return whether any pin in this symbol is dangling.
void GetNetListItem(NETLIST_OBJECT_LIST &aNetListItems, SCH_SHEET_PATH *aSheetPath) override
Function GetNetListItem creates a new NETLIST_OBJECT for the schematic object and adds it to aNetList...
void SetUnit(int aUnit)
Change the unit number to aUnit.
bool Matches(wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation) override
Function Matches compares the item against the search criteria in aSearchData.
int GetUnit() const
Class SCH_SHEET_PATH.
bool IsInNetlist() const
bool IsReplaceable() const override
Function IsReplaceable.
void ClearAnnotation(SCH_SHEET_PATH *aSheetPath)
Clear exiting component annotation.
const wxString GetRef(const SCH_SHEET_PATH *aSheet)
Return the reference for the given sheet path.
bool Show(bool show) override
bool operator==(const SCH_COMPONENT &aComponent) const
std::weak_ptr< LIB_PART > PART_REF
Definition: sch_component.h:59
SCH_ITEM & operator=(const SCH_ITEM &aItem)
A collection of PART_LIB objects.
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:82
void Init(const wxPoint &pos=wxPoint(0, 0))
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
bool IsDanglingStateChanged(std::vector< DANGLING_END_ITEM > &aItemList) override
Test if the component&#39;s dangling state has changed for all pins.
Base plotter engine class.
Definition: plotter.h:96
void GetPins(std::vector< LIB_PIN * > &aPinsList)
Populate a vector with all the pins.
void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Automatically orient all the fields in the component.
int GetFieldCount() const
Return the number of fields in this symbol.
void AddHierarchicalReference(const wxString &aPath, const wxString &aRef, int aMulti)
Add a full hierarchical reference to this symbol.
wxString GetSelectMenuText() const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
void MirrorY(int aYaxis_position) override
Function MirrorY mirrors item relative to the Y axis about aYaxis_position.
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, GR_DRAWMODE aDrawMode, COLOR4D aColor=COLOR4D::UNSPECIFIED) override
Function Draw Draw a schematic item.
Dialog used to edit SCH_COMPONENT objects in a schematic.
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
void SetPrefix(const wxString &aPrefix)
wxPoint GetPosition() const override
Function GetPosition.
const LIB_ID & GetLibId() const
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:162
SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
bool operator!=(const SCH_COMPONENT &aComponent) const
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
Definition of the SCH_FIELD class for Eeschema.
SEARCH_RESULT
Definition: base_struct.h:64
static bool IsReferenceStringValid(const wxString &aReferenceString)
Tests for an acceptable reference string.
wxString GetClass() const override
Function GetClass returns the class name.
AUTOPLACED m_fieldsAutoplaced
indicates status of field autoplacement
Definition: sch_component.h:98
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:86
Object used to load, save, search, and otherwise manipulate symbol library files. ...
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:90
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
bool doIsConnected(const wxPoint &aPosition) const override
Function doIsConnected provides the object specific test to see if it is connected to aPosition...
static void UpdateAllPinCaches(const SCH_COLLECTOR &aComponents)
Update the pin cache for all components in aComponents.
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
wxPoint GetPinPhysicalPosition(const LIB_PIN *Pin) const