KiCad PCB EDA Suite
SCH_COMPONENT Class Reference

Schematic symbol object. More...

#include <sch_component.h>

Inheritance diagram for SCH_COMPONENT:
SCH_ITEM EDA_ITEM KIGFX::VIEW_ITEM INSPECTABLE

Public Member Functions

 SCH_COMPONENT (const wxPoint &pos=wxPoint(0, 0), SCH_ITEM *aParent=NULL)
 
 SCH_COMPONENT (LIB_PART &aPart, LIB_ID aLibId, SCH_SHEET_PATH *aSheet, int unit=0, int convert=0, const wxPoint &pos=wxPoint(0, 0))
 Create schematic component from library component object. More...
 
 SCH_COMPONENT (LIB_PART &aPart, SCH_SHEET_PATH *aSheet, COMPONENT_SELECTION &aSel, const wxPoint &pos=wxPoint(0, 0))
 
 SCH_COMPONENT (const SCH_COMPONENT &aComponent)
 Clones aComponent into a new schematic symbol object. More...
 
 ~SCH_COMPONENT ()
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
const std::vector< COMPONENT_INSTANCE_REFERENCE > & GetInstanceReferences ()
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
bool IsMovableFromAnchorPoint () override
 Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor. More...
 
void SetLibId (const LIB_ID &aName)
 
const LIB_IDGetLibId () const
 
void SetSchSymbolLibraryName (const wxString &aName)
 The name of the symbol in the schematic library symbol list. More...
 
wxString GetSchSymbolLibraryName () const
 
bool UseLibIdLookup () const
 
std::unique_ptr< LIB_PART > & GetPartRef ()
 
void SetLibSymbol (LIB_PART *aLibSymbol)
 Set this schematic symbol library symbol reference to aLibSymbol. More...
 
wxString GetDescription () const
 Return information about the aliased parts. More...
 
wxString GetDatasheet () const
 Return the documentation text for the given part alias. More...
 
int GetUnit () const
 
void UpdatePins ()
 Updates the cache of SCH_PIN objects for each pin. More...
 
void SetUnit (int aUnit)
 Change the unit number to aUnit. More...
 
void UpdateUnit (int aUnit)
 Change the unit number to aUnit without setting any internal flags. More...
 
int GetConvert () const
 
void SetConvert (int aConvert)
 
wxString GetPrefix () const
 
void SetPrefix (const wxString &aPrefix)
 
TRANSFORMGetTransform () const
 
void SetTransform (const TRANSFORM &aTransform)
 
int GetUnitCount () const
 Return the number of units per package of the symbol. More...
 
void SetOrientation (int aOrientation)
 Compute the new transform matrix based on aOrientation for the symbol which is applied to the current transform. More...
 
int GetOrientation ()
 Get the display symbol orientation. More...
 
void GetContextualTextVars (wxArrayString *aVars) const
 Return the list of system text vars & fields for this symbol. More...
 
bool ResolveTextVar (wxString *token, int aDepth=0) const
 Resolve any references to system tokens supported by the component. More...
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
void ClearAnnotation (const SCH_SHEET_PATH *aSheetPath)
 Clear exiting component annotation. More...
 
bool AddSheetPathReferenceEntryIfMissing (const KIID_PATH &aSheetPath)
 Add an instance to the alternate references list (m_instanceReferences), if this entry does not already exist. More...
 
bool ReplaceInstanceSheetPath (const KIID_PATH &aOldSheetPath, const KIID_PATH &aNewSheetPath)
 Replace aOldSheetPath with aNewSheetPath in the instance list. More...
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
const EDA_RECT GetBoundingBox (bool aIncludeInvisibleText) const
 
EDA_RECT GetBodyBoundingBox () const
 Return a bounding box for the symbol body but not the fields. More...
 
SCH_FIELDGetField (int aFieldNdx)
 Returns a field in this symbol. More...
 
const SCH_FIELDGetField (int aFieldNdx) const
 
wxString GetFieldText (const wxString &aFieldName, SCH_EDIT_FRAME *aFrame) const
 Search for a field named aFieldName and returns text associated with this field. More...
 
void GetFields (std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
 Populates a std::vector with SCH_FIELDs. More...
 
std::vector< SCH_FIELD > & GetFields ()
 Returns a vector of fields from the component. More...
 
SCH_FIELDAddField (const SCH_FIELD &aField)
 Add a field to the symbol. More...
 
void RemoveField (const wxString &aFieldName)
 Removes a user field from the symbol. More...
 
SCH_FIELDFindField (const wxString &aFieldName, bool aIncludeDefaultFields=true)
 Search for a SCH_FIELD with aFieldName. More...
 
void SetFields (const SCH_FIELDS &aFields)
 Set multiple schematic fields. More...
 
void UpdateFields (bool aResetStyle, bool aResetRef=false)
 Restores fields to the original library values. More...
 
int GetFieldCount () const
 Return the number of fields in this symbol. More...
 
void AutoplaceFields (SCH_SCREEN *aScreen, bool aManual) override
 Automatically orient all the fields in the component. More...
 
SCH_PINGetPin (const wxString &number)
 Find a symbol pin by number. More...
 
void GetLibPins (std::vector< LIB_PIN * > &aPinsList)
 Populate a vector with all the pins from the library object. More...
 
SCH_PINGetPin (LIB_PIN *aLibPin)
 
std::vector< SCH_PIN * > GetPins (const SCH_SHEET_PATH *aSheet=nullptr) const
 Retrieves a list of the SCH_PINs for the given sheet path. More...
 
std::vector< std::unique_ptr< SCH_PIN > > & GetRawPins ()
 
void Print (RENDER_SETTINGS *aSettings, const wxPoint &aOffset) override
 Print a component. More...
 
void SwapData (SCH_ITEM *aItem) override
 Swap the internal data structures aItem with the schematic item. More...
 
const wxString GetRef (const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
 Return the reference for the given sheet path. More...
 
void SetRef (const SCH_SHEET_PATH *aSheet, const wxString &aReference)
 Set the reference for the given sheet path for this symbol. More...
 
bool IsAnnotated (const SCH_SHEET_PATH *aSheet)
 Checks if the component has a valid annotation (reference) for the given sheet path. More...
 
void AddHierarchicalReference (const KIID_PATH &aPath, const wxString &aRef, int aUnit, const wxString &aValue=wxEmptyString, const wxString &aFootprint=wxEmptyString)
 Add a full hierarchical reference to this symbol. More...
 
int GetUnitSelection (const SCH_SHEET_PATH *aSheet) const
 
void SetUnitSelection (const SCH_SHEET_PATH *aSheet, int aUnitSelection)
 
const wxString GetValue (const SCH_SHEET_PATH *sheet) const
 
void SetValue (const SCH_SHEET_PATH *sheet, const wxString &aValue)
 
void SetValue (const wxString &aValue)
 
const wxString GetFootprint (const SCH_SHEET_PATH *sheet) const
 
void SetFootprint (const SCH_SHEET_PATH *sheet, const wxString &aFootprint)
 
void SetFootprint (const wxString &aFootprint)
 
void Move (const wxPoint &aMoveVector) override
 Move the item by aMoveVector to a new position. More...
 
void MirrorY (int aYaxis_position) override
 Mirror item relative to the Y axis about aYaxis_position. More...
 
void MirrorX (int aXaxis_position) override
 Mirror item relative to the X axis about aXaxis_position. More...
 
void Rotate (wxPoint aPosition) override
 Rotate the item around aPosition 90 degrees in the clockwise direction. More...
 
bool Matches (wxFindReplaceData &aSearchData, void *aAuxData) override
 Function Matches compares the item against the search criteria in aSearchData. More...
 
void GetEndPoints (std::vector< DANGLING_END_ITEM > &aItemList) override
 Add the schematic item end points to aItemList if the item has end points. More...
 
bool UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemList, const SCH_SHEET_PATH *aPath=nullptr) override
 Test if the component's dangling state has changed for all pins. More...
 
wxPoint GetPinPhysicalPosition (const LIB_PIN *Pin) const
 
bool IsConnectable () const override
 
bool CanConnect (const SCH_ITEM *aItem) const override
 
bool IsInNetlist () const
 
std::vector< wxPointGetConnectionPoints () const override
 Add all the connection points for this item to aPoints. More...
 
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 its member data. More...
 
LIB_ITEMGetDrawItem (const wxPoint &aPosition, KICAD_T aType=TYPE_NOT_INIT)
 Return the component library item at aPosition that is part of this component. More...
 
wxString GetSelectMenuText (EDA_UNITS aUnits) const override
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAP_DEF GetMenuImage () const override
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
bool operator< (const SCH_ITEM &aItem) const override
 
bool operator== (const SCH_COMPONENT &aComponent) const
 
bool operator!= (const SCH_COMPONENT &aComponent) const
 
SCH_COMPONENToperator= (const SCH_ITEM &aItem)
 
bool IsReplaceable () const override
 Function IsReplaceable. More...
 
wxPoint GetPosition () const override
 
void SetPosition (const wxPoint &aPosition) override
 
bool HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
 Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
 
void Plot (PLOTTER *aPlotter) override
 Plot the schematic item to aPlotter. More...
 
EDA_ITEMClone () const override
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
void ClearBrightenedPins ()
 
bool HasBrightenedPins ()
 
bool GetIncludeInBom () const
 
void SetIncludeInBom (bool aIncludeInBom)
 
bool GetIncludeOnBoard () const
 
void SetIncludeOnBoard (bool aIncludeOnBoard)
 
SCH_ITEMDuplicate (bool doClone=false) const
 Routine to create a new copy of given item. More...
 
wxPointGetStoredPos ()
 
void SetStoredPos (wxPoint aPos)
 
SCHEMATICSchematic () const
 Searches the item hierarchy to find a SCHEMATIC. More...
 
virtual bool IsLocked () const
 
virtual void SetLocked (bool aLocked)
 Set the 'lock' status to aLocked for of this item. More...
 
SCH_LAYER_ID GetLayer () const
 Return the layer this item is on. More...
 
void SetLayer (SCH_LAYER_ID aLayer)
 Set the layer this item is on. More...
 
virtual int GetPenWidth () const
 
virtual bool IsDangling () const
 
void ClearConnections ()
 Clears all of the connection items from the list. More...
 
bool IsConnected (const wxPoint &aPoint) const
 Test the item to see if it is connected to aPoint. More...
 
SCH_CONNECTIONConnection (const SCH_SHEET_PATH &aPath) const
 Retrieve the connection associated with this object in the given sheet. More...
 
SCH_ITEM_SETConnectedItems (const SCH_SHEET_PATH &aPath)
 Retrieves the set of items connected to this item on the given sheet. More...
 
void AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
 Adds a connection link between this item and another. More...
 
SCH_CONNECTIONInitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
 Creates a new connection object associated with this object. More...
 
virtual bool ConnectionPropagatesTo (const EDA_ITEM *aItem) const
 Returns true if this item should propagate connection info to aItem. More...
 
bool IsConnectivityDirty ()
 
void SetConnectivityDirty (bool aDirty=true)
 
NETCLASSPTR NetClass () const
 
FIELDS_AUTOPLACED GetFieldsAutoplaced () const
 Return whether the fields have been automatically placed. More...
 
void ClearFieldsAutoplaced ()
 Set fields automatically placed flag false. More...
 
void AutoAutoplaceFields (SCH_SCREEN *aScreen)
 Autoplace fields only if correct to do so automatically. More...
 
virtual bool HasLineStroke () const
 Check if this schematic item has line stoke properties. More...
 
virtual STROKE_PARAMS GetStroke () const
 
virtual void SetStroke (const STROKE_PARAMS &aStroke)
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
KICAD_T Type () const
 Function Type() More...
 
EDA_ITEMGetParent () const
 
virtual void SetParent (EDA_ITEM *aParent)
 
bool IsModified () const
 
bool IsNew () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool HasFlag (STATUS_FLAGS aFlag)
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[]) const
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
bool IsForceVisible () const
 
virtual const wxPoint GetFocusPosition () const
 Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual double ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
bool Set (PROPERTY_BASE *aProperty, wxAny &aValue)
 
template<typename T >
bool Set (PROPERTY_BASE *aProperty, T aValue)
 
template<typename T >
bool Set (const wxString &aProperty, T aValue)
 
wxAny Get (PROPERTY_BASE *aProperty)
 
template<typename T >
Get (PROPERTY_BASE *aProperty)
 
template<typename T >
boost::optional< T > Get (const wxString &aProperty)
 

Static Public Member Functions

static bool ClassOf (const EDA_ITEM *aItem)
 
static bool IsReferenceStringValid (const wxString &aReferenceString)
 Tests for an acceptable reference string. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
static bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Public Attributes

const KIID m_Uuid
 

Protected Member Functions

bool Matches (const wxString &aText, wxFindReplaceData &aSearchData)
 Function Matches compares aText against search criteria in aSearchData. More...
 

Protected Attributes

SCH_LAYER_ID m_Layer
 
EDA_ITEMS m_connections
 
FIELDS_AUTOPLACED m_fieldsAutoplaced
 
wxPoint m_storedPos
 
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SETm_connected_items
 Stores pointers to other items that are connected to this one, per sheet. More...
 
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
 Stores connectivity information, per sheet. More...
 
bool m_connectivity_dirty
 True if connectivity info might be out of date. More...
 
STATUS_FLAGS m_Status
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
STATUS_FLAGS m_Flags
 

Private Member Functions

void Init (const wxPoint &pos=wxPoint(0, 0))
 
bool doIsConnected (const wxPoint &aPosition) const override
 Provide the object specific test to see if it is connected to aPosition. More...
 

Private Attributes

wxPoint m_Pos
 
LIB_ID m_lib_id
 Name and library the symbol was loaded from, i.e. 74xx:74LS00. More...
 
int m_unit
 The unit for multiple part per package components. More...
 
int m_convert
 The alternate body style for components that have more than one body style defined. More...
 
wxString m_prefix
 C, R, U, Q etc - the first character which typically indicates what the component is. More...
 
wxString m_schLibSymbolName
 The name used to look up a symbol in the symbol library embedded in a schematic. More...
 
TRANSFORM m_transform
 The rotation/mirror transformation matrix. More...
 
SCH_FIELDS m_Fields
 Variable length list of fields. More...
 
std::unique_ptr< LIB_PARTm_part
 
std::vector< std::unique_ptr< SCH_PIN > > m_pins
 
std::unordered_map< LIB_PIN *, unsigned > m_pinMap
 
bool m_isInNetlist
 True if the component should appear in the netlist. More...
 
bool m_inBom
 True to include in bill of materials export. More...
 
bool m_onBoard
 True to include in netlist when updating board. More...
 
std::vector< COMPONENT_INSTANCE_REFERENCEm_instanceReferences
 

Detailed Description

Schematic symbol object.

Definition at line 80 of file sch_component.h.

Constructor & Destructor Documentation

◆ SCH_COMPONENT() [1/4]

SCH_COMPONENT::SCH_COMPONENT ( const wxPoint pos = wxPoint( 0, 0 ),
SCH_ITEM aParent = NULL 
)

Definition at line 94 of file sch_component.cpp.

94  :
95  SCH_ITEM( aParent, SCH_COMPONENT_T )
96 {
97  Init( aPos );
98 }
void Init(const wxPoint &pos=wxPoint(0, 0))
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:50

References Init().

Referenced by Clone().

◆ SCH_COMPONENT() [2/4]

SCH_COMPONENT::SCH_COMPONENT ( LIB_PART aPart,
LIB_ID  aLibId,
SCH_SHEET_PATH aSheet,
int  unit = 0,
int  convert = 0,
const wxPoint pos = wxPoint( 0, 0 ) 
)

Create schematic component from library component object.

Parameters
aPart- library part to create schematic component from.
aLibId- libId of alias to create.
aSheet- Schematic sheet the component is place into.
unit- Part for components that have multiple parts per package.
convert- Use the alternate body style for the schematic component.
pos- Position to place new component.
setNewItemFlag- Set the component IS_NEW and IS_MOVED flags.

Definition at line 101 of file sch_component.cpp.

102  :
104 {
105  Init( pos );
106 
107  m_unit = unit;
108  m_convert = convert;
109  m_lib_id = aLibId;
110 
111  std::unique_ptr< LIB_PART > part;
112 
113  part = aPart.Flatten();
114  part->SetParent();
115  SetLibSymbol( part.release() );
116 
117  // Copy fields from the library component
118  UpdateFields( true, true );
119 
120  // Update the reference -- just the prefix for now.
121  if( sheet )
122  SetRef( sheet, m_part->GetReferenceField().GetText() + wxT( "?" ) );
123  else
124  m_prefix = m_part->GetReferenceField().GetText() + wxT( "?" );
125 
126  // Inherit the include in bill of materials and board netlist settings from library symbol.
127  m_inBom = aPart.GetIncludeInBom();
128  m_onBoard = aPart.GetIncludeOnBoard();
129 }
void UpdateFields(bool aResetStyle, bool aResetRef=false)
Restores fields to the original library values.
void SetLibSymbol(LIB_PART *aLibSymbol)
Set this schematic symbol library symbol reference to aLibSymbol.
bool m_onBoard
True to include in netlist when updating board.
#define NULL
std::unique_ptr< LIB_PART > m_part
std::unique_ptr< LIB_PART > Flatten() const
Return a flattened symbol inheritance to the caller.
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85
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.
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_component.h:84
bool GetIncludeOnBoard() const
bool m_inBom
True to include in bill of materials export.
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:86
bool GetIncludeInBom() const
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is.
Definition: sch_component.h:89
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:50

References LIB_PART::Flatten(), LIB_PART::GetIncludeInBom(), LIB_PART::GetIncludeOnBoard(), Init(), m_convert, m_inBom, m_lib_id, m_onBoard, m_part, m_prefix, m_unit, SetLibSymbol(), SetRef(), and UpdateFields().

◆ SCH_COMPONENT() [3/4]

SCH_COMPONENT::SCH_COMPONENT ( LIB_PART aPart,
SCH_SHEET_PATH aSheet,
COMPONENT_SELECTION aSel,
const wxPoint pos = wxPoint( 0, 0 ) 
)

Definition at line 132 of file sch_component.cpp.

133  :
134  SCH_COMPONENT( aPart, aSel.LibId, aSheet, aSel.Unit, aSel.Convert, pos )
135 {
136  // Set any fields that were modified as part of the component selection
137  for( auto const& i : aSel.Fields )
138  {
139  auto field = this->GetField( i.first );
140 
141  if( field )
142  field->SetText( i.second );
143  }
144 }
SCH_COMPONENT(const wxPoint &pos=wxPoint(0, 0), SCH_ITEM *aParent=NULL)
SCH_FIELD * GetField(int aFieldNdx)
Returns a field in this symbol.
std::vector< std::pair< int, wxString > > Fields
Definition: sch_screen.h:86

References COMPONENT_SELECTION::Fields, and GetField().

◆ SCH_COMPONENT() [4/4]

SCH_COMPONENT::SCH_COMPONENT ( const SCH_COMPONENT aComponent)

Clones aComponent into a new schematic symbol object.

All fields are copied as is except for the linked list management pointers which are set to NULL, and the SCH_FIELD's m_Parent pointers which are set to the new object.

Parameters
aComponentis the schematic symbol to clone.

Definition at line 147 of file sch_component.cpp.

147  :
148  SCH_ITEM( aComponent )
149 {
150  m_Parent = aComponent.m_Parent;
151  m_Pos = aComponent.m_Pos;
152  m_unit = aComponent.m_unit;
153  m_convert = aComponent.m_convert;
154  m_lib_id = aComponent.m_lib_id;
155  m_isInNetlist = aComponent.m_isInNetlist;
156  m_inBom = aComponent.m_inBom;
157  m_onBoard = aComponent.m_onBoard;
158 
159  if( aComponent.m_part )
160  SetLibSymbol( new LIB_PART( *aComponent.m_part.get() ) );
161 
162  const_cast<KIID&>( m_Uuid ) = aComponent.m_Uuid;
163 
164  m_transform = aComponent.m_transform;
165  m_prefix = aComponent.m_prefix;
167  m_Fields = aComponent.m_Fields;
168 
169  // Re-parent the fields, which before this had aComponent as parent
170  for( SCH_FIELD& field : m_Fields )
171  field.SetParent( this );
172 
174 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174
void SetLibSymbol(LIB_PART *aLibSymbol)
Set this schematic symbol library symbol reference to aLibSymbol.
SCH_FIELDS m_Fields
Variable length list of fields.
bool m_onBoard
True to include in netlist when updating board.
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201
bool m_isInNetlist
True if the component should appear in the netlist.
Define a library symbol object.
std::unique_ptr< LIB_PART > m_part
const KIID m_Uuid
Definition: base_struct.h:162
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_component.h:84
bool m_inBom
True to include in bill of materials export.
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:86
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is.
Definition: sch_component.h:89
TRANSFORM m_transform
The rotation/mirror transformation matrix.
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:50

References m_convert, m_Fields, SCH_ITEM::m_fieldsAutoplaced, m_inBom, m_instanceReferences, m_isInNetlist, m_lib_id, m_onBoard, EDA_ITEM::m_Parent, m_part, m_Pos, m_prefix, m_transform, m_unit, EDA_ITEM::m_Uuid, and SetLibSymbol().

◆ ~SCH_COMPONENT()

SCH_COMPONENT::~SCH_COMPONENT ( )
inline

Definition at line 154 of file sch_component.h.

154 { }

Member Function Documentation

◆ AddConnectionTo()

void SCH_ITEM::AddConnectionTo ( const SCH_SHEET_PATH aPath,
SCH_ITEM aItem 
)
inherited

Adds a connection link between this item and another.

Definition at line 184 of file sch_item.cpp.

185 {
186  m_connected_items[ aSheet ].insert( aItem );
187 }
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SET > m_connected_items
Stores pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:206

References SCH_ITEM::m_connected_items.

Referenced by SCH_TEXT::UpdateDanglingState().

◆ AddField()

SCH_FIELD * SCH_COMPONENT::AddField ( const SCH_FIELD aField)

Add a field to the symbol.

Parameters
aFieldis the field to add to this symbol.
Returns
the newly inserted field.

Definition at line 704 of file sch_component.cpp.

705 {
706  int newNdx = m_Fields.size();
707 
708  m_Fields.push_back( aField );
709  return &m_Fields[newNdx];
710 }
SCH_FIELDS m_Fields
Variable length list of fields.

References m_Fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), DIALOG_CHANGE_SYMBOLS::processSymbol(), and UpdateFields().

◆ AddHierarchicalReference()

void SCH_COMPONENT::AddHierarchicalReference ( const KIID_PATH aPath,
const wxString &  aRef,
int  aUnit,
const wxString &  aValue = wxEmptyString,
const wxString &  aFootprint = wxEmptyString 
)

Add a full hierarchical reference to this symbol.

Parameters
aPathis the hierarchical path (/&ltsheet timestamp&gt/&ltcomponent timestamp&gt like /05678E50/A23EF560)
aRefis the local reference like C45, R56
aUnitis the unit selection used for symbols with multiple units per package.
aValueis the value used for this instance
aFootprintis the footprint used for this instance (which might have different hole spacing or other board-specific changes from other intances)

Definition at line 375 of file sch_component.cpp.

378 {
379  // Search for an existing path and remove it if found (should not occur)
380  for( unsigned ii = 0; ii < m_instanceReferences.size(); ii++ )
381  {
382  if( m_instanceReferences[ii].m_Path == aPath )
383  {
384  wxLogTrace( traceSchSheetPaths, "Removing symbol instance:\n"
385  " sheet path %s\n"
386  " reference %s, unit %d from symbol %s.",
387  aPath.AsString(),
388  m_instanceReferences[ii].m_Reference,
389  m_instanceReferences[ii].m_Unit,
390  m_Uuid.AsString() );
391 
392  m_instanceReferences.erase( m_instanceReferences.begin() + ii );
393  ii--;
394  }
395  }
396 
398  instance.m_Path = aPath;
399  instance.m_Reference = aRef;
400  instance.m_Unit = aUnit;
401  instance.m_Value = aValue;
402  instance.m_Footprint = aFootprint;
403 
404  wxLogTrace( traceSchSheetPaths, "Adding symbol instance:\n"
405  " sheet path %s\n"
406  " reference %s, unit %d to symbol %s.",
407  aPath.AsString(),
408  aRef,
409  aUnit,
410  m_Uuid.AsString() );
411 
412  m_instanceReferences.push_back( instance );
413 }
const wxChar *const traceSchSheetPaths
Flag to enable debug output of schematic symbol sheet path manipulation code.
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
wxString AsString() const
Definition: common.cpp:165
A simple container for schematic symbol instance infromation.
const KIID m_Uuid
Definition: base_struct.h:162
wxString AsString() const
Definition: common.h:137

References KIID::AsString(), KIID_PATH::AsString(), COMPONENT_INSTANCE_REFERENCE::m_Footprint, m_instanceReferences, COMPONENT_INSTANCE_REFERENCE::m_Path, COMPONENT_INSTANCE_REFERENCE::m_Reference, COMPONENT_INSTANCE_REFERENCE::m_Unit, EDA_ITEM::m_Uuid, COMPONENT_INSTANCE_REFERENCE::m_Value, and traceSchSheetPaths.

Referenced by AddSheetPathReferenceEntryIfMissing(), SetFootprint(), SetRef(), SetUnitSelection(), SetValue(), and SCH_SHEET_LIST::UpdateSymbolInstances().

◆ AddSheetPathReferenceEntryIfMissing()

bool SCH_COMPONENT::AddSheetPathReferenceEntryIfMissing ( const KIID_PATH aSheetPath)

Add an instance to the alternate references list (m_instanceReferences), if this entry does not already exist.

Do nothing if already exists. In component lists shared by more than one sheet path, an entry for each sheet path must exist to manage references

Parameters
aSheetPathis the candidate sheet path this sheet path is the sheet path of the sheet containing the component, not the full component sheet path
Returns
false if the alternate reference was existing, true if added.

Definition at line 1016 of file sch_component.cpp.

1017 {
1018  // a empty sheet path is illegal:
1019  wxCHECK( aSheetPath.size() > 0, false );
1020 
1021  wxString reference_path;
1022 
1023  for( const COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
1024  {
1025  // if aSheetPath is found, nothing to do:
1026  if( instance.m_Path == aSheetPath )
1027  return false;
1028  }
1029 
1030  // This entry does not exist: add it, with its last-used reference
1031  AddHierarchicalReference( aSheetPath, m_Fields[REFERENCE].GetText(), m_unit );
1032  return true;
1033 }
SCH_FIELDS m_Fields
Variable length list of fields.
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
Field Reference of part, i.e. "IC21".
A simple container for schematic symbol instance infromation.
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85
void AddHierarchicalReference(const KIID_PATH &aPath, const wxString &aRef, int aUnit, const wxString &aValue=wxEmptyString, const wxString &aFootprint=wxEmptyString)
Add a full hierarchical reference to this symbol.

References AddHierarchicalReference(), m_Fields, m_instanceReferences, m_unit, and REFERENCE.

Referenced by SCH_SCREEN::EnsureAlternateReferencesExist().

◆ AutoAutoplaceFields()

void SCH_ITEM::AutoAutoplaceFields ( SCH_SCREEN aScreen)
inlineinherited

Autoplace fields only if correct to do so automatically.

Fields that have been moved by hand are not automatically placed.

Parameters
aScreenis the SCH_SCREEN associated with the current instance of the component.

Definition at line 457 of file sch_item.h.

458  {
459  if( GetFieldsAutoplaced() )
461  }
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition: sch_item.h:442
virtual void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Definition: sch_item.h:463

References SCH_ITEM::AutoplaceFields(), FIELDS_AUTOPLACED_MANUAL, and SCH_ITEM::GetFieldsAutoplaced().

Referenced by SCH_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), and SCH_EDIT_FRAME::SelectUnit().

◆ AutoplaceFields()

void SCH_COMPONENT::AutoplaceFields ( SCH_SCREEN aScreen,
bool  aManual 
)
overridevirtual

Automatically orient all the fields in the component.

Parameters
aScreenis the SCH_SCREEN associated with the current instance of the component. This can be NULL when aManual is false.
aManualshould be true if the autoplace was manually initiated (e.g. by a hotkey or a menu item). Some more 'intelligent' routines will be used that would be annoying if done automatically during moves.

Reimplemented from SCH_ITEM.

Definition at line 680 of file eeschema/autoplace_fields.cpp.

681 {
682  if( aManual )
683  wxASSERT_MSG( aScreen, "A SCH_SCREEN pointer must be given for manual autoplacement" );
684 
685  AUTOPLACER autoplacer( this, aScreen );
686  autoplacer.DoAutoplace( aManual );
688 }
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201

References AUTOPLACER::DoAutoplace(), FIELDS_AUTOPLACED_AUTO, FIELDS_AUTOPLACED_MANUAL, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), and SCH_DRAWING_TOOLS::PlaceComponent().

◆ CanConnect()

bool SCH_COMPONENT::CanConnect ( const SCH_ITEM aItem) const
inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 616 of file sch_component.h.

617  {
618  return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
619  ( aItem->Type() == SCH_NO_CONNECT_T ) ||
620  ( aItem->Type() == SCH_JUNCTION_T ) ||
621  ( aItem->Type() == SCH_COMPONENT_T ) ;
622  }
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:279
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References SCH_ITEM::GetLayer(), LAYER_WIRE, SCH_COMPONENT_T, SCH_JUNCTION_T, SCH_LINE_T, SCH_NO_CONNECT_T, and EDA_ITEM::Type().

◆ ClassOf()

static bool SCH_COMPONENT::ClassOf ( const EDA_ITEM aItem)
inlinestatic

Definition at line 156 of file sch_component.h.

157  {
158  return aItem && SCH_COMPONENT_T == aItem->Type();
159  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References SCH_COMPONENT_T, and EDA_ITEM::Type().

◆ ClearAnnotation()

void SCH_COMPONENT::ClearAnnotation ( const SCH_SHEET_PATH aSheetPath)

Clear exiting component annotation.

For example, IC23 would be changed to IC? and unit number would be reset.

Parameters
aSheetPathis the hierarchical path of the symbol to clear or remove all annotations for this symbol if NULL.

Definition at line 973 of file sch_component.cpp.

974 {
975  // Build a reference with no annotation,
976  // i.e. a reference ended by only one '?'
977  wxString defRef = m_prefix;
978 
979  if( !IsReferenceStringValid( defRef ) )
980  { // This is a malformed reference: reinit this reference
981  m_prefix = defRef = wxT("U"); // Set to default ref prefix
982  }
983 
984  while( defRef.Last() == '?' )
985  defRef.RemoveLast();
986 
987  defRef.Append( wxT( "?" ) );
988 
989  if( aSheetPath )
990  {
991  KIID_PATH path = aSheetPath->Path();
992 
994  {
995  if( instance.m_Path == path )
996  instance.m_Reference = defRef;
997  }
998  }
999  else
1000  {
1002  instance.m_Reference = defRef;
1003  }
1004 
1005  for( std::unique_ptr<SCH_PIN>& pin : m_pins )
1006  pin->ClearDefaultNetName( aSheetPath );
1007 
1008  // These 2 changes do not work in complex hierarchy.
1009  // When a clear annotation is made, the calling function must call a
1010  // UpdateAllScreenReferences for the active sheet.
1011  // But this call cannot made here.
1012  m_Fields[REFERENCE].SetText( defRef ); //for drawing.
1013 }
SCH_FIELDS m_Fields
Variable length list of fields.
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
Field Reference of part, i.e. "IC21".
A simple container for schematic symbol instance infromation.
std::vector< std::unique_ptr< SCH_PIN > > m_pins
static bool IsReferenceStringValid(const wxString &aReferenceString)
Tests for an acceptable reference string.
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is.
Definition: sch_component.h:89

References IsReferenceStringValid(), m_Fields, m_instanceReferences, m_pins, m_prefix, SCH_SHEET_PATH::Path(), and REFERENCE.

Referenced by SCH_SCREEN::ClearAnnotation(), SCH_EDIT_FRAME::DeleteAnnotation(), SCH_EDIT_TOOL::Duplicate(), SCH_EDITOR_CONTROL::Paste(), and SCH_EDITOR_CONTROL::updatePastedInstances().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

◆ ClearBrightenedPins()

void SCH_COMPONENT::ClearBrightenedPins ( )

Definition at line 1836 of file sch_component.cpp.

1837 {
1838  for( auto& pin : m_pins )
1839  pin->ClearBrightened();
1840 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins

References m_pins.

Referenced by SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ ClearConnections()

void SCH_ITEM::ClearConnections ( )
inlineinherited

Clears all of the connection items from the list.

The vector release method is used to prevent the item pointers from being deleted. Do not use the vector erase method on the connection list.

Definition at line 394 of file sch_item.h.

394 { m_connections.clear(); }
EDA_ITEMS m_connections
Definition: sch_item.h:200

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )
inlineinherited

Set fields automatically placed flag false.

Definition at line 447 of file sch_item.h.

FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_MOVE_TOOL::moveItem(), DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 233 of file base_struct.h.

233 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), LIB_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceModule(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::RollbackPartFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 245 of file base_struct.h.

246  {
248  DO_NOT_DRAW );
249  }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:114
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: base_struct.h:125
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:128
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:127
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:123
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:233
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:129
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:122

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, ENDPOINT, IS_LINKED, SKIP_STRUCT, STARTPOINT, and TEMP_SELECTED.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 154 of file view_item.h.

155  {
157  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:162
#define NULL

References KIGFX::VIEW_ITEM::m_viewPrivData, and NULL.

Referenced by KIGFX::VIEW::OnDestroy().

◆ Clone()

EDA_ITEM * SCH_COMPONENT::Clone ( ) const
overridevirtual

Function Clone creates a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns
A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 206 of file sch_component.cpp.

207 {
208  return new SCH_COMPONENT( *this );
209 }
SCH_COMPONENT(const wxPoint &pos=wxPoint(0, 0), SCH_ITEM *aParent=NULL)

References SCH_COMPONENT().

Referenced by SCH_DRAWING_TOOLS::PlaceComponent().

◆ ConnectedItems()

SCH_ITEM_SET & SCH_ITEM::ConnectedItems ( const SCH_SHEET_PATH aPath)
inherited

Retrieves the set of items connected to this item on the given sheet.

Definition at line 178 of file sch_item.cpp.

179 {
180  return m_connected_items[ aSheet ];
181 }
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SET > m_connected_items
Stores pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:206

References SCH_ITEM::m_connected_items.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), CONNECTION_GRAPH::buildConnectionGraph(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ Connection()

◆ ConnectionPropagatesTo()

virtual bool SCH_ITEM::ConnectionPropagatesTo ( const EDA_ITEM aItem) const
inlinevirtualinherited

Returns true if this item should propagate connection info to aItem.

Reimplemented in SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 431 of file sch_item.h.

431 { return true; }

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

◆ doIsConnected()

bool SCH_COMPONENT::doIsConnected ( const wxPoint aPosition) const
overrideprivatevirtual

Provide the object specific test to see if it is connected to aPosition.

Note
Override this function if the derived object can be connect to another object such as a wire, bus, or junction. Do not override this function for objects that cannot have connections. The default will always return false. This functions is call through the public function IsConnected() which performs tests common to all schematic items before calling the item specific connection testing.
Parameters
aPositionA reference to a wxPoint object containing the test position.
Returns
True if connection to aPosition exists.

Reimplemented from SCH_ITEM.

Definition at line 1776 of file sch_component.cpp.

1777 {
1778  wxPoint new_pos = m_transform.InverseTransform().TransformCoordinate( aPosition - m_Pos );
1779 
1780  for( const auto& pin : m_pins )
1781  {
1782  // Collect only pins attached to the current unit and convert.
1783  // others are not associated to this component instance
1784  int pin_unit = pin->GetLibPin()->GetUnit();
1785  int pin_convert = pin->GetLibPin()->GetConvert();
1786 
1787  if( pin_unit > 0 && pin_unit != GetUnit() )
1788  continue;
1789 
1790  if( pin_convert > 0 && pin_convert != GetConvert() )
1791  continue;
1792 
1793  if( pin->GetLocalPosition() == new_pos )
1794  return true;
1795  }
1796 
1797  return false;
1798 }
TRANSFORM InverseTransform() const
Calculate the Inverse mirror/rotation transform.
Definition: transform.cpp:59
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
int GetUnit() const
int GetConvert() const
std::vector< std::unique_ptr< SCH_PIN > > m_pins
TRANSFORM m_transform
The rotation/mirror transformation matrix.

References GetConvert(), GetUnit(), TRANSFORM::InverseTransform(), m_pins, m_Pos, m_transform, and TRANSFORM::TransformCoordinate().

◆ Duplicate()

SCH_ITEM * SCH_ITEM::Duplicate ( bool  doClone = false) const
inherited

Routine to create a new copy of given item.

The new object is not put in draw list (not linked).

Parameters
doClone(default = false) indicates unique values (such as timestamp and sheet name) should be duplicated. Use only for undo/redo operations.

Definition at line 81 of file sch_item.cpp.

82 {
83  SCH_ITEM* newItem = (SCH_ITEM*) Clone();
84 
85  if( !doClone )
86  const_cast<KIID&>( newItem->m_Uuid ) = KIID();
87 
88  newItem->ClearFlags( SELECTED | BRIGHTENED );
89 
90  if( newItem->Type() == SCH_COMPONENT_T )
91  {
92  SCH_COMPONENT* component = (SCH_COMPONENT*) newItem;
93 
94  for( SCH_PIN* pin : component->GetPins() )
95  pin->ClearFlags( SELECTED | BRIGHTENED );
96 
97  for( SCH_FIELD& field : component->GetFields() )
98  field.ClearFlags( SELECTED | BRIGHTENED );
99  }
100 
101  if( newItem->Type() == SCH_SHEET_T )
102  {
103  SCH_SHEET* sheet = (SCH_SHEET*) newItem;
104 
105  for( SCH_FIELD& field : sheet->GetFields() )
106  field.ClearFlags( SELECTED | BRIGHTENED );
107 
108  for( SCH_SHEET_PIN* pin : sheet->GetPins() )
109  pin->ClearFlags( SELECTED | BRIGHTENED );
110  }
111 
112  return newItem;
113 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populates a std::vector with SCH_FIELDs.
std::vector< SCH_FIELD > & GetFields()
Definition: sch_sheet.h:268
#define SELECTED
Definition: base_struct.h:124
Definition: common.h:68
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:139
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
std::vector< SCH_PIN * > GetPins(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieves a list of the SCH_PINs for the given sheet path.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:216
const KIID m_Uuid
Definition: base_struct.h:162
std::vector< SCH_SHEET_PIN * > & GetPins()
Definition: sch_sheet.h:362
Schematic symbol object.
Definition: sch_component.h:80
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:233
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References BRIGHTENED, EDA_ITEM::ClearFlags(), EDA_ITEM::Clone(), SCH_SHEET::GetFields(), GetFields(), SCH_SHEET::GetPins(), GetPins(), EDA_ITEM::m_Uuid, SCH_COMPONENT_T, SCH_SHEET_T, SELECTED, and EDA_ITEM::Type().

Referenced by SCH_EDIT_TOOL::Duplicate(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_EDIT_TOOL::RepeatDrawItem(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ FindField()

SCH_FIELD * SCH_COMPONENT::FindField ( const wxString &  aFieldName,
bool  aIncludeDefaultFields = true 
)

Search for a SCH_FIELD with aFieldName.

Parameters
aFieldNameis the name of the field to find.
aIncludeDefaultFieldssearches the library symbol default fields if true.
Returns
the field if found or NULL if the field was not found.

Definition at line 726 of file sch_component.cpp.

727 {
728  unsigned start = aIncludeDefaultFields ? 0 : MANDATORY_FIELDS;
729 
730  for( unsigned i = start; i < m_Fields.size(); ++i )
731  {
732  if( aFieldName == m_Fields[i].GetName( false ) )
733  return &m_Fields[i];
734  }
735 
736  return NULL;
737 }
SCH_FIELDS m_Fields
Variable length list of fields.
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
#define NULL

References m_Fields, MANDATORY_FIELDS, and NULL.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), NETLIST_EXPORTER_PSPICE::GetSpiceField(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), DIALOG_CHANGE_SYMBOLS::processSymbol(), and UpdateFields().

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 84 of file inspectable.h.

85  {
87  TYPE_ID thisType = TYPE_HASH( *this );
88  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
89  return object ? aProperty->getter( object ) : wxAny();
90  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
virtual wxAny getter(void *aObject) const =0
Provides class metadata.
Definition: property_mgr.h:58
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

References PROPERTY_BASE::getter(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [2/3]

template<typename T >
T INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 93 of file inspectable.h.

94  {
96  TYPE_ID thisType = TYPE_HASH( *this );
97  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
98  return object ? aProperty->get<T>( object ) : T();
99  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
Provides class metadata.
Definition: property_mgr.h:58
T get(void *aObject)
Definition: property.h:273
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Get() [3/3]

template<typename T >
boost::optional<T> INSPECTABLE::Get ( const wxString &  aProperty)
inlineinherited

Definition at line 102 of file inspectable.h.

103  {
105  TYPE_ID thisType = TYPE_HASH( *this );
106  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
107  boost::optional<T> ret;
108 
109  if( prop )
110  {
111  void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
112 
113  if( object )
114  ret = prop->get<T>( object );
115  }
116 
117  return ret;
118  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Returns a property for a specific type.
Provides class metadata.
Definition: property_mgr.h:58
T get(void *aObject)
Definition: property.h:273
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ GetBodyBoundingBox()

EDA_RECT SCH_COMPONENT::GetBodyBoundingBox ( ) const

Return a bounding box for the symbol body but not the fields.

Definition at line 1260 of file sch_component.cpp.

1261 {
1262  EDA_RECT bBox;
1263 
1264  if( m_part )
1265  bBox = m_part->GetBodyBoundingBox( m_unit, m_convert );
1266  else
1267  bBox = dummy()->GetBodyBoundingBox( m_unit, m_convert );
1268 
1269  int x0 = bBox.GetX();
1270  int xm = bBox.GetRight();
1271 
1272  // We must reverse Y values, because matrix orientation
1273  // suppose Y axis normal for the library items coordinates,
1274  // m_transform reverse Y values, but bBox is already reversed!
1275  int y0 = -bBox.GetY();
1276  int ym = -bBox.GetBottom();
1277 
1278  // Compute the real Boundary box (rotated, mirrored ...)
1279  int x1 = m_transform.x1 * x0 + m_transform.y1 * y0;
1280  int y1 = m_transform.x2 * x0 + m_transform.y2 * y0;
1281  int x2 = m_transform.x1 * xm + m_transform.y1 * ym;
1282  int y2 = m_transform.x2 * xm + m_transform.y2 * ym;
1283 
1284  bBox.SetX( x1 );
1285  bBox.SetY( y1 );
1286  bBox.SetWidth( x2 - x1 );
1287  bBox.SetHeight( y2 - y1 );
1288  bBox.Normalize();
1289 
1290  bBox.Offset( m_Pos );
1291  return bBox;
1292 }
void Offset(int dx, int dy)
Definition: eda_rect.h:157
int y2
Definition: transform.h:51
int GetX() const
Definition: eda_rect.h:111
int x2
Definition: transform.h:50
int x1
Definition: transform.h:48
int GetBottom() const
Definition: eda_rect.h:124
int y1
Definition: transform.h:49
void SetHeight(int val)
Definition: eda_rect.h:186
int GetRight() const
Definition: eda_rect.h:121
void SetX(int val)
Definition: eda_rect.h:168
std::unique_ptr< LIB_PART > m_part
void SetWidth(int val)
Definition: eda_rect.h:180
void SetY(int val)
Definition: eda_rect.h:174
void Normalize()
Function Normalize ensures that the height ant width are positive.
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int GetY() const
Definition: eda_rect.h:112
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:86
const EDA_RECT GetBodyBoundingBox(int aUnit, int aConvert) const
Get the symbol bounding box excluding fields.
TRANSFORM m_transform
The rotation/mirror transformation matrix.

References dummy(), LIB_PART::GetBodyBoundingBox(), EDA_RECT::GetBottom(), EDA_RECT::GetRight(), EDA_RECT::GetX(), EDA_RECT::GetY(), m_convert, m_part, m_Pos, m_transform, m_unit, EDA_RECT::Normalize(), EDA_RECT::Offset(), EDA_RECT::SetHeight(), EDA_RECT::SetWidth(), EDA_RECT::SetX(), EDA_RECT::SetY(), TRANSFORM::x1, TRANSFORM::x2, TRANSFORM::y1, and TRANSFORM::y2.

Referenced by AUTOPLACER::AUTOPLACER(), GetBoundingBox(), HitTest(), and operator<().

◆ GetBoundingBox() [1/2]

const EDA_RECT SCH_COMPONENT::GetBoundingBox ( ) const
overridevirtual

Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

This box should be an enclosing perimeter for visible components of this object, and the units should be in the pcb or schematic coordinate system. It is OK to overestimate the size by a few counts.

Reimplemented from EDA_ITEM.

Definition at line 1295 of file sch_component.cpp.

1296 {
1297  EDA_RECT bbox = GetBodyBoundingBox();
1298 
1299  for( const SCH_FIELD& field : m_Fields )
1300  bbox.Merge( field.GetBoundingBox() );
1301 
1302  return bbox;
1303 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect.
SCH_FIELDS m_Fields
Variable length list of fields.
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References GetBodyBoundingBox(), m_Fields, and EDA_RECT::Merge().

Referenced by SCH_EDITOR_CONTROL::FindComponentAndItem(), and AUTOPLACER::get_possible_colliders().

◆ GetBoundingBox() [2/2]

const EDA_RECT SCH_COMPONENT::GetBoundingBox ( bool  aIncludeInvisibleText) const

Definition at line 1306 of file sch_component.cpp.

1307 {
1308  EDA_RECT bbox = GetBodyBoundingBox();
1309 
1310  for( const SCH_FIELD& field : m_Fields )
1311  {
1312  if( field.IsVisible() || aIncludeInvisibleText )
1313  bbox.Merge( field.GetBoundingBox() );
1314  }
1315 
1316  return bbox;
1317 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect.
SCH_FIELDS m_Fields
Variable length list of fields.
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References GetBodyBoundingBox(), m_Fields, and EDA_RECT::Merge().

◆ GetClass()

wxString SCH_COMPONENT::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from SCH_ITEM.

Definition at line 161 of file sch_component.h.

162  {
163  return wxT( "SCH_COMPONENT" );
164  }

Referenced by operator=().

◆ GetConnectionPoints()

std::vector< wxPoint > SCH_COMPONENT::GetConnectionPoints ( ) const
overridevirtual

Add all the connection points for this item to aPoints.

Not all schematic items have connection points so the default method does nothing.

Parameters
aPointsList of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 1548 of file sch_component.cpp.

1549 {
1550  std::vector<wxPoint> retval;
1551 
1552  for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
1553  {
1554  // Collect only pins attached to the current unit and convert.
1555  // others are not associated to this component instance
1556  int pin_unit = pin->GetLibPin()->GetUnit();
1557  int pin_convert = pin->GetLibPin()->GetConvert();
1558 
1559  if( pin_unit > 0 && pin_unit != GetUnit() )
1560  continue;
1561 
1562  if( pin_convert > 0 && pin_convert != GetConvert() )
1563  continue;
1564 
1565  retval.push_back( m_transform.TransformCoordinate( pin->GetLocalPosition() ) + m_Pos );
1566  }
1567 
1568  return retval;
1569 }
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
int GetUnit() const
int GetConvert() const
std::vector< std::unique_ptr< SCH_PIN > > m_pins
TRANSFORM m_transform
The rotation/mirror transformation matrix.

References GetConvert(), GetUnit(), m_pins, m_Pos, m_transform, and TRANSFORM::TransformCoordinate().

◆ GetContextualTextVars()

void SCH_COMPONENT::GetContextualTextVars ( wxArrayString *  aVars) const

Return the list of system text vars & fields for this symbol.

Definition at line 883 of file sch_component.cpp.

884 {
885  for( int i = 0; i < MANDATORY_FIELDS; ++i )
886  aVars->push_back( m_Fields[i].GetCanonicalName().Upper() );
887 
888  for( size_t i = MANDATORY_FIELDS; i < m_Fields.size(); ++i )
889  aVars->push_back( m_Fields[i].GetName() );
890 
891  aVars->push_back( wxT( "FOOTPRINT_LIBRARY" ) );
892  aVars->push_back( wxT( "FOOTPRINT_NAME" ) );
893  aVars->push_back( wxT( "UNIT" ) );
894 }
SCH_FIELDS m_Fields
Variable length list of fields.
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.

References m_Fields, and MANDATORY_FIELDS.

Referenced by DIALOG_LABEL_EDITOR::onScintillaCharAdded(), and DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded().

◆ GetConvert()

◆ GetDatasheet()

wxString SCH_COMPONENT::GetDatasheet ( ) const

Return the documentation text for the given part alias.

Definition at line 258 of file sch_component.cpp.

259 {
260  if( m_part )
261  return m_part->GetDatasheetField().GetText();
262 
263  return wxEmptyString;
264 }
std::unique_ptr< LIB_PART > m_part

References m_part.

Referenced by UpdateFields().

◆ GetDescription()

wxString SCH_COMPONENT::GetDescription ( ) const

Return information about the aliased parts.

Definition at line 249 of file sch_component.cpp.

250 {
251  if( m_part )
252  return m_part->GetDescription();
253 
254  return wxEmptyString;
255 }
std::unique_ptr< LIB_PART > m_part

References m_part.

Referenced by NETLIST_EXPORTER_GENERIC::makeComponents().

◆ GetDrawItem()

LIB_ITEM * SCH_COMPONENT::GetDrawItem ( const wxPoint aPosition,
KICAD_T  aType = TYPE_NOT_INIT 
)

Return the component library item at aPosition that is part of this component.

Parameters
aPositionis the schematic position of the component library object.
aTypeis the type of symbol library object to find or any if set to TYPE_NOT_INIT.
Returns
is the symbol library object if found otherwise NULL.

Definition at line 1572 of file sch_component.cpp.

1573 {
1574  if( m_part )
1575  {
1576  // Calculate the position relative to the component.
1577  wxPoint libPosition = aPosition - m_Pos;
1578 
1579  return m_part->LocateDrawItem( m_unit, m_convert, aType, libPosition, m_transform );
1580  }
1581 
1582  return NULL;
1583 }
#define NULL
std::unique_ptr< LIB_PART > m_part
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:86
TRANSFORM m_transform
The rotation/mirror transformation matrix.

References m_convert, m_part, m_Pos, m_transform, m_unit, and NULL.

Referenced by SCH_SCREEN::GetPin().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 237 of file base_struct.h.

238  {
239  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
241 
242  return m_Flags & mask;
243  }
#define IS_NEW
New item, just created.
Definition: base_struct.h:117
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:119
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:121
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:118
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
Definition: base_struct.h:130
#define IS_MOVED
Item being moved.
Definition: base_struct.h:116

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_PASTED, IS_RESIZED, IS_WIRE_IMAGE, EDA_ITEM::m_Flags, and STRUCT_DELETED.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), LIB_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithLibEdit(), GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ GetEndPoints()

void SCH_COMPONENT::GetEndPoints ( std::vector< DANGLING_END_ITEM > &  aItemList)
overridevirtual

Add the schematic item end points to aItemList if the item has end points.

The default version doesn't do anything since many of the schematic object cannot be tested for dangling ends. If you add a new schematic item that can have a dangling end ( no connect ), override this method to provide the correct end points.

Parameters
aItemList- List of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 1473 of file sch_component.cpp.

1474 {
1475  for( auto& pin : m_pins )
1476  {
1477  LIB_PIN* lib_pin = pin->GetLibPin();
1478 
1479  if( lib_pin->GetUnit() && m_unit && ( m_unit != lib_pin->GetUnit() ) )
1480  continue;
1481 
1482  DANGLING_END_ITEM item( PIN_END, lib_pin, GetPinPhysicalPosition( lib_pin ), this );
1483  aItemList.push_back( item );
1484  }
1485 }
int GetUnit() const
Definition: lib_item.h:295
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85
Helper class used to store the state of schematic items that can be connected to other schematic item...
Definition: sch_item.h:85
std::vector< std::unique_ptr< SCH_PIN > > m_pins
wxPoint GetPinPhysicalPosition(const LIB_PIN *Pin) const

References GetPinPhysicalPosition(), LIB_ITEM::GetUnit(), m_pins, m_unit, and PIN_END.

◆ GetField() [1/2]

◆ GetField() [2/2]

const SCH_FIELD * SCH_COMPONENT::GetField ( int  aFieldNdx) const

Definition at line 673 of file sch_component.cpp.

674 {
675  if( (unsigned) aFieldNdx < m_Fields.size() )
676  return &m_Fields[aFieldNdx];
677 
678  return nullptr;
679 }
SCH_FIELDS m_Fields
Variable length list of fields.

References m_Fields.

◆ GetFieldCount()

int SCH_COMPONENT::GetFieldCount ( ) const
inline

◆ GetFields() [1/2]

void SCH_COMPONENT::GetFields ( std::vector< SCH_FIELD * > &  aVector,
bool  aVisibleOnly 
)

Populates a std::vector with SCH_FIELDs.

Parameters
aVectoris the vector to populate.
aVisibleOnlyis used to add only the fields that are visible and contain text.

Definition at line 694 of file sch_component.cpp.

695 {
696  for( SCH_FIELD& field : m_Fields )
697  {
698  if( !aVisibleOnly || ( field.IsVisible() && !field.IsVoid() ) )
699  aVector.push_back( &field );
700  }
701 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
SCH_FIELDS m_Fields
Variable length list of fields.

References m_Fields.

Referenced by AUTOPLACER::AUTOPLACER(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), SCH_SHEET_LIST::FillItemMap(), SCH_SHEET_LIST::GetItem(), NETLIST_EXPORTER_GENERIC::makeComponents(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), ERC_TESTER::TestTextVars(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_UPDATE_FIELDS::updateFields(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ GetFields() [2/2]

std::vector<SCH_FIELD>& SCH_COMPONENT::GetFields ( )
inline

Returns a vector of fields from the component.

Definition at line 397 of file sch_component.h.

397 { return m_Fields; }
SCH_FIELDS m_Fields
Variable length list of fields.

References m_Fields.

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const
inlineinherited

Return whether the fields have been automatically placed.

Definition at line 442 of file sch_item.h.

442 { return m_fieldsAutoplaced; }
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201

References SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_ITEM::AutoAutoplaceFields(), and EE_POINT_EDITOR::updateItem().

◆ GetFieldText()

wxString SCH_COMPONENT::GetFieldText ( const wxString &  aFieldName,
SCH_EDIT_FRAME aFrame 
) const

Search for a field named aFieldName and returns text associated with this field.

Parameters
aFieldNameis the name of the field

Definition at line 682 of file sch_component.cpp.

683 {
684  for( const SCH_FIELD& field : m_Fields )
685  {
686  if( aFieldName == field.GetName() )
687  return field.GetText();
688  }
689 
690  return wxEmptyString;
691 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
SCH_FIELDS m_Fields
Variable length list of fields.

References m_Fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn().

◆ GetFlags()

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in DRAWSEGMENT, and TRACK.

Definition at line 345 of file base_struct.h.

345 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: base_struct.h:337

References EDA_ITEM::GetPosition().

Referenced by PCB_BASE_FRAME::FocusOnItem(), and SCH_EDIT_FRAME::FocusOnItem().

◆ GetFootprint()

const wxString SCH_COMPONENT::GetFootprint ( const SCH_SHEET_PATH sheet) const

Definition at line 617 of file sch_component.cpp.

618 {
619  KIID_PATH path = sheet->Path();
620 
621  for( const COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
622  {
623  if( instance.m_Path == path && !instance.m_Footprint.IsEmpty() )
624  {
625  SCH_FIELD dummy( wxDefaultPosition, FOOTPRINT, const_cast<SCH_COMPONENT*>( this ) );
626  dummy.SetText( instance.m_Footprint );
627  return dummy.GetShownText();
628  }
629  }
630 
631  return GetField( FOOTPRINT )->GetShownText();
632 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
Field Name Module PCB, i.e. "16DIP300".
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_field.cpp:102
A simple container for schematic symbol instance infromation.
SCH_FIELD * GetField(int aFieldNdx)
Returns a field in this symbol.
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.

References dummy(), FOOTPRINT, GetField(), SCH_FIELD::GetShownText(), m_instanceReferences, and SCH_SHEET_PATH::Path().

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), GetMsgPanelInfo(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ GetIncludeInBom()

bool SCH_COMPONENT::GetIncludeInBom ( ) const
inline

Definition at line 676 of file sch_component.h.

676 { return m_inBom; }
bool m_inBom
True to include in bill of materials export.

References m_inBom.

Referenced by NETLIST_EXPORTER_GENERIC::makeComponents(), SCH_SEXPR_PLUGIN::saveSymbol(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow().

◆ GetIncludeOnBoard()

bool SCH_COMPONENT::GetIncludeOnBoard ( ) const
inline

Definition at line 679 of file sch_component.h.

679 { return m_onBoard; }
bool m_onBoard
True to include in netlist when updating board.

References m_onBoard.

Referenced by NETLIST_EXPORTER_GENERIC::makeComponents(), SCH_SEXPR_PLUGIN::saveSymbol(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow().

◆ GetInstanceReferences()

const std::vector<COMPONENT_INSTANCE_REFERENCE>& SCH_COMPONENT::GetInstanceReferences ( )
inline

Definition at line 166 of file sch_component.h.

167  {
168  return m_instanceReferences;
169  }
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences

References m_instanceReferences.

Referenced by DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_LEGACY_PLUGIN::saveComponent(), and SCH_SEXPR_PLUGIN::saveSymbol().

◆ GetLayer()

◆ GetLibId()

◆ GetLibPins()

void SCH_COMPONENT::GetLibPins ( std::vector< LIB_PIN * > &  aPinsList)

Populate a vector with all the pins from the library object.

Parameters
aPinsListis the list to populate with all of the pins.

Definition at line 808 of file sch_component.cpp.

809 {
810  if( m_part )
811  m_part->GetPins( aPinsList, m_unit, m_convert );
812 }
std::unique_ptr< LIB_PART > m_part
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:86

References m_convert, m_part, and m_unit.

◆ GetMenuImage()

BITMAP_DEF SCH_COMPONENT::GetMenuImage ( ) const
overridevirtual

Function GetMenuImage returns a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns
The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 1403 of file sch_component.cpp.

1404 {
1405  return add_component_xpm;
1406 }
const BITMAP_OPAQUE add_component_xpm[1]

References add_component_xpm.

◆ GetMsgPanelInfo()

void SCH_COMPONENT::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters
aListis the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 1320 of file sch_component.cpp.

1321 {
1322  wxString msg;
1323 
1324  SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( aFrame );
1325  SCH_SHEET_PATH* currentSheet = schframe ? &schframe->GetCurrentSheet() : nullptr;
1326 
1327  // part and alias can differ if alias is not the root
1328  if( m_part )
1329  {
1330  if( m_part.get() != dummy() )
1331  {
1332  aList.push_back( MSG_PANEL_ITEM( _( "Reference" ), GetRef( currentSheet ), DARKCYAN ) );
1333 
1334  msg = m_part->IsPower() ? _( "Power symbol" ) : _( "Value" );
1335 
1336  aList.push_back( MSG_PANEL_ITEM( msg, GetValue( currentSheet ), DARKCYAN ) );
1337 
1338 #if 0 // Display component flags, for debug only
1339  aList.push_back( MSG_PANEL_ITEM( _( "flags" ),
1340  wxString::Format("%X", GetEditFlags()), BROWN ) );
1341 #endif
1342 
1343  // Display component reference in library and library
1344  aList.push_back( MSG_PANEL_ITEM( _( "Name" ), GetLibId().GetLibItemName(), BROWN ) );
1345 
1346  if( !m_part->IsRoot() )
1347  {
1348  msg = _( "Missing parent" );
1349 
1350  std::shared_ptr< LIB_PART > parent = m_part->GetParent().lock();
1351 
1352  if( parent )
1353  msg = parent->GetName();
1354 
1355  aList.push_back( MSG_PANEL_ITEM( _( "Alias of" ), msg, BROWN ) );
1356  }
1357  else if( !m_lib_id.GetLibNickname().empty() )
1358  {
1359  aList.push_back( MSG_PANEL_ITEM( _( "Library" ), m_lib_id.GetLibNickname(),
1360  BROWN ) );
1361  }
1362  else
1363  {
1364  aList.push_back( MSG_PANEL_ITEM( _( "Library" ), _( "Undefined!!!" ), RED ) );
1365  }
1366 
1367  // Display the current associated footprint, if exists.
1368  msg = GetFootprint( currentSheet );
1369 
1370  if( msg.IsEmpty() )
1371  msg = _( "<Unknown>" );
1372 
1373  aList.push_back( MSG_PANEL_ITEM( _( "Footprint" ), msg, DARKRED ) );
1374 
1375  // Display description of the component, and keywords found in lib
1376  aList.push_back( MSG_PANEL_ITEM( _( "Description" ), m_part->GetDescription(),
1377  DARKCYAN ) );
1378  aList.push_back( MSG_PANEL_ITEM( _( "Key words" ), m_part->GetKeyWords(), DARKCYAN ) );
1379  }
1380  }
1381  else
1382  {
1383  aList.push_back( MSG_PANEL_ITEM( _( "Reference" ), GetRef( currentSheet ), DARKCYAN ) );
1384 
1385  aList.push_back( MSG_PANEL_ITEM( _( "Value" ), GetValue( currentSheet ), DARKCYAN ) );
1386  aList.push_back( MSG_PANEL_ITEM( _( "Name" ), GetLibId().GetLibItemName(), BROWN ) );
1387 
1388  wxString libNickname = GetLibId().GetLibNickname();
1389 
1390  if( libNickname.empty() )
1391  {
1392  aList.push_back( MSG_PANEL_ITEM( _( "Library" ), _( "No library defined!" ), RED ) );
1393  }
1394  else
1395  {
1396  msg.Printf( _( "Symbol not found in %s!" ), libNickname );
1397  aList.push_back( MSG_PANEL_ITEM( _( "Library" ), msg , RED ) );
1398  }
1399  }
1400 }
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
Definition: color4d.h:61
const wxString GetValue(const SCH_SHEET_PATH *sheet) const
Schematic editor (Eeschema) main window.
const wxString GetFootprint(const SCH_SHEET_PATH *sheet) const
STATUS_FLAGS GetEditFlags() const
Definition: base_struct.h:237
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
SCH_SHEET_PATH.
std::unique_ptr< LIB_PART > m_part
Definition: color4d.h:59
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_component.h:84
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
#define _(s)
Definition: 3d_actions.cpp:33
SCH_SHEET_PATH & GetCurrentSheet() const
EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
const LIB_ID & GetLibId() const
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
bool empty() const
Definition: utf8.h:108

References _, BROWN, DARKCYAN, DARKRED, dummy(), UTF8::empty(), Format(), SCH_EDIT_FRAME::GetCurrentSheet(), EDA_ITEM::GetEditFlags(), GetFootprint(), GetLibId(), LIB_ID::GetLibNickname(), GetRef(), GetValue(), m_lib_id, m_part, SCH_SHEET_PATH::push_back(), and RED.

◆ GetOrientation()

int SCH_COMPONENT::GetOrientation ( )

Get the display symbol orientation.

Because there are different ways to have a given orientation/mirror, the orientation/mirror is not necessary what the user does. For example: a mirrorX then a mirrorY returns no mirror but a rotate. This function finds a rotation and a mirror value CMP_MIRROR_X because this is the first mirror option tested. This can differs from the orientation made by an user. A CMP_MIRROR_Y is returned as a CMP_MIRROR_X with an orientation 180 because they are equivalent.

See also
COMPONENT_ORIENTATION_T
Returns
the orientation and mirror of the symbol.

Definition at line 1191 of file sch_component.cpp.

1192 {
1193  int rotate_values[] =
1194  {
1195  CMP_ORIENT_0,
1196  CMP_ORIENT_90,
1202  CMP_MIRROR_Y,
1207  };
1208 
1209  // Try to find the current transform option:
1210  TRANSFORM transform = m_transform;
1211 
1212  for( int type_rotate : rotate_values )
1213  {
1214  SetOrientation( type_rotate );
1215 
1216  if( transform == m_transform )
1217  return type_rotate;
1218  }
1219 
1220  // Error: orientation not found in list (should not happen)
1221  wxFAIL_MSG( "Schematic symbol orientation matrix internal error." );
1222  m_transform = transform;
1223 
1224  return CMP_NORMAL;
1225 }
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM m_transform
The rotation/mirror transformation matrix.
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...

References CMP_MIRROR_X, CMP_MIRROR_Y, CMP_NORMAL, CMP_ORIENT_0, CMP_ORIENT_180, CMP_ORIENT_270, CMP_ORIENT_90, m_transform, and SetOrientation().

Referenced by KIGFX::SCH_PAINTER::draw(), AUTOPLACER::get_preferred_sides(), orientLabel(), SCH_SEXPR_PLUGIN::saveSymbol(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow().

◆ GetParent()

◆ GetPartRef()

◆ GetPenWidth()

virtual int SCH_ITEM::GetPenWidth ( ) const
inlinevirtualinherited

◆ GetPin() [1/2]

SCH_PIN * SCH_COMPONENT::GetPin ( const wxString &  number)

Find a symbol pin by number.

Parameters
numberis the number of the pin to find.
Returns
Pin object if found, otherwise NULL.

Definition at line 796 of file sch_component.cpp.

797 {
798  for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
799  {
800  if( pin->GetNumber() == aNumber )
801  return pin.get();
802  }
803 
804  return nullptr;
805 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins

References m_pins.

Referenced by BACK_ANNOTATE::applyChangelist(), KIGFX::SCH_PAINTER::draw(), SCH_EDITOR_CONTROL::FindComponentAndItem(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow().

◆ GetPin() [2/2]

SCH_PIN * SCH_COMPONENT::GetPin ( LIB_PIN aLibPin)

Definition at line 815 of file sch_component.cpp.

816 {
817  wxASSERT( m_pinMap.count( aLibPin ) );
818  return m_pins[ m_pinMap.at( aLibPin ) ].get();
819 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
std::unordered_map< LIB_PIN *, unsigned > m_pinMap

References m_pinMap, and m_pins.

◆ GetPinPhysicalPosition()

wxPoint SCH_COMPONENT::GetPinPhysicalPosition ( const LIB_PIN Pin) const

Definition at line 1539 of file sch_component.cpp.

1540 {
1541  wxCHECK_MSG( Pin != NULL && Pin->Type() == LIB_PIN_T, wxPoint( 0, 0 ),
1542  wxT( "Cannot get physical position of pin." ) );
1543 
1544  return m_transform.TransformCoordinate( Pin->GetPosition() ) + m_Pos;
1545 }
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
#define NULL
wxPoint GetPosition() const override
Definition: lib_pin.h:254
TRANSFORM m_transform
The rotation/mirror transformation matrix.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References LIB_PIN::GetPosition(), LIB_PIN_T, m_Pos, m_transform, NULL, TRANSFORM::TransformCoordinate(), and EDA_ITEM::Type().

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_EAGLE_PLUGIN::checkConnections(), GetEndPoints(), and SCH_SCREEN::GetPin().

◆ GetPins()

std::vector< SCH_PIN * > SCH_COMPONENT::GetPins ( const SCH_SHEET_PATH aSheet = nullptr) const

Retrieves a list of the SCH_PINs for the given sheet path.

Since a component can have a different unit on a different instance of a sheet, this list returns the subset of pins that exist on a given sheet.

Returns
a vector of pointers (non-owning) to SCH_PINs

Definition at line 822 of file sch_component.cpp.

823 {
824  std::vector<SCH_PIN*> pins;
825 
826  if( aSheet == nullptr )
827  {
828  wxCHECK_MSG( Schematic(), pins, "Can't call GetPins on a component with no schematic" );
829 
830  aSheet = &Schematic()->CurrentSheet();
831  }
832 
833  int unit = GetUnitSelection( aSheet );
834 
835  for( const auto& p : m_pins )
836  {
837  if( unit && p->GetLibPin()->GetUnit() && ( p->GetLibPin()->GetUnit() != unit ) )
838  continue;
839 
840  pins.push_back( p.get() );
841  }
842 
843  return pins;
844 }
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:116
std::vector< std::unique_ptr< SCH_PIN > > m_pins
int GetUnitSelection(const SCH_SHEET_PATH *aSheet) const
SCH_SHEET_PATH & CurrentSheet() const
Definition: schematic.h:119

References SCHEMATIC::CurrentSheet(), GetUnitSelection(), m_pins, and SCH_ITEM::Schematic().

Referenced by NETLIST_EXPORTER::CreatePinList(), SCH_ITEM::Duplicate(), SCH_SHEET_LIST::FillItemMap(), NETLIST_EXPORTER::findAllUnitsOfComponent(), SCH_SHEET_LIST::GetItem(), highlightNet(), AUTOPLACER::pins_on_side(), SCH_SEXPR_PLUGIN::saveSymbol(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), ERC_TESTER::TestNoConnectPins(), CONNECTION_GRAPH::updateItemConnectivity(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ GetPosition()

◆ GetPrefix()

wxString SCH_COMPONENT::GetPrefix ( ) const
inline

Definition at line 269 of file sch_component.h.

269 { return m_prefix; }
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is.
Definition: sch_component.h:89

References m_prefix.

Referenced by SCH_LEGACY_PLUGIN::saveComponent().

◆ GetRawPins()

std::vector<std::unique_ptr<SCH_PIN> >& SCH_COMPONENT::GetRawPins ( )
inline

Definition at line 488 of file sch_component.h.

488 { return m_pins; }
std::vector< std::unique_ptr< SCH_PIN > > m_pins

References m_pins.

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC().

◆ GetRef()

const wxString SCH_COMPONENT::GetRef ( const SCH_SHEET_PATH aSheet,
bool  aIncludeUnit = false 
) const

Return the reference for the given sheet path.

Returns
the reference for the sheet.

Definition at line 416 of file sch_component.cpp.

417 {
418  KIID_PATH path = sheet->Path();
419  wxString ref;
420 
421  for( const COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
422  {
423  if( instance.m_Path == path )
424  {
425  ref = instance.m_Reference;
426  break;
427  }
428  }
429 
430  // If it was not found in m_Paths array, then see if it is in m_Field[REFERENCE] -- if so,
431  // use this as a default for this path. This will happen if we load a version 1 schematic
432  // file. It will also mean that multiple instances of the same sheet by default all have
433  // the same component references, but perhaps this is best.
434  if( ref.IsEmpty() && !GetField( REFERENCE )->GetText().IsEmpty() )
435  {
436  const_cast<SCH_COMPONENT*>( this )->SetRef( sheet, GetField( REFERENCE )->GetText() );
437  ref = GetField( REFERENCE )->GetText();
438  }
439 
440  if( ref.IsEmpty() )
441  ref = m_prefix;
442 
443  if( aIncludeUnit && GetUnitCount() > 1 )
444  ref += LIB_PART::SubReference( GetUnit() );
445 
446  return ref;
447 }
int GetUnitCount() const
Return the number of units per package of the symbol.
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
Field Reference of part, i.e. "IC21".
int GetUnit() const
A simple container for schematic symbol instance infromation.
SCH_FIELD * GetField(int aFieldNdx)
Returns a field in this symbol.
static wxString SubReference(int aUnit, bool aAddSeparator=true)
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is.
Definition: sch_component.h:89
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:127

References GetField(), EDA_TEXT::GetText(), GetUnit(), GetUnitCount(), m_instanceReferences, m_prefix, SCH_SHEET_PATH::Path(), REFERENCE, and LIB_PART::SubReference().

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), SCH_EDIT_FRAME::AnnotateComponents(), CollectOtherUnits(), SCHEMATIC::ConvertKIIDsToRefs(), SCHEMATIC::ConvertRefsToKIIDs(), NETLIST_EXPORTER::CreatePinList(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), SCH_EDITOR_CONTROL::EditWithLibEdit(), NETLIST_EXPORTER::findAllUnitsOfComponent(), SCH_EDITOR_CONTROL::FindComponentAndItem(), NETLIST_EXPORTER::findNextComponent(), SCH_SHEET_PATH::GetComponents(), SCH_PIN::GetDefaultNetName(), SCH_PIN::GetMsgPanelInfo(), GetMsgPanelInfo(), DIALOG_CHANGE_SYMBOLS::isMatch(), NETLIST_EXPORTER_GENERIC::makeComponents(), NETLIST_EXPORTER_GENERIC::makeListOfNets(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_FIELD::Matches(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), SCH_EDIT_TOOL::Properties(), SCH_FIELD::Replace(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), ERC_TESTER::TestMultiunitFootprints(), ERC_TESTER::TestMultUnitPinConflicts(), NETLIST_EXPORTER_CADSTAR::writeListOfNets(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

◆ GetSchSymbolLibraryName()

wxString SCH_COMPONENT::GetSchSymbolLibraryName ( ) const

Definition at line 231 of file sch_component.cpp.

232 {
233  if( !m_schLibSymbolName.IsEmpty() )
234  return m_schLibSymbolName;
235  else
236  return m_lib_id.Format().wx_str();
237 }
wxString m_schLibSymbolName
The name used to look up a symbol in the symbol library embedded in a schematic.
UTF8 Format() const
Definition: lib_id.cpp:237
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_component.h:84
wxString wx_str() const
Definition: utf8.cpp:51

References LIB_ID::Format(), m_lib_id, m_schLibSymbolName, and UTF8::wx_str().

Referenced by SCH_SCREEN::Append(), SCH_SEXPR_PLUGIN::Format(), SCH_EDITOR_CONTROL::Paste(), SCH_SCREEN::Remove(), and SCH_SEXPR_PLUGIN::saveSymbol().

◆ GetSelectMenuText()

wxString SCH_COMPONENT::GetSelectMenuText ( EDA_UNITS  aUnits) const
overridevirtual

Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

The default version of this function raises an assertion in the debug mode and returns a string to indicate that it was not overridden to provide the object specific text.

Returns
The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 1586 of file sch_component.cpp.

1587 {
1588  return wxString::Format( _( "Symbol %s [%s]" ),
1589  GetField( REFERENCE )->GetShownText(),
1590  GetLibId().GetLibItemName().wx_str() );
1591 }
Field Reference of part, i.e. "IC21".
SCH_FIELD * GetField(int aFieldNdx)
Returns a field in this symbol.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
const LIB_ID & GetLibId() const

References _, Format(), GetField(), GetLibId(), and REFERENCE.

Referenced by Matches().

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 216 of file base_struct.h.

217  {
218  return m_Status & type;
219  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by TRACK::GetMsgPanelInfoBase_Common(), and TRACK::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 229 of file base_struct.h.

229 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 250 of file sch_item.h.

250 { return m_storedPos; }
wxPoint m_storedPos
Definition: sch_item.h:202

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::moveItem().

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const
inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 474 of file sch_item.h.

474 { wxCHECK( false, STROKE_PARAMS() ); }
Simple container to manage line stroke parameters.
Definition: sch_item.h:153

◆ GetTransform()

◆ GetUnit()

◆ GetUnitCount()

int SCH_COMPONENT::GetUnitCount ( void  ) const

Return the number of units per package of the symbol.

Returns
the number of units per package or zero if the library entry cannot be found.

Definition at line 345 of file sch_component.cpp.

346 {
347  if( m_part )
348  return m_part->GetUnitCount();
349 
350  return 0;
351 }
std::unique_ptr< LIB_PART > m_part

References m_part.

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), SCH_EDIT_FRAME::AnnotateComponents(), CollectOtherUnits(), GetRef(), SCH_FIELD::GetShownText(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_FIELD::Matches(), SCH_DRAWING_TOOLS::PlaceComponent(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow().

◆ GetUnitSelection()

int SCH_COMPONENT::GetUnitSelection ( const SCH_SHEET_PATH aSheet) const

Definition at line 535 of file sch_component.cpp.

536 {
537  KIID_PATH path = aSheet->Path();
538 
539  for( const COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
540  {
541  if( instance.m_Path == path )
542  return instance.m_Unit;
543  }
544 
545  // If it was not found in m_Paths array, then use m_unit. This will happen if we load a
546  // version 1 schematic file.
547  return m_unit;
548 }
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
A simple container for schematic symbol instance infromation.
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85

References m_instanceReferences, m_unit, and SCH_SHEET_PATH::Path().

Referenced by SCH_EDIT_FRAME::AnnotateComponents(), KIGFX::SCH_PAINTER::draw(), GetPins(), SCH_EDIT_FRAME::mapExistingAnnotation(), ResolveTextVar(), and SCH_REFERENCE::SCH_REFERENCE().

◆ GetValue()

const wxString SCH_COMPONENT::GetValue ( const SCH_SHEET_PATH sheet) const

Definition at line 570 of file sch_component.cpp.

571 {
572  KIID_PATH path = sheet->Path();
573 
574  for( const COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
575  {
576  if( instance.m_Path == path && !instance.m_Value.IsEmpty() )
577  {
578  SCH_FIELD dummy( wxDefaultPosition, VALUE, const_cast<SCH_COMPONENT*>( this ) );
579  dummy.SetText( instance.m_Value );
580  return dummy.GetShownText();
581  }
582  }
583 
584  return GetField( VALUE )->GetShownText();
585 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_field.cpp:102
A simple container for schematic symbol instance infromation.
SCH_FIELD * GetField(int aFieldNdx)
Returns a field in this symbol.
Field Value of part, i.e. "3.3K".
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.

References dummy(), GetField(), SCH_FIELD::GetShownText(), m_instanceReferences, SCH_SHEET_PATH::Path(), and VALUE.

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), SCH_EDIT_FRAME::AnnotateComponents(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), SCH_PIN::GetMsgPanelInfo(), GetMsgPanelInfo(), DIALOG_CHANGE_SYMBOLS::isMatch(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

◆ HasBrightenedPins()

bool SCH_COMPONENT::HasBrightenedPins ( )

Definition at line 1824 of file sch_component.cpp.

1825 {
1826  for( const auto& pin : m_pins )
1827  {
1828  if( pin->IsBrightened() )
1829  return true;
1830  }
1831 
1832  return false;
1833 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins

References m_pins.

Referenced by SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ HasFlag()

◆ HasLineStroke()

virtual bool SCH_ITEM::HasLineStroke ( ) const
inlinevirtualinherited

Check if this schematic item has line stoke properties.

See also
STROKE_PARAMS
Returns
true if this schematic item support line stroke properties. Otherwise, false.

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 472 of file sch_item.h.

472 { return false; }

Referenced by EE_SELECTION::AllItemsHaveLineStroke(), SCH_EDIT_TOOL::Init(), and SCH_EDIT_TOOL::Properties().

◆ HitTest() [1/2]

bool SCH_COMPONENT::HitTest ( const wxPoint aPosition,
int  aAccuracy = 0 
) const
overridevirtual

Function HitTest tests if aPosition is contained within or on the bounding box of an item.

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
aAccuracyIncrease the item bounding box by this amount.
Returns
True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 1748 of file sch_component.cpp.

1749 {
1750  EDA_RECT bBox = GetBodyBoundingBox();
1751  bBox.Inflate( aAccuracy );
1752 
1753  if( bBox.Contains( aPosition ) )
1754  return true;
1755 
1756  return false;
1757 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References EDA_RECT::Contains(), GetBodyBoundingBox(), and EDA_RECT::Inflate().

◆ HitTest() [2/2]

bool SCH_COMPONENT::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
overridevirtual

Function HitTest tests if aRect intersects or is contained within the bounding box of an item.

Parameters
aRectA reference to a EDA_RECT object containing the rectangle to test.
aContainedSet to true to test for containment instead of an intersection.
aAccuracyIncrease aRect by this amount.
Returns
True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 1760 of file sch_component.cpp.

1761 {
1763  return false;
1764 
1765  EDA_RECT rect = aRect;
1766 
1767  rect.Inflate( aAccuracy );
1768 
1769  if( aContained )
1770  return rect.Contains( GetBodyBoundingBox() );
1771 
1772  return rect.Intersects( GetBodyBoundingBox() );
1773 }
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:128
bool Contains(const wxPoint &aPoint) const
Function Contains.
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References EDA_RECT::Contains(), GetBodyBoundingBox(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), EDA_ITEM::m_Flags, SKIP_STRUCT, and STRUCT_DELETED.

◆ Init()

void SCH_COMPONENT::Init ( const wxPoint pos = wxPoint( 0, 0 ))
private

Definition at line 177 of file sch_component.cpp.

178 {
179  m_Pos = pos;
180  m_unit = 1; // In multi unit chip - which unit to draw.
181  m_convert = LIB_ITEM::LIB_CONVERT::BASE; // De Morgan Handling
182 
183  // The rotation/mirror transformation matrix. pos normal
185 
186  // construct only the mandatory fields, which are the first 4 only.
187  for( int i = 0; i < MANDATORY_FIELDS; ++i )
188  {
189  m_Fields.emplace_back( pos, i, this, TEMPLATE_FIELDNAME::GetDefaultFieldName( i ) );
190 
191  if( i == REFERENCE )
192  m_Fields.back().SetLayer( LAYER_REFERENCEPART );
193  else if( i == VALUE )
194  m_Fields.back().SetLayer( LAYER_VALUEPART );
195  else
196  m_Fields.back().SetLayer( LAYER_FIELDS );
197  }
198 
199  m_prefix = wxString( wxT( "U" ) );
200  m_isInNetlist = true;
201  m_inBom = true;
202  m_onBoard = true;
203 }
SCH_FIELDS m_Fields
Variable length list of fields.
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
bool m_onBoard
True to include in netlist when updating board.
static const wxString GetDefaultFieldName(int aFieldNdx)
Function GetDefaultFieldName returns a default symbol field name for field aFieldNdx for all componen...
Field Reference of part, i.e. "IC21".
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
bool m_isInNetlist
True if the component should appear in the netlist.
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85
Field Value of part, i.e. "3.3K".
bool m_inBom
True to include in bill of materials export.
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:86
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is.
Definition: sch_component.h:89
TRANSFORM m_transform
The rotation/mirror transformation matrix.

References TEMPLATE_FIELDNAME::GetDefaultFieldName(), LAYER_FIELDS, LAYER_REFERENCEPART, LAYER_VALUEPART, m_convert, m_Fields, m_inBom, m_isInNetlist, m_onBoard, m_Pos, m_prefix, m_transform, m_unit, MANDATORY_FIELDS, REFERENCE, and VALUE.

Referenced by SCH_COMPONENT().

◆ InitializeConnection()

SCH_CONNECTION * SCH_ITEM::InitializeConnection ( const SCH_SHEET_PATH aPath,
CONNECTION_GRAPH aGraph 
)
inherited

Creates a new connection object associated with this object.

Parameters
aPathis the sheet path to initialize

Definition at line 190 of file sch_item.cpp.

192 {
193  if( Connection( aSheet ) )
194  {
195  Connection( aSheet )->Reset();
196  Connection( aSheet )->SetSheet( aSheet );
197  return Connection( aSheet );
198  }
199 
200  auto connection = new SCH_CONNECTION( this );
201  connection->SetSheet( aSheet );
202  m_connection_map.insert( std::make_pair( aSheet, connection ) );
203  connection->SetGraph( aGraph );
204 
205  return connection;
206 }
void SetSheet(SCH_SHEET_PATH aSheet)
void Reset()
Clears connectivity information.
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Stores connectivity information, per sheet.
Definition: sch_item.h:209
SCH_CONNECTION * Connection(const SCH_SHEET_PATH &aPath) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:150
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).

References SCH_ITEM::Connection(), SCH_ITEM::m_connection_map, SCH_CONNECTION::Reset(), and SCH_CONNECTION::SetSheet().

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ IsAnnotated()

bool SCH_COMPONENT::IsAnnotated ( const SCH_SHEET_PATH aSheet)

Checks if the component has a valid annotation (reference) for the given sheet path.

Parameters
aSheetis the sheet path to test
Returns
true if the component exists on that sheet and has a valid reference

Definition at line 521 of file sch_component.cpp.

522 {
523  KIID_PATH path = aSheet->Path();
524 
525  for( const COMPONENT_INSTANCE_REFERENCE& instance : m_instanceReferences )
526  {
527  if( instance.m_Path == path )
528  return instance.m_Reference.Last() != '?';
529  }
530 
531  return false;
532 }
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
A simple container for schematic symbol instance infromation.

References m_instanceReferences, and SCH_SHEET_PATH::Path().

Referenced by CollectOtherUnits(), and SCH_EDIT_FRAME::mapExistingAnnotation().

◆ IsBrightened()

◆ IsConnectable()

bool SCH_COMPONENT::IsConnectable ( ) const
inlineoverridevirtual
Returns
true if the schematic item can connect to another schematic item.

Reimplemented from SCH_ITEM.

Definition at line 614 of file sch_component.h.

614 { return m_onBoard; }
bool m_onBoard
True to include in netlist when updating board.

References m_onBoard.

◆ IsConnected()

bool SCH_ITEM::IsConnected ( const wxPoint aPoint) const
inherited

Test the item to see if it is connected to aPoint.

Parameters
aPointA reference to a wxPoint object containing the coordinates to test.
Returns
True if connection to aPoint exists.

Definition at line 141 of file sch_item.cpp.

142 {
143  if( ( m_Flags & STRUCT_DELETED ) || ( m_Flags & SKIP_STRUCT ) )
144  return false;
145 
146  return doIsConnected( aPosition );
147 }
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:128
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
virtual bool doIsConnected(const wxPoint &aPosition) const
Provide the object specific test to see if it is connected to aPosition.
Definition: sch_item.h:501

References SCH_ITEM::doIsConnected(), EDA_ITEM::m_Flags, SKIP_STRUCT, and STRUCT_DELETED.

Referenced by SCH_SCREEN::IsTerminalPoint().

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( )
inlineinherited

Definition at line 433 of file sch_item.h.

433 { return m_connectivity_dirty; }
bool m_connectivity_dirty
True if connectivity info might be out of date.
Definition: sch_item.h:212

References SCH_ITEM::m_connectivity_dirty.

◆ IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const
inlinevirtualinherited

Reimplemented in SCH_TEXT, SCH_LINE, SCH_BUS_ENTRY_BASE, and SCH_PIN.

Definition at line 370 of file sch_item.h.

370 { return false; }

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 201 of file base_struct.h.

201 { return m_Flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:119
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References IS_DRAGGED, and EDA_ITEM::m_Flags.

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), and KIGFX::SCH_PAINTER::setDeviceColors().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 286 of file base_struct.h.

286 { return m_forceVisible; }
bool m_forceVisible
Definition: base_struct.h:175

References EDA_ITEM::m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_FIELD::Print().

◆ IsInNetlist()

bool SCH_COMPONENT::IsInNetlist ( ) const
Returns
true if the component is in netlist which means this is not a power component, or something like a component reference starting by #

Definition at line 1801 of file sch_component.cpp.

1802 {
1803  return m_isInNetlist;
1804 }
bool m_isInNetlist
True if the component should appear in the netlist.

References m_isInNetlist.

Referenced by AUTOPLACER::AUTOPLACER().

◆ IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const
inlinevirtualinherited
Returns
bool - true if the object is locked, else false

Definition at line 269 of file sch_item.h.

269 { return false; }

Referenced by SCH_EDIT_TOOL::DeleteItemCursor().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 198 of file base_struct.h.

198 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:113
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

bool SCH_COMPONENT::IsMovableFromAnchorPoint ( )
inlineoverridevirtual

Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor.

Usually return true for small items (labels, junctions) and false for items which can be large (hierarchical sheets, components).

Note: we used to try and be smart about this and return false for components in case they are big. However, this annoyed some users and we now have a preference which controls warping on move in general, so this was switched to true for components.

Returns
true for a component

Reimplemented from SCH_ITEM.

Definition at line 186 of file sch_component.h.

186 { return true; }

◆ IsMoving()

◆ IsNew()

◆ IsReferenceStringValid()

bool SCH_COMPONENT::IsReferenceStringValid ( const wxString &  aReferenceString)
static

Tests for an acceptable reference string.

An acceptable reference string must support unannotation i.e starts by letter

Parameters
aReferenceStringis the reference string to validate
Returns
true if reference string is valid.

Definition at line 450 of file sch_component.cpp.

451 {
452  wxString text = aReferenceString;
453  bool ok = true;
454 
455  // Try to unannotate this reference
456  while( !text.IsEmpty() && ( text.Last() == '?' || wxIsdigit( text.Last() ) ) )
457  text.RemoveLast();
458 
459  if( text.IsEmpty() )
460  ok = false;
461 
462  return ok;
463 }

Referenced by ClearAnnotation(), SetRef(), DIALOG_EDIT_ONE_FIELD::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::Validate().

◆ IsReplaceable()

bool SCH_COMPONENT::IsReplaceable ( ) const
inlineoverridevirtual

Function IsReplaceable.

Override this method in any derived object that supports test find and replace.

Returns
True if the item has replaceable text that can be modified using the find and replace dialog.

Reimplemented from EDA_ITEM.

Definition at line 656 of file sch_component.h.

656 { return true; }

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 204 of file base_struct.h.

204 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:118

References IS_RESIZED, and EDA_ITEM::m_Flags.

Referenced by KIGFX::SCH_PAINTER::setDeviceColors().

◆ IsSelected()

◆ IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[]) const
inlinevirtualinherited

Function IsType Checks whether the item is one of the listed types.

Parameters
aScanTypesList of item types
Returns
true if the item type is contained in the list aScanTypes

Reimplemented in VIA, SCH_LABEL, DIMENSION, D_PAD, DRAWSEGMENT, TEXTE_MODULE, SCH_FIELD, SCH_LINE, EDGE_MODULE, and TEXTE_PCB.

Definition at line 262 of file base_struct.h.

263  {
264  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
265  return true;
266 
267  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
268  {
269  if( m_StructType == *p )
270  return true;
271  }
272 
273  return false;
274  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:170
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78

References EOT, EDA_ITEM::m_StructType, and SCH_LOCATE_ANY_T.

Referenced by SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), TEXTE_PCB::IsType(), EDGE_MODULE::IsType(), SCH_LINE::IsType(), SCH_FIELD::IsType(), TEXTE_MODULE::IsType(), DRAWSEGMENT::IsType(), D_PAD::IsType(), DIMENSION::IsType(), SCH_LABEL::IsType(), VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 202 of file base_struct.h.

202 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:121
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References IS_WIRE_IMAGE, and EDA_ITEM::m_Flags.

◆ IterateForward() [1/2]

template<class T >
static SEARCH_RESULT EDA_ITEM::IterateForward ( std::deque< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
inlinestaticinherited

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use the main queue instead

Definition at line 384 of file base_struct.h.

388  {
389  for( auto it : aList )
390  {
391  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
393  return SEARCH_RESULT::QUIT;
394  }
395 
397  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...

References CONTINUE, QUIT, and EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >
static SEARCH_RESULT EDA_ITEM::IterateForward ( std::vector< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
inlinestaticinherited

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use std::vector instead

Definition at line 405 of file base_struct.h.

407  {
408  for( auto it : aList )
409  {
410  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
412  return SEARCH_RESULT::QUIT;
413  }
414 
416  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...

References CONTINUE, QUIT, and EDA_ITEM::Visit().

◆ Matches() [1/2]

bool EDA_ITEM::Matches ( const wxString &  aText,
wxFindReplaceData &  aSearchData 
)
protectedinherited

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters
aTextA reference to a wxString object containing the string to test.
aSearchDataThe criteria to search against.
Returns
True if aText matches the search criteria in aSearchData.

Definition at line 140 of file base_struct.cpp.

141 {
142  wxString text = aText;
143  wxString searchText = aSearchData.GetFindString();
144 
145  // Don't match if searching for replaceable item and the item doesn't support text replace.
146  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
147  return false;
148 
149  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
150  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
151 
152  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
153  {
154  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
155  return text.Matches( searchText );
156 
157  return text.MakeUpper().Matches( searchText.MakeUpper() );
158  }
159 
160  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
161  return aText.Find( searchText ) != wxNOT_FOUND;
162 
163  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
164 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:502

References FR_MATCH_WILDCARD, FR_SEARCH_REPLACE, and EDA_ITEM::IsReplaceable().

◆ Matches() [2/2]

bool SCH_COMPONENT::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData 
)
overridevirtual

Function Matches compares the item against the search criteria in aSearchData.

The base class returns false since many of the objects derived from EDA_ITEM do not have any text to search.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented from EDA_ITEM.

Definition at line 1464 of file sch_component.cpp.

1465 {
1466  wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText( EDA_UNITS::MILLIMETRES ) );
1467 
1468  // Components are searchable via the child field and pin item text.
1469  return false;
1470 }
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
const wxChar *const traceFindItem
Flag to enable find debug tracing.

References GetSelectMenuText(), MILLIMETRES, and traceFindItem.

◆ MirrorX()

void SCH_COMPONENT::MirrorX ( int  aXaxis_position)
overridevirtual

Mirror item relative to the X axis about aXaxis_position.

Parameters
aXaxis_positionThe X axis position to mirror around.

Implements SCH_ITEM.

Definition at line 1427 of file sch_component.cpp.

1428 {
1429  int dy = m_Pos.y;
1430 
1432  MIRROR( m_Pos.y, aXaxis_position );
1433  dy -= m_Pos.y; // dy,0 is the move vector for this transform
1434 
1435  for( SCH_FIELD& field : m_Fields )
1436  {
1437  // Move the fields to the new position because the component itself has moved.
1438  wxPoint pos = field.GetTextPos();
1439  pos.y -= dy;
1440  field.SetTextPos( pos );
1441  }
1442 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
SCH_FIELDS m_Fields
Variable length list of fields.
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:175
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...

References CMP_MIRROR_X, m_Fields, m_Pos, MIRROR(), SetOrientation(), and wxPoint::y.

◆ MirrorY()

void SCH_COMPONENT::MirrorY ( int  aYaxis_position)
overridevirtual

Mirror item relative to the Y axis about aYaxis_position.

Parameters
aYaxis_positionThe Y axis position to mirror around.

Implements SCH_ITEM.

Definition at line 1409 of file sch_component.cpp.

1410 {
1411  int dx = m_Pos.x;
1412 
1414  MIRROR( m_Pos.x, aYaxis_position );
1415  dx -= m_Pos.x; // dx,0 is the move vector for this transform
1416 
1417  for( SCH_FIELD& field : m_Fields )
1418  {
1419  // Move the fields to the new position because the component itself has moved.
1420  wxPoint pos = field.GetTextPos();
1421  pos.x -= dx;
1422  field.SetTextPos( pos );
1423  }
1424 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
SCH_FIELDS m_Fields
Variable length list of fields.
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:175
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...

References CMP_MIRROR_Y, m_Fields, m_Pos, MIRROR(), SetOrientation(), and wxPoint::x.

◆ Move()

void SCH_COMPONENT::Move ( const wxPoint aMoveVector)
inlineoverridevirtual

Move the item by aMoveVector to a new position.

Parameters
aMoveVector= the displacement vector

Implements SCH_ITEM.

Definition at line 577 of file sch_component.h.

578  {
579  if( aMoveVector == wxPoint( 0, 0 ) )
580  return;
581 
582  m_Pos += aMoveVector;
583 
584  for( SCH_FIELD& field : m_Fields )
585  field.Move( aMoveVector );
586 
587  SetModified();
588  }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
void SetModified()
Definition: base_struct.cpp:87
SCH_FIELDS m_Fields
Variable length list of fields.

References m_Fields, m_Pos, and EDA_ITEM::SetModified().

Referenced by SetPosition().

◆ NetClass()

NETCLASSPTR SCH_ITEM::NetClass ( ) const
inherited

Definition at line 160 of file sch_item.cpp.

161 {
162  if( m_connection_map.size() )
163  {
164  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
165  const wxString& netname = m_connection_map.begin()->second->Name( true );
166  const wxString& netclassName = netSettings.m_NetClassAssignments[ netname ];
167 
168  if( !netclassName.IsEmpty() )
169  return netSettings.m_NetClasses.Find( netclassName );
170  else
171  return netSettings.m_NetClasses.GetDefault();
172  }
173 
174  return nullptr;
175 }
std::map< wxString, wxString > m_NetClassAssignments
Definition: net_settings.h:43
NETCLASSPTR Find(const wxString &aName) const
Function Find searches this container for a NETCLASS given by aName.
Definition: netclass.cpp:132
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:116
NET_SETTINGS & NetSettings()
Definition: project_file.h:92
NETCLASSES m_NetClasses
Definition: net_settings.h:39
VTBL_ENTRY PROJECT_FILE & GetProjectFile() const
Definition: project.h:141
NET_SETTINGS stores various net-related settings in a project context.
Definition: net_settings.h:31
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Stores connectivity information, per sheet.
Definition: sch_item.h:209
PROJECT & Prj() const
Return a reference to the project this schematic is part of.
Definition: schematic.h:77
NETCLASSPTR GetDefault() const
Function GetDefault.
Definition: netclass.h:264

References NETCLASSES::Find(), NETCLASSES::GetDefault(), PROJECT::GetProjectFile(), SCH_ITEM::m_connection_map, NET_SETTINGS::m_NetClassAssignments, NET_SETTINGS::m_NetClasses, PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

Referenced by SCH_JUNCTION::GetColor(), SCH_JUNCTION::GetDiameter(), SCH_LINE::GetEffectiveLineStyle(), SCH_LINE::GetLineColor(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), and SCH_BUS_ENTRY_BASE::GetStrokeStyle().

◆ operator!=()

bool SCH_COMPONENT::operator!= ( const SCH_COMPONENT aComponent) const

Definition at line 1705 of file sch_component.cpp.

1706 {
1707  return !( *this == aComponent );
1708 }

◆ operator<() [1/2]

bool EDA_ITEM::operator< ( const EDA_ITEM aItem) const
inherited

Test if another item is less than this object.

Parameters
aItem- Item to compare against.
Returns
- True if aItem is less than the item.

Definition at line 194 of file base_struct.cpp.

195 {
196  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
197  GetChars( GetClass() ) ) );
198 
199  return false;
200 }
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:153
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201

References Format(), GetChars(), and EDA_ITEM::GetClass().

◆ operator<() [2/2]

bool SCH_COMPONENT::operator< ( const SCH_ITEM aItem) const
overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1668 of file sch_component.cpp.

1669 {
1670  if( Type() != aItem.Type() )
1671  return Type() < aItem.Type();
1672 
1673  auto component = static_cast<const SCH_COMPONENT*>( &aItem );
1674 
1675  EDA_RECT rect = GetBodyBoundingBox();
1676 
1677  if( rect.GetArea() != component->GetBodyBoundingBox().GetArea() )
1678  return rect.GetArea() < component->GetBodyBoundingBox().GetArea();
1679 
1680  if( m_Pos.x != component->m_Pos.x )
1681  return m_Pos.x < component->m_Pos.x;
1682 
1683  if( m_Pos.y != component->m_Pos.y )
1684  return m_Pos.y < component->m_Pos.y;
1685 
1686  return m_Uuid < aItem.m_Uuid; // Ensure deterministic sort
1687 }
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
double GetArea() const
Function GetArea returns the area of the rectangle.
const KIID m_Uuid
Definition: base_struct.h:162
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References EDA_RECT::GetArea(), GetBodyBoundingBox(), m_Pos, EDA_ITEM::m_Uuid, EDA_ITEM::Type(), wxPoint::x, and wxPoint::y.

◆ operator=()

SCH_COMPONENT & SCH_COMPONENT::operator= ( const SCH_ITEM aItem)

Definition at line 1711 of file sch_component.cpp.

1712 {
1713  wxCHECK_MSG( Type() == aItem.Type(), *this,
1714  wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
1715  GetClass() );
1716 
1717  if( &aItem != this )
1718  {
1719  SCH_ITEM::operator=( aItem );
1720 
1721  SCH_COMPONENT* c = (SCH_COMPONENT*) &aItem;
1722 
1723  m_lib_id = c->m_lib_id;
1724 
1725  LIB_PART* libSymbol = c->m_part ? new LIB_PART( *c->m_part.get() ) : nullptr;
1726 
1727  m_part.reset( libSymbol );
1728  m_Pos = c->m_Pos;
1729  m_unit = c->m_unit;
1730  m_convert = c->m_convert;
1731  m_transform = c->m_transform;
1732 
1734 
1735  m_Fields = c->m_Fields; // std::vector's assignment operator
1736 
1737  // Reparent fields after assignment to new component.
1738  for( SCH_FIELD& field : m_Fields )
1739  field.SetParent( this );
1740 
1741  UpdatePins();
1742  }
1743 
1744  return *this;
1745 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
SCH_FIELDS m_Fields
Variable length list of fields.
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
Define a library symbol object.
std::unique_ptr< LIB_PART > m_part
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Operator assignment is used to assign the members of aItem to another object.
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_component.h:84
Schematic symbol object.
Definition: sch_component.h:80
virtual wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_item.h:221
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:86
void UpdatePins()
Updates the cache of SCH_PIN objects for each pin.
wxString GetClass() const override
Function GetClass returns the class name.
TRANSFORM m_transform
The rotation/mirror transformation matrix.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References GetClass(), SCH_ITEM::GetClass(), m_convert, m_Fields, m_instanceReferences, m_lib_id, m_part, m_Pos, m_transform, m_unit, EDA_ITEM::operator=(), EDA_ITEM::Type(), and UpdatePins().

◆ operator==()

bool SCH_COMPONENT::operator== ( const SCH_COMPONENT aComponent) const

Definition at line 1690 of file sch_component.cpp.

1691 {
1692  if( GetFieldCount() != aComponent.GetFieldCount() )
1693  return false;
1694 
1695  for( int i = VALUE; i < GetFieldCount(); i++ )
1696  {
1697  if( GetField( i )->GetText().Cmp( aComponent.GetField( i )->GetText() ) != 0 )
1698  return false;
1699  }
1700 
1701  return true;
1702 }
int GetFieldCount() const
Return the number of fields in this symbol.
SCH_FIELD * GetField(int aFieldNdx)
Returns a field in this symbol.
Field Value of part, i.e. "3.3K".
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:127

References GetField(), GetFieldCount(), EDA_TEXT::GetText(), and VALUE.

◆ Plot()

void SCH_COMPONENT::Plot ( PLOTTER aPlotter)
overridevirtual

Plot the schematic item to aPlotter.

Parameters
aPlotterA pointer to a PLOTTER object.

Reimplemented from SCH_ITEM.

Definition at line 1807 of file sch_component.cpp.

1808 {
1809  if( m_part )
1810  {
1811  TRANSFORM temp = GetTransform();
1812  aPlotter->StartBlock( nullptr );
1813 
1814  m_part->Plot( aPlotter, GetUnit(), GetConvert(), m_Pos, temp );
1815 
1816  for( SCH_FIELD field : m_Fields )
1817  field.Plot( aPlotter );
1818 
1819  aPlotter->EndBlock( nullptr );
1820  }
1821 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
virtual void EndBlock(void *aData)
calling this function allows one to define the end of a group of drawing items for instance in SVG or...
Definition: plotter.h:486
SCH_FIELDS m_Fields
Variable length list of fields.
virtual void StartBlock(void *aData)
calling this function allows one to define the beginning of a group of drawing items,...
Definition: plotter.h:477
int GetUnit() const
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM & GetTransform() const
std::unique_ptr< LIB_PART > m_part
int GetConvert() const

References PLOTTER::EndBlock(), GetConvert(), GetTransform(), GetUnit(), m_Fields, m_part, m_Pos, and PLOTTER::StartBlock().

◆ Print()

void SCH_COMPONENT::Print ( RENDER_SETTINGS aSettings,
const wxPoint aOffset 
)
overridevirtual

Print a component.

Parameters
aDCis the device context (can be null)
aOffsetis the drawing offset (usually wxPoint(0,0), but can be different when moving an object)

Implements SCH_ITEM.

Definition at line 354 of file sch_component.cpp.

355 {
356  PART_DRAW_OPTIONS opts;
357  opts.transform = m_transform;
358  opts.draw_visible_fields = false;
359  opts.draw_hidden_fields = false;
360 
361  if( m_part )
362  {
363  m_part->Print( aSettings, m_Pos + aOffset, m_unit, m_convert, opts );
364  }
365  else // Use dummy() part if the actual cannot be found.
366  {
367  dummy()->Print( aSettings, m_Pos + aOffset, 0, 0, opts );
368  }
369 
370  for( SCH_FIELD& field : m_Fields )
371  field.Print( aSettings, aOffset );
372 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
SCH_FIELDS m_Fields
Variable length list of fields.
std::unique_ptr< LIB_PART > m_part
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
void Print(RENDER_SETTINGS *aSettings, const wxPoint &aOffset, int aMulti, int aConvert, const PART_DRAW_OPTIONS &aOpts)
Print part.
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:86
TRANSFORM m_transform
The rotation/mirror transformation matrix.

References PART_DRAW_OPTIONS::draw_hidden_fields, PART_DRAW_OPTIONS::draw_visible_fields, dummy(), m_convert, m_Fields, m_part, m_Pos, m_transform, m_unit, LIB_PART::Print(), and PART_DRAW_OPTIONS::transform.

◆ RemoveField()

void SCH_COMPONENT::RemoveField ( const wxString &  aFieldName)

Removes a user field from the symbol.

Parameters
aFieldNameis the user fieldName to remove. Attempts to remove a mandatory field or a non-existant field are silently ignored.

Definition at line 713 of file sch_component.cpp.

714 {
715  for( unsigned i = MANDATORY_FIELDS; i < m_Fields.size(); ++i )
716  {
717  if( aFieldName == m_Fields[i].GetName( false ) )
718  {
719  m_Fields.erase( m_Fields.begin() + i );
720  return;
721  }
722  }
723 }
SCH_FIELDS m_Fields
Variable length list of fields.
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.

References m_Fields, and MANDATORY_FIELDS.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), and DIALOG_CHANGE_SYMBOLS::processSymbol().

◆ Replace() [1/2]

bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
wxString &  aText 
)
staticinherited

Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aTextA reference to a wxString object containing the text to be replaced.
Returns
True if aText was modified, otherwise false.

Definition at line 167 of file base_struct.cpp.

168 {
169  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
170 
171  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
172  aSearchData.GetFindString() :
173  aSearchData.GetFindString().Upper() );
174 
175  if( result == wxNOT_FOUND )
176  return false;
177 
178  wxString prefix = aText.Left( result );
179  wxString suffix;
180 
181  if( aSearchData.GetFindString().length() + result < aText.length() )
182  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
183 
184  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
185  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
186  GetChars( suffix ) );
187 
188  aText = prefix + aSearchData.GetReplaceString() + suffix;
189 
190  return true;
191 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:153

References GetChars(), and traceFindReplace.

Referenced by SCH_FIELD::Replace(), EDA_TEXT::Replace(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

◆ Replace() [2/2]

virtual bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
void *  aAuxData = NULL 
)
inlinevirtualinherited

Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item text was modified, otherwise false.

Reimplemented in SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, and SCH_PIN.

Definition at line 490 of file base_struct.h.

490 { return false; }

◆ ReplaceInstanceSheetPath()

bool SCH_COMPONENT::ReplaceInstanceSheetPath ( const KIID_PATH aOldSheetPath,
const KIID_PATH aNewSheetPath 
)

Replace aOldSheetPath with aNewSheetPath in the instance list.

Parameters
aOldSheetPathis a KIID_PATH object of an existing path in the instance list.
aNewSheetPathis a KIID_PATH object of the path to replace the existing path.
Returns
true if aOldSheetPath was found and replaced or false if aOldSheetPath was not found in the instance list.

Definition at line 1036 of file sch_component.cpp.

1038 {
1039  auto it = std::find_if( m_instanceReferences.begin(), m_instanceReferences.end(),
1040  [ aOldSheetPath ]( COMPONENT_INSTANCE_REFERENCE& r )->bool
1041  {
1042  return aOldSheetPath == r.m_Path;
1043  }
1044  );
1045 
1046  if( it != m_instanceReferences.end() )
1047  {
1048  wxLogTrace( traceSchSheetPaths,
1049  "Replacing sheet path %s\n with sheet path %s\n for symbol %s.",
1050  aOldSheetPath.AsString(), aNewSheetPath.AsString(), m_Uuid.AsString() );
1051 
1052  it->m_Path = aNewSheetPath;
1053  return true;
1054  }
1055 
1056  wxLogTrace( traceSchSheetPaths,
1057  "Could not find sheet path %s\n to replace with sheet path %s\n for symbol %s.",
1058  aOldSheetPath.AsString(), aNewSheetPath.AsString(), m_Uuid.AsString() );
1059 
1060  return false;
1061 }
const wxChar *const traceSchSheetPaths
Flag to enable debug output of schematic symbol sheet path manipulation code.
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
wxString AsString() const
Definition: common.cpp:165
A simple container for schematic symbol instance infromation.
const KIID m_Uuid
Definition: base_struct.h:162
wxString AsString() const
Definition: common.h:137

References KIID::AsString(), KIID_PATH::AsString(), m_instanceReferences, EDA_ITEM::m_Uuid, and traceSchSheetPaths.

◆ ResolveTextVar()

bool SCH_COMPONENT::ResolveTextVar ( wxString *  token,
int  aDepth = 0 
) const

Resolve any references to system tokens supported by the component.

Parameters
aDeptha counter to limit recursion and circular references.

Definition at line 897 of file sch_component.cpp.

898 {
899  SCHEMATIC* schematic = Schematic();
900 
901  for( int i = 0; i < MANDATORY_FIELDS; ++i )
902  {
903  if( token->IsSameAs( m_Fields[ i ].GetCanonicalName().Upper() ) )
904  {
905  if( i == REFERENCE && schematic )
906  *token = GetRef( &schematic->CurrentSheet(), true );
907  else if( i == VALUE && schematic )
908  *token = GetValue( &schematic->CurrentSheet() );
909  else if( i == FOOTPRINT && schematic )
910  *token = GetFootprint( &schematic->CurrentSheet() );
911  else
912  *token = m_Fields[ i ].GetShownText( aDepth + 1 );
913 
914  return true;
915  }
916  }
917 
918  for( size_t i = MANDATORY_FIELDS; i < m_Fields.size(); ++i )
919  {
920  if( token->IsSameAs( m_Fields[ i ].GetName() )
921  || token->IsSameAs( m_Fields[ i ].GetName().Upper() ) )
922  {
923  *token = m_Fields[ i ].GetShownText( aDepth + 1 );
924  return true;
925  }
926  }
927 
928  if( token->IsSameAs( wxT( "FOOTPRINT_LIBRARY" ) ) )
929  {
930  wxString footprint;
931 
932  if( schematic )
933  footprint = GetFootprint( &schematic->CurrentSheet() );
934  else
935  footprint = m_Fields[ FOOTPRINT ].GetShownText();
936 
937  wxArrayString parts = wxSplit( footprint, ':' );
938 
939  *token = parts[ 0 ];
940  return true;
941  }
942  else if( token->IsSameAs( wxT( "FOOTPRINT_NAME" ) ) )
943  {
944  wxString footprint;
945 
946  if( schematic )
947  footprint = GetFootprint( &schematic->CurrentSheet() );
948  else
949  footprint = m_Fields[ FOOTPRINT ].GetShownText();
950 
951  wxArrayString parts = wxSplit( footprint, ':' );
952 
953  *token = parts[ std::min( 1, (int) parts.size() - 1 ) ];
954  return true;
955  }
956  else if( token->IsSameAs( wxT( "UNIT" ) ) )
957  {
958  int unit;
959 
960  if( schematic )
961  unit = GetUnitSelection( &schematic->CurrentSheet() );
962  else
963  unit = GetUnit();
964 
965  *token = LIB_PART::SubReference( unit );
966  return true;
967  }
968 
969  return false;
970 }
Holds all the data relating to one schematic A schematic may consist of one or more sheets (and one r...
Definition: schematic.h:42
SCH_FIELDS m_Fields
Variable length list of fields.
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:116
const wxString GetValue(const SCH_SHEET_PATH *sheet) const
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
int GetUnit() const
const wxString GetFootprint(const SCH_SHEET_PATH *sheet) const
Field Value of part, i.e. "3.3K".
static wxString SubReference(int aUnit, bool aAddSeparator=true)
int GetUnitSelection(const SCH_SHEET_PATH *aSheet) const
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
SCH_SHEET_PATH & CurrentSheet() const
Definition: schematic.h:119

References SCHEMATIC::CurrentSheet(), FOOTPRINT, GetFootprint(), GetRef(), GetUnit(), GetUnitSelection(), GetValue(), m_Fields, MANDATORY_FIELDS, REFERENCE, SCH_ITEM::Schematic(), LIB_PART::SubReference(), and VALUE.

Referenced by SCHEMATIC::ConvertRefsToKIIDs(), SCH_FIELD::GetShownText(), and SCHEMATIC::ResolveCrossReference().

◆ Rotate()

void SCH_COMPONENT::Rotate ( wxPoint  aPosition)
overridevirtual

Rotate the item around aPosition 90 degrees in the clockwise direction.

Parameters
aPositionA reference to a wxPoint object containing the coordinates to rotate around.

Implements SCH_ITEM.

Definition at line 1445 of file sch_component.cpp.

1446 {
1447  wxPoint prev = m_Pos;
1448 
1449  RotatePoint( &m_Pos, aPosition, 900 );
1450 
1452 
1453  for( SCH_FIELD& field : m_Fields )
1454  {
1455  // Move the fields to the new position because the component itself has moved.
1456  wxPoint pos = field.GetTextPos();
1457  pos.x -= prev.x - m_Pos.x;
1458  pos.y -= prev.y - m_Pos.y;
1459  field.SetTextPos( pos );
1460  }
1461 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
SCH_FIELDS m_Fields
Variable length list of fields.
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...

References CMP_ROTATE_COUNTERCLOCKWISE, m_Fields, m_Pos, RotatePoint(), SetOrientation(), wxPoint::x, and wxPoint::y.

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const
inherited

Searches the item hierarchy to find a SCHEMATIC.

Every SCH_ITEM that lives on a SCH_SCREEN should be parented to either that screen or another SCH_ITEM on the same screen (for example, pins to their components).

Every SCH_SCREEN should be parented to the SCHEMATIC. Note that this hierarchy is not the same as the sheet hierarchy!

Returns
the parent schematic this item lives on, or nullptr

Definition at line 116 of file sch_item.cpp.

117 {
118  EDA_ITEM* parent = GetParent();
119 
120  while( parent )
121  {
122  if( parent->Type() == SCHEMATIC_T )
123  return static_cast<SCHEMATIC*>( parent );
124  else
125  parent = parent->GetParent();
126  }
127 
128  return nullptr;
129 }
EDA_ITEM * GetParent() const
Definition: base_struct.h:195
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:159
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References EDA_ITEM::GetParent(), SCHEMATIC_T, and EDA_ITEM::Type().

Referenced by SCH_EDIT_FRAME::CreateSheetPin(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_JUNCTION::GetBoundingBox(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::GetDiameter(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_NO_CONNECT::GetPenWidth(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), GetPins(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_SHEET::IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnAddField(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), SCH_JUNCTION::Plot(), SCH_JUNCTION::Print(), SCH_HIERLABEL::Print(), ResolveTextVar(), SCH_SHEET::ResolveTextVar(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and SCH_MARKER::ViewGetLayers().

◆ Set() [1/3]

bool INSPECTABLE::Set ( PROPERTY_BASE aProperty,
wxAny &  aValue 
)
inlineinherited

Definition at line 40 of file inspectable.h.

41  {
43  TYPE_ID thisType = TYPE_HASH( *this );
44  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
45 
46  if( object )
47  aProperty->setter( object, aValue );
48 
49  return object != nullptr;
50  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
virtual void setter(void *aObject, wxAny &aValue)=0
Provides class metadata.
Definition: property_mgr.h:58
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::setter(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [2/3]

template<typename T >
bool INSPECTABLE::Set ( PROPERTY_BASE aProperty,
aValue 
)
inlineinherited

Definition at line 53 of file inspectable.h.

54  {
56  TYPE_ID thisType = TYPE_HASH( *this );
57  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
58 
59  if( object )
60  aProperty->set<T>( object, aValue );
61 
62  return object != nullptr;
63  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
Provides class metadata.
Definition: property_mgr.h:58
void set(void *aObject, T aValue)
Definition: property.h:266
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [3/3]

template<typename T >
bool INSPECTABLE::Set ( const wxString &  aProperty,
aValue 
)
inlineinherited

Definition at line 66 of file inspectable.h.

67  {
69  TYPE_ID thisType = TYPE_HASH( *this );
70  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
71  void* object = nullptr;
72 
73  if( prop )
74  {
75  object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
76 
77  if( object )
78  prop->set<T>( object, aValue );
79  }
80 
81  return object != nullptr;
82  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Returns a property for a specific type.
Provides class metadata.
Definition: property_mgr.h:58
void set(void *aObject, T aValue)
Definition: property.h:266
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

References PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ SetBrightened()

◆ SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool  aDirty = true)
inlineinherited

Definition at line 435 of file sch_item.h.

435 { m_connectivity_dirty = aDirty; }
bool m_connectivity_dirty
True if connectivity info might be out of date.
Definition: sch_item.h:212

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetConvert()

void SCH_COMPONENT::SetConvert ( int  aConvert)

Definition at line 322 of file sch_component.cpp.

323 {
324  if( m_convert != aConvert )
325  {
326  m_convert = aConvert;
327 
328  // The convert may have a different pin layout so the update the pin map.
329  UpdatePins();
330  SetModified();
331  }
332 }
void SetModified()
Definition: base_struct.cpp:87
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:86
void UpdatePins()
Updates the cache of SCH_PIN objects for each pin.

References m_convert, EDA_ITEM::SetModified(), and UpdatePins().

Referenced by SCH_EDIT_FRAME::ConvertPart(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow().

◆ SetFields()

void SCH_COMPONENT::SetFields ( const SCH_FIELDS aFields)
inline

Set multiple schematic fields.

Parameters
aFieldsare the fields to set in this symbol.

Definition at line 430 of file sch_component.h.

431  {
432  m_Fields = aFields; // vector copying, length is changed possibly
433  }
SCH_FIELDS m_Fields
Variable length list of fields.

References m_Fields.

Referenced by DIALOG_UPDATE_FIELDS::updateFields().

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 232 of file base_struct.h.

232 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), SCH_MOVE_TOOL::AlignElements(), PCBNEW_CONTROL::AppendBoard(), SCH_EDIT_TOOL::ChangeTextType(), GRAPHICS_CLEANER::cleanupSegments(), TRACKS_CLEANER::cleanupSegments(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), LIB_PIN_TOOL::CreatePin(), SCH_EDIT_FRAME::CreateSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), EDIT_POINTS_FACTORY::Make(), TRACKS_CLEANER::mergeCollinearSegments(), LIB_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParseWire(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetFootprint() [1/2]

void SCH_COMPONENT::SetFootprint ( const SCH_SHEET_PATH sheet,
const wxString &  aFootprint 
)

Definition at line 635 of file sch_component.cpp.

636 {
637  if( sheet == nullptr )
638  {
639  // Clear instance overrides and set primary field value
641  instance.m_Footprint = wxEmptyString;
642 
643  m_Fields[ FOOTPRINT ].SetText( aFootprint );
644  return;
645  }
646 
647  KIID_PATH path = sheet->Path();
648 
649  // check to see if it is already there before inserting it
651  {
652  if( instance.m_Path == path )
653  {
654  instance.m_Footprint = aFootprint;
655  return;
656  }
657  }
658 
659  // didn't find it; better add it
660  AddHierarchicalReference( path, m_prefix, m_unit, wxEmptyString, aFootprint );
661 }
SCH_FIELDS m_Fields
Variable length list of fields.
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
Field Name Module PCB, i.e. "16DIP300".
A simple container for schematic symbol instance infromation.
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85
void AddHierarchicalReference(const KIID_PATH &aPath, const wxString &aRef, int aUnit, const wxString &aValue=wxEmptyString, const wxString &aFootprint=wxEmptyString)
Add a full hierarchical reference to this symbol.
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is.
Definition: sch_component.h:89

References AddHierarchicalReference(), FOOTPRINT, m_Fields, m_instanceReferences, m_prefix, m_unit, and SCH_SHEET_PATH::Path().

Referenced by BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_EDITOR_CONTROL::BackAnnotateFootprints(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), SetFootprint(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and SCH_EDITOR_CONTROL::updatePastedInstances().

◆ SetFootprint() [2/2]

void SCH_COMPONENT::SetFootprint ( const wxString &  aFootprint)
inline

Definition at line 570 of file sch_component.h.

571  {
572  SetFootprint( nullptr, aFootprint );
573  }
void SetFootprint(const SCH_SHEET_PATH *sheet, const wxString &aFootprint)

References SetFootprint().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible.

Parameters
aEnableTrue forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 284 of file base_struct.h.

284 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: base_struct.h:175

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetIncludeInBom()

void SCH_COMPONENT::SetIncludeInBom ( bool  aIncludeInBom)
inline

Definition at line 677 of file sch_component.h.

677 { m_inBom = aIncludeInBom; }
bool m_inBom
True to include in bill of materials export.

References m_inBom.

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow().

◆ SetIncludeOnBoard()

void SCH_COMPONENT::SetIncludeOnBoard ( bool  aIncludeOnBoard)
inline

Definition at line 680 of file sch_component.h.

680 { m_onBoard = aIncludeOnBoard; }
bool m_onBoard
True to include in netlist when updating board.

References m_onBoard.

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID  aLayer)
inlineinherited

Set the layer this item is on.

Parameters
aLayerThe layer number.

Definition at line 286 of file sch_item.h.

286 { m_Layer = aLayer; }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:199

References SCH_ITEM::m_Layer.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), SCH_NO_CONNECT::SCH_NO_CONNECT(), SCH_FIELD::SetId(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ SetLibId()

void SCH_COMPONENT::SetLibId ( const LIB_ID aName)

Definition at line 221 of file sch_component.cpp.

222 {
223  if( m_lib_id != aLibId )
224  {
225  m_lib_id = aLibId;
226  SetModified();
227  }
228 }
void SetModified()
Definition: base_struct.cpp:87
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_component.h:84

References m_lib_id, and EDA_ITEM::SetModified().

Referenced by SCH_ALTIUM_PLUGIN::ParseComponent(), DIALOG_CHANGE_SYMBOLS::processSymbol(), and DIALOG_SYMBOL_REMAP::remapSymbolToLibTable().

◆ SetLibSymbol()

void SCH_COMPONENT::SetLibSymbol ( LIB_PART aLibSymbol)

Set this schematic symbol library symbol reference to aLibSymbol.

The schematic symbol object owns aLibSymbol and the pin list will be updated accordingly. The LIB_PART object can be null to clear the library symbol link as well as the pin map. If the LIB_PART object is not null, it must be a root symbol. Otherwise an assertion will be raised in debug builds and the library symbol will be cleared. The new file format will no longer require a cache library so all library symbols must be valid.

Note
This is the only way to publicly set the library symbol for a schematic symbol except for the ctors that take a LIB_PART reference. All previous public resolvers have been deprecated.
Parameters
aLibSymbolis the library symbol to associate with this schematic symbol.

Definition at line 240 of file sch_component.cpp.

241 {
242  wxCHECK2( ( aLibSymbol == nullptr ) || ( aLibSymbol->IsRoot() ), aLibSymbol = nullptr );
243 
244  m_part.reset( aLibSymbol );
245  UpdatePins();
246 }
std::unique_ptr< LIB_PART > m_part
bool IsRoot() const override
For symbols derived from other symbols, IsRoot() indicates no derivation.
void UpdatePins()
Updates the cache of SCH_PIN objects for each pin.

References LIB_PART::IsRoot(), m_part, and UpdatePins().

Referenced by SCH_EDITOR_CONTROL::Paste(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_TOOL::RefreshSymbolFromLibrary(), SCH_COMPONENT(), and SCH_EDIT_FRAME::UpdateSymbolFromEditor().

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

Set the 'lock' status to aLocked for of this item.

Definition at line 274 of file sch_item.h.

274 {}

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

Definition at line 87 of file base_struct.cpp.

88 {
90 
91  // If this a child object, then the parent modification state also needs to be set.
92  if( m_Parent )
94 }
void SetModified()
Definition: base_struct.cpp:87
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:113
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:232

References IS_CHANGED, EDA_ITEM::m_Parent, EDA_ITEM::SetFlags(), and EDA_ITEM::SetModified().

Referenced by LIB_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_ALTIUM_PLUGIN::Parse(), ALTIUM_PCB::Parse(), LIB_PART::RemoveDrawItem(), SetConvert(), SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SetTransform(), and SetUnit().

◆ SetOrientation()

void SCH_COMPONENT::SetOrientation ( int  aOrientation)

Compute the new transform matrix based on aOrientation for the symbol which is applied to the current transform.

Parameters
aOrientationis the orientation to apply to the transform.

Definition at line 1064 of file sch_component.cpp.

1065 {
1066  TRANSFORM temp = TRANSFORM();
1067  bool transform = false;
1068 
1069  switch( aOrientation )
1070  {
1071  case CMP_ORIENT_0:
1072  case CMP_NORMAL: // default transform matrix
1073  m_transform.x1 = 1;
1074  m_transform.y2 = -1;
1075  m_transform.x2 = m_transform.y1 = 0;
1076  break;
1077 
1078  case CMP_ROTATE_COUNTERCLOCKWISE: // Rotate + (incremental rotation)
1079  temp.x1 = temp.y2 = 0;
1080  temp.y1 = 1;
1081  temp.x2 = -1;
1082  transform = true;
1083  break;
1084 
1085  case CMP_ROTATE_CLOCKWISE: // Rotate - (incremental rotation)
1086  temp.x1 = temp.y2 = 0;
1087  temp.y1 = -1;
1088  temp.x2 = 1;
1089  transform = true;
1090  break;
1091 
1092  case CMP_MIRROR_Y: // Mirror Y (incremental rotation)
1093  temp.x1 = -1;
1094  temp.y2 = 1;
1095  temp.y1 = temp.x2 = 0;
1096  transform = true;
1097  break;
1098 
1099  case CMP_MIRROR_X: // Mirror X (incremental rotation)
1100  temp.x1 = 1;
1101  temp.y2 = -1;
1102  temp.y1 = temp.x2 = 0;
1103  transform = true;
1104  break;
1105 
1106  case CMP_ORIENT_90:
1109  break;
1110 
1111  case CMP_ORIENT_180:
1115  break;
1116 
1117  case CMP_ORIENT_270:
1120  break;
1121 
1122  case ( CMP_ORIENT_0 + CMP_MIRROR_X ):
1125  break;
1126 
1127  case ( CMP_ORIENT_0 + CMP_MIRROR_Y ):
1130  break;
1131 
1132  case ( CMP_ORIENT_90 + CMP_MIRROR_X ):
1135  break;
1136 
1137  case ( CMP_ORIENT_90 + CMP_MIRROR_Y ):
1140  break;
1141 
1142  case ( CMP_ORIENT_180 + CMP_MIRROR_X ):
1145  break;
1146 
1147  case ( CMP_ORIENT_180 + CMP_MIRROR_Y ):
1150  break;
1151 
1152  case ( CMP_ORIENT_270 + CMP_MIRROR_X ):
1155  break;
1156 
1157  case ( CMP_ORIENT_270 + CMP_MIRROR_Y ):
1160  break;
1161 
1162  default:
1163  transform = false;
1164  wxFAIL_MSG( "Invalid schematic symbol orientation type." );
1165  break;
1166  }
1167 
1168  if( transform )
1169  {
1170  /* The new matrix transform is the old matrix transform modified by the
1171  * requested transformation, which is the temp transform (rot,
1172  * mirror ..) in order to have (in term of matrix transform):
1173  * transform coord = new_m_transform * coord
1174  * where transform coord is the coord modified by new_m_transform from
1175  * the initial value coord.
1176  * new_m_transform is computed (from old_m_transform and temp) to
1177  * have:
1178  * transform coord = old_m_transform * temp
1179  */
1180  TRANSFORM newTransform;
1181 
1182  newTransform.x1 = m_transform.x1 * temp.x1 + m_transform.x2 * temp.y1;
1183  newTransform.y1 = m_transform.y1 * temp.x1 + m_transform.y2 * temp.y1;
1184  newTransform.x2 = m_transform.x1 * temp.x2 + m_transform.x2 * temp.y2;
1185  newTransform.y2 = m_transform.y1 * temp.x2 + m_transform.y2 * temp.y2;
1186  m_transform = newTransform;
1187  }
1188 }
int y2
Definition: transform.h:51
int x2
Definition: transform.h:50
int x1
Definition: transform.h:48
int y1
Definition: transform.h:49
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM m_transform
The rotation/mirror transformation matrix.
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...

References CMP_MIRROR_X, CMP_MIRROR_Y, CMP_NORMAL, CMP_ORIENT_0, CMP_ORIENT_180, CMP_ORIENT_270, CMP_ORIENT_90, CMP_ROTATE_CLOCKWISE, CMP_ROTATE_COUNTERCLOCKWISE, m_transform, TRANSFORM::x1, TRANSFORM::x2, TRANSFORM::y1, and TRANSFORM::y2.

Referenced by GetOrientation(), SCH_EDIT_TOOL::Mirror(), MirrorX(), MirrorY(), SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_EDIT_TOOL::Rotate(), Rotate(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Reimplemented in DIMENSION.

Definition at line 196 of file base_struct.h.

196 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174

References EDA_ITEM::m_Parent.

Referenced by MODULE::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), SCH_SHEET::AddPin(), LIB_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), ZONE_FILLER::buildCopperItemClearances(), LIB_FIELD::Copy(), LIB_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), LIB_PART::Flatten(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), LIB_PART::LIB_PART(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), MODULE::operator=(), LIB_PART::operator=(), PCB_PARSER::parseMODULE_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), LIB_EDIT_TOOL::Paste(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteModuleItemsToModEdit(), SCH_DRAWING_TOOLS::PlaceComponent(), PCB_EDITOR_CONTROL::PlaceModule(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), DIMENSION::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_SHEET::SwapData(), SwapData(), and SwapItemData().

◆ SetPosition()

void SCH_COMPONENT::SetPosition ( const wxPoint aPosition)
inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 659 of file sch_component.h.

659 { Move( aPosition - m_Pos ); }
void Move(const wxPoint &aMoveVector) override
Move the item by aMoveVector to a new position.

References m_Pos, and Move().

Referenced by SCH_ALTIUM_PLUGIN::ParseComponent(), and SCH_DRAWING_TOOLS::PlaceComponent().

◆ SetPrefix()

void SCH_COMPONENT::SetPrefix ( const wxString &  aPrefix)
inline

Definition at line 271 of file sch_component.h.

271 { m_prefix = aPrefix; }
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is.
Definition: sch_component.h:89

References m_prefix.

◆ SetRef()

void SCH_COMPONENT::SetRef ( const SCH_SHEET_PATH aSheet,
const wxString &  aReference 
)

Set the reference for the given sheet path for this symbol.

Parameters
aSheetis the hierarchical path of the reference.
aReferenceis the new reference for the symbol.

Definition at line 466 of file sch_component.cpp.

467 {
468  KIID_PATH path = sheet->Path();
469  bool notInArray = true;
470 
471  // check to see if it is already there before inserting it
473  {
474  if( instance.m_Path == path )
475  {
476  instance.m_Reference = ref;
477  notInArray = false;
478  }
479  }
480 
481  if( notInArray )
482  AddHierarchicalReference( path, ref, m_unit );
483 
484  for( std::unique_ptr<SCH_PIN>& pin : m_pins )
485  pin->ClearDefaultNetName( sheet );
486 
487  SCH_FIELD* rf = GetField( REFERENCE );
488 
489  // @todo Should we really be checking for what is a "reasonable" position?
490  if( rf->GetText().IsEmpty()
491  || ( abs( rf->GetTextPos().x - m_Pos.x ) +
492  abs( rf->GetTextPos().y - m_Pos.y ) > Mils2iu( 10000 ) ) )
493  {
494  // move it to a reasonable position
495  rf->SetTextPos( m_Pos + wxPoint( Mils2iu( 50 ), Mils2iu( 50 ) ) );
496  }
497 
498  rf->SetText( ref ); // for drawing.
499 
500  // Reinit the m_prefix member if needed
501  wxString prefix = ref;
502 
503  if( IsReferenceStringValid( prefix ) )
504  {
505  while( prefix.Last() == '?' || wxIsdigit( prefix.Last() ) )
506  prefix.RemoveLast();
507  }
508  else
509  {
510  prefix = wxT( "U" ); // Set to default ref prefix
511  }
512 
513  if( m_prefix != prefix )
514  m_prefix = prefix;
515 
516  // Power components have references starting with # and are not included in netlists
517  m_isInNetlist = ! ref.StartsWith( wxT( "#" ) );
518 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:247
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
Field Reference of part, i.e. "IC21".
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:121
bool m_isInNetlist
True if the component should appear in the netlist.
A simple container for schematic symbol instance infromation.
SCH_FIELD * GetField(int aFieldNdx)
Returns a field in this symbol.
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85
const wxPoint & GetTextPos() const
Definition: eda_text.h:248
void AddHierarchicalReference(const KIID_PATH &aPath, const wxString &aRef, int aUnit, const wxString &aValue=wxEmptyString, const wxString &aFootprint=wxEmptyString)
Add a full hierarchical reference to this symbol.
std::vector< std::unique_ptr< SCH_PIN > > m_pins
static bool IsReferenceStringValid(const wxString &aReferenceString)
Tests for an acceptable reference string.
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is.
Definition: sch_component.h:89
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:127

References AddHierarchicalReference(), GetField(), EDA_TEXT::GetText(), EDA_TEXT::GetTextPos(), IsReferenceStringValid(), m_instanceReferences, m_isInNetlist, m_pins, m_Pos, m_prefix, m_unit, SCH_SHEET_PATH::Path(), REFERENCE, EDA_TEXT::SetText(), EDA_TEXT::SetTextPos(), wxPoint::x, and wxPoint::y.

Referenced by SCH_REFERENCE::Annotate(), BACK_ANNOTATE::applyChangelist(), BOOST_AUTO_TEST_CASE(), SCH_FIELD::Replace(), SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and SCH_EDITOR_CONTROL::updatePastedInstances().

◆ SetSchSymbolLibraryName()

void SCH_COMPONENT::SetSchSymbolLibraryName ( const wxString &  aName)
inline

The name of the symbol in the schematic library symbol list.

Note
See SCH_SCREEN::m_libSymbols

The name of the schematic symbol list entry can vary from the item name in the LIB_ID object because the library symbol may have changed so a new name has to be generated but the original symbol library link has to be preserved in order to update it from the library at some point in the future. If this name is empty, then the library item name from LIB_ID is used.

Definition at line 203 of file sch_component.h.

203 { m_schLibSymbolName = aName; }
wxString m_schLibSymbolName
The name used to look up a symbol in the symbol library embedded in a schematic.

References m_schLibSymbolName.

Referenced by SCH_SCREEN::Append().

◆ SetSelected()

◆ SetState()

void EDA_ITEM::SetState ( int  type,
int  state 
)
inlineinherited

Definition at line 221 of file base_struct.h.

222  {
223  if( state )
224  m_Status |= type; // state = ON or OFF
225  else
226  m_Status &= ~type;
227  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by LEGACY_PLUGIN::loadTrackList(), TRACKS_CLEANER::mergeCollinearSegments(), SELECTION_TOOL::selectConnectedTracks(), and TRACK::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 230 of file base_struct.h.

230 { m_Status = aStatus; }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( wxPoint  aPos)
inlineinherited

Definition at line 251 of file sch_item.h.

251 { m_storedPos = aPos; }
wxPoint m_storedPos
Definition: sch_item.h:202

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::Main(), and SCH_MOVE_TOOL::moveItem().

◆ SetStroke()

virtual void SCH_ITEM::SetStroke ( const STROKE_PARAMS aStroke)
inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 476 of file sch_item.h.

476 { wxCHECK( false, /* void */ ); }

◆ SetTransform()

void SCH_COMPONENT::SetTransform ( const TRANSFORM aTransform)

Definition at line 335 of file sch_component.cpp.

336 {
337  if( m_transform != aTransform )
338  {
339  m_transform = aTransform;
340  SetModified();
341  }
342 }
void SetModified()
Definition: base_struct.cpp:87
TRANSFORM m_transform
The rotation/mirror transformation matrix.

References m_transform, and EDA_ITEM::SetModified().

◆ SetUnit()

void SCH_COMPONENT::SetUnit ( int  aUnit)

Change the unit number to aUnit.

This has meaning only for symbols made up of multiple units per package.

Note
This also set the modified flag bit
Parameters
aUnitis the new unit to select.

Definition at line 306 of file sch_component.cpp.

307 {
308  if( m_unit != aUnit )
309  {
310  m_unit = aUnit;
311  SetModified();
312  }
313 }
void SetModified()
Definition: base_struct.cpp:87
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:85

References m_unit, and EDA_ITEM::SetModified().

Referenced by SCH_REFERENCE::Annotate(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), and SCH_EDITOR_CONTROL::updatePastedInstances().

◆ SetUnitSelection()

void SCH_COMPONENT::SetUnitSelection ( const SCH_SHEET_PATH aSheet,
int  aUnitSelection 
)

Definition at line 551 of file sch_component.cpp.

552 {
553  KIID_PATH path = aSheet->Path();
554 
555  // check to see if it is already there before inserting it
557  {
558  if( instance.m_Path == path )
559  {
560  instance.m_Unit = aUnitSelection;
561  return;
562  }
563  }
564 
565  // didn't find it; better add it
566  AddHierarchicalReference( path, m_prefix, aUnitSelection );
567 }
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
std::vector< COMPONENT_INSTANCE_REFERENCE > m_instanceReferences
A simple container for schematic symbol instance infromation.