KiCad PCB EDA Suite
SCH_COMPONENT Class Reference

Schematic symbol object. More...

#include <sch_symbol.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 (const LIB_PART &aPart, const LIB_ID &aLibId, const SCH_SHEET_PATH *aSheet, int unit=0, int convert=0, const wxPoint &pos=wxPoint(0, 0))
 Create schematic symbol from library symbol object. More...
 
 SCH_COMPONENT (const LIB_PART &aPart, const SCH_SHEET_PATH *aSheet, const PICKED_SYMBOL &aSel, const wxPoint &pos=wxPoint(0, 0))
 
 SCH_COMPONENT (const SCH_COMPONENT &aSymbol)
 Clone aSymbol into a new schematic symbol object. More...
 
 ~SCH_COMPONENT ()
 
wxString GetClass () const override
 Return the class name. More...
 
const std::vector< SYMBOL_INSTANCE_REFERENCE > & GetInstanceReferences ()
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Return the layers the item is drawn on (which may be more than its "home" layer) More...
 
bool IsMovableFromAnchorPoint () const 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 ()
 
const std::unique_ptr< LIB_PART > & GetPartRef () const
 
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 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 symbol. More...
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
void ClearAnnotation (const SCH_SHEET_PATH *aSheetPath)
 Clear exiting symbol 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
 Return 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 (MANDATORY_FIELD_T aFieldType)
 Return a mandatory field in this symbol. More...
 
const SCH_FIELDGetField (MANDATORY_FIELD_T aFieldNdx) const
 
SCH_FIELDGetFieldById (int aFieldId)
 Return a field in this symbol. More...
 
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)
 Populate a std::vector with SCH_FIELDs. More...
 
std::vector< SCH_FIELD > & GetFields ()
 Return a vector of fields from the symbol. More...
 
const std::vector< SCH_FIELD > & GetFields () const
 
SCH_FIELDAddField (const SCH_FIELD &aField)
 Add a field to the symbol. More...
 
void RemoveField (const wxString &aFieldName)
 Remove 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 (const SCH_SHEET_PATH *aPath, bool aUpdateStyle, bool aUpdateRef, bool aUpdateOtherFields, bool aResetRef, bool aResetOtherFields)
 Restore 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 symbol. More...
 
void RunOnChildren (const std::function< void(SCH_ITEM *)> &aFunction) override
 
SCH_PINGetPin (const wxString &number) const
 Find a symbol pin by number. More...
 
void GetLibPins (std::vector< LIB_PIN * > &aPinsList) const
 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
 Retrieve a list of the SCH_PINs for the given sheet path. More...
 
std::vector< std::unique_ptr< SCH_PIN > > & GetRawPins ()
 
void Print (const RENDER_SETTINGS *aSettings, const wxPoint &aOffset) override
 Print a symbol. 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)
 Check if the symbol 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
 Return the instance-specific unit selection for the given sheet path. More...
 
void SetUnitSelection (const SCH_SHEET_PATH *aSheet, int aUnitSelection)
 Set the selected unit of this symbol on one sheet. More...
 
void SetUnitSelection (int aUnitSelection)
 Set the selected unit of this symbol for all sheets. More...
 
const wxString GetValue (const SCH_SHEET_PATH *sheet, bool aResolve) const
 Return the instance-specific value for the given sheet path. More...
 
void SetValue (const SCH_SHEET_PATH *sheet, const wxString &aValue)
 
void SetValue (const wxString &aValue)
 Set the value for all instances (the default GUI behavior). More...
 
const wxString GetFootprint (const SCH_SHEET_PATH *sheet, bool aResolve) const
 Return the instance-specific footprint assignment for the given sheet path. More...
 
void SetFootprint (const SCH_SHEET_PATH *sheet, const wxString &aFootprint)
 
void SetFootprint (const wxString &aFootprint)
 Set the value for all instances (the default GUI behavior). More...
 
void Move (const wxPoint &aMoveVector) override
 Move the item by aMoveVector to a new position. More...
 
void MirrorHorizontally (int aCenter) override
 Mirror item horizontally about aCenter. More...
 
void MirrorVertically (int aCenter) override
 Mirror item vertically about aCenter. More...
 
void Rotate (wxPoint aCenter) override
 Rotate the item around aCenter 90 degrees in the clockwise direction. More...
 
bool Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const override
 Compare 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 symbol'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< wxPoint > GetConnectionPoints () 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
 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 symbol library item at aPosition that is part of this symbol. More...
 
wxString GetSelectMenuText (EDA_UNITS aUnits) const override
 Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAPS GetMenuImage () const override
 Return a pointer to an image to be used in menus. More...
 
bool operator< (const SCH_ITEM &aItem) const override
 
bool operator== (const SCH_COMPONENT &aSymbol) const
 
bool operator!= (const SCH_COMPONENT &aSymbol) const
 
SCH_COMPONENToperator= (const SCH_ITEM &aItem)
 
bool IsReplaceable () const override
 Override this method in any derived object that supports test find and replace. More...
 
wxPoint GetPosition () const override
 
void SetPosition (const wxPoint &aPosition) override
 
bool HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
 Test 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
 Test if aRect intersects or is contained within the bounding box of an item. More...
 
void Plot (PLOTTER *aPlotter) const override
 Plot the schematic item to aPlotter. More...
 
EDA_ITEMClone () const override
 Create 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)
 
bool IsPointClickableAnchor (const wxPoint &aPos) const override
 
SCH_ITEMDuplicate (bool doClone=false) const
 Routine to create a new copy of given item. More...
 
wxPoint & GetStoredPos ()
 
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...
 
virtual bool IsHypertext () const
 Allow items to support hypertext actions when hovered/clicked. More...
 
virtual void DoHypertextMenu (EDA_DRAW_FRAME *aFrame)
 
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 *aSheet=nullptr) const
 Retrieve the connection associated with this object in the given sheet. More...
 
SCH_ITEM_SETConnectedItems (const SCH_SHEET_PATH &aPath)
 Retrieve the set of items connected to this item on the given sheet. More...
 
void AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
 Add a connection link between this item and another. More...
 
SCH_CONNECTIONInitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
 Create a new connection object associated with this object. More...
 
virtual bool ConnectionPropagatesTo (const EDA_ITEM *aItem) const
 Return true if this item should propagate connection info to aItem. More...
 
bool IsConnectivityDirty ()
 
void SetConnectivityDirty (bool aDirty=true)
 
NETCLASSPTR NetClass (const SCH_SHEET_PATH *aSheet=nullptr) const
 
FIELDS_AUTOPLACED GetFieldsAutoplaced () const
 Return whether the fields have been automatically placed. More...
 
void SetFieldsAutoplaced ()
 
void ClearFieldsAutoplaced ()
 
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
 Returns the type of object. 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 IsEntered () 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, bool 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) const
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[]) const
 Check whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Set and clear 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
 Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
 
virtual bool Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
 Perform 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
 Return the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Draw the parts of the object belonging to layer aLayer. More...
 
virtual double ViewGetLOD (int aLayer, VIEW *aView) const
 Return 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)
 Test 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[])
 This changes first parameter to avoid the DList and use the main queue instead. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Change first parameter to avoid the DList and use std::vector instead. More...
 
static bool Replace (const wxFindReplaceData &aSearchData, wxString &aText)
 Perform 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)
 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, const wxFindReplaceData &aSearchData) const
 Compare 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
 Store pointers to other items that are connected to this one, per sheet. More...
 
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
 Store connectivity information, per sheet. More...
 
bool m_connectivity_dirty
 
STATUS_FLAGS m_status
 
EDA_ITEMm_parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
STATUS_FLAGS m_flags
 

Private Member Functions

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

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 symbols. More...
 
int m_convert
 The alternate body style for symbols 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 symbol 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 symbol 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< SYMBOL_INSTANCE_REFERENCEm_instanceReferences
 

Detailed Description

Schematic symbol object.

Definition at line 78 of file sch_symbol.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 95 of file sch_symbol.cpp.

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

References Init().

Referenced by Clone().

◆ SCH_COMPONENT() [2/4]

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

Create schematic symbol from library symbol object.

Parameters
aPartis the library part to create schematic symbol from.
aLibIdis the LIB_ID of alias to create.
aSheetis the schematic sheet the symbol is place into.
unitis unit for symbols that have multiple parts per package.
convertis the alternate body style for the schematic symbols.
posis the position of the symbol.
setNewItemFlagis used to set the symbol IS_NEW and IS_MOVED flags.

Definition at line 102 of file sch_symbol.cpp.

104  :
106 {
107  Init( pos );
108 
109  m_unit = unit;
110  m_convert = convert;
111  m_lib_id = aLibId;
112 
113  std::unique_ptr< LIB_PART > part;
114 
115  part = aPart.Flatten();
116  part->SetParent();
117  SetLibSymbol( part.release() );
118 
119  // Copy fields from the library symbol
120  UpdateFields( aSheet,
121  true, /* update style */
122  false, /* update ref */
123  false, /* update other fields */
124  true, /* reset ref */
125  true /* reset other fields */ );
126 
127  // Update the reference -- just the prefix for now.
128  if( aSheet )
129  SetRef( aSheet, m_part->GetReferenceField().GetText() + wxT( "?" ) );
130  else
131  m_prefix = m_part->GetReferenceField().GetText() + wxT( "?" );
132 
133  // Inherit the include in bill of materials and board netlist settings from library symbol.
134  m_inBom = aPart.GetIncludeInBom();
135  m_onBoard = aPart.GetIncludeOnBoard();
136 }
void SetLibSymbol(LIB_PART *aLibSymbol)
Set this schematic symbol library symbol reference to aLibSymbol.
Definition: sch_symbol.cpp:248
bool m_onBoard
True to include in netlist when updating board.
Definition: sch_symbol.h:702
#define NULL
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695
std::unique_ptr< LIB_PART > Flatten() const
Return a flattened symbol inheritance to the caller.
Definition: lib_symbol.cpp:334
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:674
void Init(const wxPoint &pos=wxPoint(0, 0))
Definition: sch_symbol.cpp:185
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
Definition: sch_symbol.cpp:482
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_symbol.h:673
bool GetIncludeOnBoard() const
Definition: lib_symbol.h:589
bool m_inBom
True to include in bill of materials export.
Definition: sch_symbol.h:701
void UpdateFields(const SCH_SHEET_PATH *aPath, bool aUpdateStyle, bool aUpdateRef, bool aUpdateOtherFields, bool aResetRef, bool aResetOtherFields)
Restore fields to the original library values.
Definition: sch_symbol.cpp:775
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:675
bool GetIncludeInBom() const
Definition: lib_symbol.h:581
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the symbol is.
Definition: sch_symbol.h:678
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:47

References convert, 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 ( const LIB_PART aPart,
const SCH_SHEET_PATH aSheet,
const PICKED_SYMBOL aSel,
const wxPoint &  pos = wxPoint( 0, 0 ) 
)

Definition at line 139 of file sch_symbol.cpp.

140  :
141  SCH_COMPONENT( aPart, aSel.LibId, aSheet, aSel.Unit, aSel.Convert, pos )
142 {
143  // Set any fields that were modified as part of the symbol selection
144  for( const std::pair<int, wxString>& i : aSel.Fields )
145  {
146  SCH_FIELD* field = GetFieldById( i.first );
147 
148  if( field )
149  field->SetText( i.second );
150  }
151 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:121
SCH_COMPONENT(const wxPoint &pos=wxPoint(0, 0), SCH_ITEM *aParent=NULL)
Definition: sch_symbol.cpp:95
SCH_FIELD * GetFieldById(int aFieldId)
Return a field in this symbol.
Definition: sch_symbol.cpp:705
LIB_ID LibId
Definition: sch_screen.h:83
std::vector< std::pair< int, wxString > > Fields
Definition: sch_screen.h:87

References PICKED_SYMBOL::Fields, GetFieldById(), and EDA_TEXT::SetText().

◆ SCH_COMPONENT() [4/4]

SCH_COMPONENT::SCH_COMPONENT ( const SCH_COMPONENT aSymbol)

Clone aSymbol 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
aSymbolis the schematic symbol to clone.

Definition at line 154 of file sch_symbol.cpp.

154  :
155  SCH_ITEM( aSymbol )
156 {
157  m_parent = aSymbol.m_parent;
158  m_pos = aSymbol.m_pos;
159  m_unit = aSymbol.m_unit;
160  m_convert = aSymbol.m_convert;
161  m_lib_id = aSymbol.m_lib_id;
162  m_isInNetlist = aSymbol.m_isInNetlist;
163  m_inBom = aSymbol.m_inBom;
164  m_onBoard = aSymbol.m_onBoard;
165 
166  if( aSymbol.m_part )
167  SetLibSymbol( new LIB_PART( *aSymbol.m_part.get() ) );
168 
169  const_cast<KIID&>( m_Uuid ) = aSymbol.m_Uuid;
170 
171  m_transform = aSymbol.m_transform;
172  m_prefix = aSymbol.m_prefix;
174  m_fields = aSymbol.m_fields;
175 
176  // Re-parent the fields, which before this had aSymbol as parent
177  for( SCH_FIELD& field : m_fields )
178  field.SetParent( this );
179 
182 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:529
void SetLibSymbol(LIB_PART *aLibSymbol)
Set this schematic symbol library symbol reference to aLibSymbol.
Definition: sch_symbol.cpp:248
bool m_onBoard
True to include in netlist when updating board.
Definition: sch_symbol.h:702
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:498
wxPoint m_pos
Definition: sch_symbol.h:672
wxString m_schLibSymbolName
The name used to look up a symbol in the symbol library embedded in a schematic.
Definition: sch_symbol.h:690
bool m_isInNetlist
True if the symbol should appear in the netlist.
Definition: sch_symbol.h:700
Define a library symbol object.
Definition: lib_symbol.h:93
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695
const KIID m_Uuid
Definition: eda_item.h:525
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:674
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_symbol.h:673
bool m_inBom
True to include in bill of materials export.
Definition: sch_symbol.h:701
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:706
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:675
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the symbol is.
Definition: sch_symbol.h:678
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:692
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:47

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_schLibSymbolName, m_transform, m_unit, EDA_ITEM::m_Uuid, and SetLibSymbol().

◆ ~SCH_COMPONENT()

SCH_COMPONENT::~SCH_COMPONENT ( )
inline

Definition at line 111 of file sch_symbol.h.

111 { }

Member Function Documentation

◆ AddConnectionTo()

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

Add a connection link between this item and another.

Definition at line 170 of file sch_item.cpp.

171 {
172  m_connected_items[ aSheet ].insert( aItem );
173 }
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SET > m_connected_items
Store pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:503

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 739 of file sch_symbol.cpp.

740 {
741  int newNdx = m_fields.size();
742 
743  m_fields.push_back( aField );
744  return &m_fields[newNdx];
745 }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References m_fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), 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/&ltsymbol 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 instances).

Definition at line 391 of file sch_symbol.cpp.

394 {
395  // Search for an existing path and remove it if found (should not occur)
396  for( unsigned ii = 0; ii < m_instanceReferences.size(); ii++ )
397  {
398  if( m_instanceReferences[ii].m_Path == aPath )
399  {
400  wxLogTrace( traceSchSheetPaths, "Removing symbol instance:\n"
401  " sheet path %s\n"
402  " reference %s, unit %d from symbol %s.",
403  aPath.AsString(),
404  m_instanceReferences[ii].m_Reference,
405  m_instanceReferences[ii].m_Unit,
406  m_Uuid.AsString() );
407 
408  m_instanceReferences.erase( m_instanceReferences.begin() + ii );
409  ii--;
410  }
411  }
412 
413  SYMBOL_INSTANCE_REFERENCE instance;
414  instance.m_Path = aPath;
415  instance.m_Reference = aRef;
416  instance.m_Unit = aUnit;
417  instance.m_Value = aValue;
418  instance.m_Footprint = aFootprint;
419 
420  wxLogTrace( traceSchSheetPaths, "Adding symbol instance:\n"
421  " sheet path %s\n"
422  " reference %s, unit %d to symbol %s.",
423  aPath.AsString(),
424  aRef,
425  aUnit,
426  m_Uuid.AsString() );
427 
428  m_instanceReferences.push_back( instance );
429 }
const wxChar *const traceSchSheetPaths
Flag to enable debug output of schematic symbol sheet path manipulation code.
wxString AsString() const
Definition: kiid.cpp:218
A simple container for schematic symbol instance information.
const KIID m_Uuid
Definition: eda_item.h:525
wxString AsString() const
Definition: kiid.cpp:256
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:706

References KIID::AsString(), KIID_PATH::AsString(), SYMBOL_INSTANCE_REFERENCE::m_Footprint, m_instanceReferences, SYMBOL_INSTANCE_REFERENCE::m_Path, SYMBOL_INSTANCE_REFERENCE::m_Reference, SYMBOL_INSTANCE_REFERENCE::m_Unit, EDA_ITEM::m_Uuid, SYMBOL_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 symbol 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 of the sheet containing the symbol not the full symbol sheet path.
Returns
false if the alternate reference was existing, true if added.

Definition at line 1079 of file sch_symbol.cpp.

1080 {
1081  // a empty sheet path is illegal:
1082  wxCHECK( aSheetPath.size() > 0, false );
1083 
1084  wxString reference_path;
1085 
1086  for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
1087  {
1088  // if aSheetPath is found, nothing to do:
1089  if( instance.m_Path == aSheetPath )
1090  return false;
1091  }
1092 
1093  // This entry does not exist: add it, with its last-used reference
1094  AddHierarchicalReference( aSheetPath, m_fields[REFERENCE_FIELD].GetText(), m_unit );
1095  return true;
1096 }
Field Reference of part, i.e. "IC21".
A simple container for schematic symbol instance information.
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:674
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:706
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.
Definition: sch_symbol.cpp:391
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References AddHierarchicalReference(), m_fields, m_instanceReferences, m_unit, and REFERENCE_FIELD.

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 symbol.

Definition at line 445 of file sch_item.h.

446  {
447  if( GetFieldsAutoplaced() )
449  }
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition: sch_item.h:433
virtual void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Definition: sch_item.h:451

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 symbol.

Parameters
aScreenis the SCH_SCREEN associated with the current instance of the symbol. 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 678 of file autoplace_fields.cpp.

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

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

Referenced by SCH_DRAWING_TOOLS::PlaceSymbol().

◆ CanConnect()

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

Reimplemented from SCH_ITEM.

Definition at line 599 of file sch_symbol.h.

600  {
601  return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
602  ( aItem->Type() == SCH_NO_CONNECT_T ) ||
603  ( aItem->Type() == SCH_JUNCTION_T ) ||
604  ( aItem->Type() == SCH_COMPONENT_T ) ||
605  ( aItem->Type() == SCH_LABEL_T ) ||
606  ( aItem->Type() == SCH_HIER_LABEL_T ) ||
607  ( aItem->Type() == SCH_GLOBAL_LABEL_T );
608  }
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

References SCH_ITEM::GetLayer(), LAYER_WIRE, SCH_COMPONENT_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_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 113 of file sch_symbol.h.

114  {
115  return aItem && SCH_COMPONENT_T == aItem->Type();
116  }
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

References SCH_COMPONENT_T, and EDA_ITEM::Type().

◆ ClearAnnotation()

void SCH_COMPONENT::ClearAnnotation ( const SCH_SHEET_PATH aSheetPath)

Clear exiting symbol 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 1036 of file sch_symbol.cpp.

1037 {
1038  // Build a reference with no annotation,
1039  // i.e. a reference ended by only one '?'
1040  wxString defRef = m_prefix;
1041 
1042  if( !IsReferenceStringValid( defRef ) )
1043  { // This is a malformed reference: reinit this reference
1044  m_prefix = defRef = wxT("U"); // Set to default ref prefix
1045  }
1046 
1047  while( defRef.Last() == '?' )
1048  defRef.RemoveLast();
1049 
1050  defRef.Append( wxT( "?" ) );
1051 
1052  if( aSheetPath )
1053  {
1054  KIID_PATH path = aSheetPath->Path();
1055 
1057  {
1058  if( instance.m_Path == path )
1059  instance.m_Reference = defRef;
1060  }
1061  }
1062  else
1063  {
1065  instance.m_Reference = defRef;
1066  }
1067 
1068  for( std::unique_ptr<SCH_PIN>& pin : m_pins )
1069  pin->ClearDefaultNetName( aSheetPath );
1070 
1071  // These 2 changes do not work in complex hierarchy.
1072  // When a clear annotation is made, the calling function must call a
1073  // UpdateAllScreenReferences for the active sheet.
1074  // But this call cannot made here.
1075  m_fields[REFERENCE_FIELD].SetText( defRef ); //for drawing.
1076 }
Field Reference of part, i.e. "IC21".
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
A simple container for schematic symbol instance information.
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:706
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:697
static bool IsReferenceStringValid(const wxString &aReferenceString)
Test for an acceptable reference string.
Definition: sch_symbol.cpp:466
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the symbol is.
Definition: sch_symbol.h:678
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References IsReferenceStringValid(), m_fields, m_instanceReferences, m_pins, m_prefix, SCH_SHEET_PATH::Path(), path, pin, and REFERENCE_FIELD.

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 1901 of file sch_symbol.cpp.

1902 {
1903  for( auto& pin : m_pins )
1904  pin->ClearBrightened();
1905 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:697

References m_pins, and pin.

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 385 of file sch_item.h.

385 { m_connections.clear(); }
EDA_ITEMS m_connections
Definition: sch_item.h:497

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )
inlineinherited

◆ ClearFlags()

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

Definition at line 204 of file eda_item.h.

204 { m_flags &= ~aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 216 of file eda_item.h.

217  {
219  DO_NOT_DRAW );
220  }
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: eda_item.h:115
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: eda_item.h:104
#define CANDIDATE
flag indicating that the structure is connected
Definition: eda_item.h:117
#define DO_NOT_DRAW
Used to disable draw function.
Definition: eda_item.h:119
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: eda_item.h:112
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:204
#define ENDPOINT
ends. (Used to support dragging.)
Definition: eda_item.h:113
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: eda_item.h:118

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 148 of file view_item.h.

149  {
150  m_viewPrivData = nullptr;
151  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:156

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * SCH_COMPONENT::Clone ( ) const
overridevirtual

Create 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 214 of file sch_symbol.cpp.

215 {
216  return new SCH_COMPONENT( *this );
217 }
SCH_COMPONENT(const wxPoint &pos=wxPoint(0, 0), SCH_ITEM *aParent=NULL)
Definition: sch_symbol.cpp:95

References SCH_COMPONENT().

◆ ConnectedItems()

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

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

Definition at line 164 of file sch_item.cpp.

165 {
166  return m_connected_items[ aSheet ];
167 }
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SET > m_connected_items
Store pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:503

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), CONNECTION_GRAPH::updateItemConnectivity(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ Connection()

SCH_CONNECTION * SCH_ITEM::Connection ( const SCH_SHEET_PATH aSheet = nullptr) const
inherited

Retrieve the connection associated with this object in the given sheet.

Note
The returned value can be nullptr.

Definition at line 131 of file sch_item.cpp.

132 {
133  if( !aSheet )
134  aSheet = &Schematic()->CurrentSheet();
135 
136  auto it = m_connection_map.find( *aSheet );
137 
138  if( it == m_connection_map.end() )
139  return nullptr;
140  else
141  return it->second;
142 }
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Store connectivity information, per sheet.
Definition: sch_item.h:506
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:119

References SCHEMATIC::CurrentSheet(), SCH_ITEM::m_connection_map, and SCH_ITEM::Schematic().

Referenced by CONNECTION_SUBGRAPH::Absorb(), CONNECTION_SUBGRAPH::AddItem(), CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_ITEM::NetClass(), SCH_EDIT_FRAME::OnModify(), SCH_TEXT::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), CONNECTION_SUBGRAPH::ResolveDrivers(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), BUS_UNFOLD_MENU::update(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ ConnectionPropagatesTo()

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

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

Reimplemented in SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 422 of file sch_item.h.

422 { return true; }

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

◆ DoHypertextMenu()

virtual void SCH_ITEM::DoHypertextMenu ( EDA_DRAW_FRAME aFrame)
inlinevirtualinherited

Reimplemented in SCH_FIELD.

Definition at line 267 of file sch_item.h.

267 { }

◆ 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
aPositionis a reference to a wxPoint object containing the test position.
Returns
True if connection to aPosition exists.

Reimplemented from SCH_ITEM.

Definition at line 1838 of file sch_symbol.cpp.

1839 {
1840  wxPoint new_pos = m_transform.InverseTransform().TransformCoordinate( aPosition - m_pos );
1841 
1842  for( const auto& pin : m_pins )
1843  {
1844  if( pin->GetType() == ELECTRICAL_PINTYPE::PT_NC )
1845  continue;
1846 
1847  // Collect only pins attached to the current unit and convert.
1848  // others are not associated to this symbol instance
1849  int pin_unit = pin->GetLibPin()->GetUnit();
1850  int pin_convert = pin->GetLibPin()->GetConvert();
1851 
1852  if( pin_unit > 0 && pin_unit != GetUnit() )
1853  continue;
1854 
1855  if( pin_convert > 0 && pin_convert != GetConvert() )
1856  continue;
1857 
1858  if( pin->GetLocalPosition() == new_pos )
1859  return true;
1860  }
1861 
1862  return false;
1863 }
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
Definition: sch_symbol.h:195
wxPoint m_pos
Definition: sch_symbol.h:672
int GetConvert() const
Definition: sch_symbol.h:223
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:697
not connected (must be left open)
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:692

References GetConvert(), GetUnit(), TRANSFORM::InverseTransform(), m_pins, m_pos, m_transform, pin, PT_NC, 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 78 of file sch_item.cpp.

79 {
80  SCH_ITEM* newItem = (SCH_ITEM*) Clone();
81 
82  if( !doClone )
83  const_cast<KIID&>( newItem->m_Uuid ) = KIID();
84 
85  newItem->ClearFlags( SELECTED | BRIGHTENED );
86 
87  newItem->RunOnChildren(
88  []( SCH_ITEM* aChild )
89  {
90  aChild->ClearFlags( SELECTED | BRIGHTENED );
91  } );
92 
93  return newItem;
94 }
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:81
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction)
Definition: sch_item.h:453
Definition: kiid.h:44
#define BRIGHTENED
item is drawn with a bright contour
Definition: eda_item.h:131
#define SELECTED
Definition: eda_item.h:114
const KIID m_Uuid
Definition: eda_item.h:525
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:204
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197

References BRIGHTENED, EDA_ITEM::ClearFlags(), EDA_ITEM::Clone(), EDA_ITEM::m_Uuid, SCH_ITEM::RunOnChildren(), and SELECTED.

Referenced by SCH_EDIT_TOOL::Duplicate(), CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_DRAWING_TOOLS::PlaceSymbol(), 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 761 of file sch_symbol.cpp.

762 {
763  unsigned start = aIncludeDefaultFields ? 0 : MANDATORY_FIELDS;
764 
765  for( unsigned i = start; i < m_fields.size(); ++i )
766  {
767  if( aFieldName == m_fields[i].GetName( false ) )
768  return &m_fields[i];
769  }
770 
771  return NULL;
772 }
#define NULL
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References m_fields, MANDATORY_FIELDS, and NULL.

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

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 86 of file inspectable.h.

87  {
89  TYPE_ID thisType = TYPE_HASH( *this );
90  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
91  return object ? aProperty->getter( object ) : wxAny();
92  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
virtual wxAny getter(void *aObject) const =0
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
virtual size_t OwnerHash() const =0
Return 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 95 of file inspectable.h.

96  {
98  TYPE_ID thisType = TYPE_HASH( *this );
99  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
100  return object ? aProperty->get<T>( object ) : T();
101  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
T get(void *aObject)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Return 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 104 of file inspectable.h.

105  {
107  TYPE_ID thisType = TYPE_HASH( *this );
108  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
109  boost::optional<T> ret;
110 
111  if( prop )
112  {
113  void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
114 
115  if( object )
116  ret = prop->get<T>( object );
117  }
118 
119  return ret;
120  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
T get(void *aObject)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Return 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 1323 of file sch_symbol.cpp.

1324 {
1325  EDA_RECT bBox;
1326 
1327  if( m_part )
1328  bBox = m_part->GetBodyBoundingBox( m_unit, m_convert );
1329  else
1330  bBox = dummy()->GetBodyBoundingBox( m_unit, m_convert );
1331 
1332  int x0 = bBox.GetX();
1333  int xm = bBox.GetRight();
1334 
1335  // We must reverse Y values, because matrix orientation
1336  // suppose Y axis normal for the library items coordinates,
1337  // m_transform reverse Y values, but bBox is already reversed!
1338  int y0 = -bBox.GetY();
1339  int ym = -bBox.GetBottom();
1340 
1341  // Compute the real Boundary box (rotated, mirrored ...)
1342  int x1 = m_transform.x1 * x0 + m_transform.y1 * y0;
1343  int y1 = m_transform.x2 * x0 + m_transform.y2 * y0;
1344  int x2 = m_transform.x1 * xm + m_transform.y1 * ym;
1345  int y2 = m_transform.x2 * xm + m_transform.y2 * ym;
1346 
1347  bBox.SetX( x1 );
1348  bBox.SetY( y1 );
1349  bBox.SetWidth( x2 - x1 );
1350  bBox.SetHeight( y2 - y1 );
1351  bBox.Normalize();
1352 
1353  bBox.Offset( m_pos );
1354  return bBox;
1355 }
void Offset(int dx, int dy)
Definition: eda_rect.h:152
int y2
Definition: transform.h:51
int GetX() const
Definition: eda_rect.h:103
int x2
Definition: transform.h:50
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
Definition: sch_symbol.cpp:69
int x1
Definition: transform.h:48
int GetBottom() const
Definition: eda_rect.h:119
int y1
Definition: transform.h:49
wxPoint m_pos
Definition: sch_symbol.h:672
void SetHeight(int val)
Definition: eda_rect.h:181
int GetRight() const
Definition: eda_rect.h:116
void SetX(int val)
Definition: eda_rect.h:163
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695
void SetWidth(int val)
Definition: eda_rect.h:175
void SetY(int val)
Definition: eda_rect.h:169
void Normalize()
Ensures that the height ant width are positive.
Definition: eda_rect.cpp:35
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:674
Handle the component boundary box.
Definition: eda_rect.h:42
int GetY() const
Definition: eda_rect.h:104
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:675
const EDA_RECT GetBodyBoundingBox(int aUnit, int aConvert) const
Get the symbol bounding box excluding fields.
Definition: lib_symbol.cpp:849
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:692

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(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), and operator<().

◆ GetBoundingBox() [1/2]

const EDA_RECT SCH_COMPONENT::GetBoundingBox ( ) const
overridevirtual

Return 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 1358 of file sch_symbol.cpp.

1359 {
1360  EDA_RECT bbox = GetBodyBoundingBox();
1361 
1362  for( const SCH_FIELD& field : m_fields )
1363  bbox.Merge( field.GetBoundingBox() );
1364 
1365  return bbox;
1366 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
void Merge(const EDA_RECT &aRect)
Modify the position and size of the rectangle in order to contain aRect.
Definition: eda_rect.cpp:431
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
Handle the component boundary box.
Definition: eda_rect.h:42
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

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

Referenced by SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDIT_FRAME::GetDocumentExtents(), and AUTOPLACER::getPossibleCollisions().

◆ GetBoundingBox() [2/2]

const EDA_RECT SCH_COMPONENT::GetBoundingBox ( bool  aIncludeInvisibleText) const

Definition at line 1369 of file sch_symbol.cpp.

1370 {
1371  EDA_RECT bbox = GetBodyBoundingBox();
1372 
1373  for( const SCH_FIELD& field : m_fields )
1374  {
1375  if( field.IsVisible() || aIncludeInvisibleText )
1376  bbox.Merge( field.GetBoundingBox() );
1377  }
1378 
1379  return bbox;
1380 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
void Merge(const EDA_RECT &aRect)
Modify the position and size of the rectangle in order to contain aRect.
Definition: eda_rect.cpp:431
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
Handle the component boundary box.
Definition: eda_rect.h:42
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

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

◆ GetClass()

wxString SCH_COMPONENT::GetClass ( ) const
inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 118 of file sch_symbol.h.

119  {
120  return wxT( "SCH_COMPONENT" );
121  }

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
aPointsis the list of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 1610 of file sch_symbol.cpp.

1611 {
1612  std::vector<wxPoint> retval;
1613 
1614  for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
1615  {
1616  // Collect only pins attached to the current unit and convert.
1617  // others are not associated to this symbol instance
1618  int pin_unit = pin->GetLibPin()->GetUnit();
1619  int pin_convert = pin->GetLibPin()->GetConvert();
1620 
1621  if( pin_unit > 0 && pin_unit != GetUnit() )
1622  continue;
1623 
1624  if( pin_convert > 0 && pin_convert != GetConvert() )
1625  continue;
1626 
1627  retval.push_back( m_transform.TransformCoordinate( pin->GetLocalPosition() ) + m_pos );
1628  }
1629 
1630  return retval;
1631 }
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
int GetUnit() const
Definition: sch_symbol.h:195
wxPoint m_pos
Definition: sch_symbol.h:672
int GetConvert() const
Definition: sch_symbol.h:223
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:697
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:692

References GetConvert(), GetUnit(), m_pins, m_pos, m_transform, pin, 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 946 of file sch_symbol.cpp.

947 {
948  for( int i = 0; i < MANDATORY_FIELDS; ++i )
949  aVars->push_back( m_fields[i].GetCanonicalName().Upper() );
950 
951  for( size_t i = MANDATORY_FIELDS; i < m_fields.size(); ++i )
952  aVars->push_back( m_fields[i].GetName() );
953 
954  aVars->push_back( wxT( "FOOTPRINT_LIBRARY" ) );
955  aVars->push_back( wxT( "FOOTPRINT_NAME" ) );
956  aVars->push_back( wxT( "UNIT" ) );
957 }
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

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 266 of file sch_symbol.cpp.

267 {
268  if( m_part )
269  return m_part->GetDatasheetField().GetText();
270 
271  return wxEmptyString;
272 }
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695

References m_part.

Referenced by UpdateFields().

◆ GetDescription()

wxString SCH_COMPONENT::GetDescription ( ) const

Return information about the aliased parts.

Definition at line 257 of file sch_symbol.cpp.

258 {
259  if( m_part )
260  return m_part->GetDescription();
261 
262  return wxEmptyString;
263 }
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695

References m_part.

Referenced by NETLIST_EXPORTER_XML::makeSymbols().

◆ GetDrawItem()

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

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

Parameters
aPositionis the schematic position of the symbol 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 1634 of file sch_symbol.cpp.

1635 {
1636  if( m_part )
1637  {
1638  // Calculate the position relative to the symbol.
1639  wxPoint libPosition = aPosition - m_pos;
1640 
1641  return m_part->LocateDrawItem( m_unit, m_convert, aType, libPosition, m_transform );
1642  }
1643 
1644  return NULL;
1645 }
wxPoint m_pos
Definition: sch_symbol.h:672
#define NULL
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:674
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:675
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:692

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 208 of file eda_item.h.

209  {
210  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
212 
213  return m_flags & mask;
214  }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:108
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:116
#define IS_MOVED
Item being moved.
Definition: eda_item.h:106
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:109
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
Definition: eda_item.h:120
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:111
STATUS_FLAGS m_flags
Definition: eda_item.h:531
#define IS_NEW
New item, just created.
Definition: eda_item.h:107

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

Referenced by EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_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_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ 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
aItemListis the list of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 1535 of file sch_symbol.cpp.

1536 {
1537  for( auto& pin : m_pins )
1538  {
1539  LIB_PIN* lib_pin = pin->GetLibPin();
1540 
1541  if( lib_pin->GetUnit() && m_unit && ( m_unit != lib_pin->GetUnit() ) )
1542  continue;
1543 
1544  DANGLING_END_ITEM item( PIN_END, lib_pin, GetPinPhysicalPosition( lib_pin ), this );
1545  aItemList.push_back( item );
1546  }
1547 }
int GetUnit() const
Definition: lib_item.h:260
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:674
Helper class used to store the state of schematic items that can be connected to other schematic item...
Definition: sch_item.h:87
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:697
wxPoint GetPinPhysicalPosition(const LIB_PIN *Pin) const

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

◆ GetField() [1/2]

◆ GetField() [2/2]

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

Definition at line 699 of file sch_symbol.cpp.

700 {
701  return &m_fields[aFieldType];
702 }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References m_fields.

◆ GetFieldById()

SCH_FIELD * SCH_COMPONENT::GetFieldById ( int  aFieldId)

Return a field in this symbol.

Parameters
aFieldIdis the id of the field requested. Note that this id ONLY SOMETIMES equates to the field's position in the vector.
Returns
is the field at aFieldType or NULL if the field does not exist.

Definition at line 705 of file sch_symbol.cpp.

706 {
707  for( size_t ii = 0; ii < m_fields.size(); ++ii )
708  {
709  if( m_fields[ii].GetId() == aFieldId )
710  return &m_fields[ii];
711  }
712 
713  return nullptr;
714 }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References m_fields.

Referenced by SCH_COMPONENT(), and UpdateFields().

◆ GetFieldCount()

◆ GetFields() [1/3]

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

Populate 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 729 of file sch_symbol.cpp.

730 {
731  for( SCH_FIELD& field : m_fields )
732  {
733  if( !aVisibleOnly || ( field.IsVisible() && !field.IsVoid() ) )
734  aVector.push_back( &field );
735  }
736 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References m_fields.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), AUTOPLACER::AUTOPLACER(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), DIALOG_FIELDS_EDITOR_GLOBAL::LoadFieldNames(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDITOR_CONTROL::nextMatch(), operator==(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_LEGACY_PLUGIN::saveComponent(), SCH_SEXPR_PLUGIN::saveSymbol(), EE_SELECTION_TOOL::selectMultiple(), ERC_TESTER::TestTextVars(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_CHANGE_SYMBOLS::updateFieldsList(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetFields() [2/3]

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

Return a vector of fields from the symbol.

Definition at line 366 of file sch_symbol.h.

366 { return m_fields; }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References m_fields.

Referenced by operator==().

◆ GetFields() [3/3]

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

Definition at line 367 of file sch_symbol.h.

367 { return m_fields; }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References m_fields.

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const
inlineinherited

Return whether the fields have been automatically placed.

Definition at line 433 of file sch_item.h.

433 { return m_fieldsAutoplaced; }
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:498

References SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_ITEM::AutoAutoplaceFields(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), and EE_POINT_EDITOR::updateParentItem().

◆ 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 717 of file sch_symbol.cpp.

718 {
719  for( const SCH_FIELD& field : m_fields )
720  {
721  if( aFieldName == field.GetName() || aFieldName == field.GetCanonicalName() )
722  return field.GetText();
723  }
724 
725  return wxEmptyString;
726 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References m_fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn().

◆ GetFlags()

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

Similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and TRACK.

Definition at line 309 of file eda_item.h.

309 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: eda_item.h:302

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,
bool  aResolve 
) const

Return the instance-specific footprint assignment for the given sheet path.

Definition at line 643 of file sch_symbol.cpp.

644 {
645  KIID_PATH path = sheet->Path();
646 
647  for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
648  {
649  if( instance.m_Path == path && !instance.m_Footprint.IsEmpty() )
650  {
651  // This can only be an override from an Update Schematic from PCB, and therefore
652  // will always be fully resolved.
653  return instance.m_Footprint;
654  }
655  }
656 
657  if( !aResolve )
658  return GetField( FOOTPRINT_FIELD )->GetText();
659 
661 }
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:693
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_field.cpp:105
A simple container for schematic symbol instance information.
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:706
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133
Field Name Module PCB, i.e. "16DIP300".

References FOOTPRINT_FIELD, GetField(), SCH_FIELD::GetShownText(), EDA_TEXT::GetText(), m_instanceReferences, SCH_SHEET_PATH::Path(), and path.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), GetMsgPanelInfo(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET_PATH::UpdateAllScreenReferences(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ GetIncludeInBom()

bool SCH_COMPONENT::GetIncludeInBom ( ) const
inline

Definition at line 659 of file sch_symbol.h.

659 { return m_inBom; }
bool m_inBom
True to include in bill of materials export.
Definition: sch_symbol.h:701

References m_inBom.

Referenced by NETLIST_EXPORTER_XML::makeListOfNets(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_SEXPR_PLUGIN::saveSymbol(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetIncludeOnBoard()

bool SCH_COMPONENT::GetIncludeOnBoard ( ) const
inline

◆ GetInstanceReferences()

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

Definition at line 123 of file sch_symbol.h.

124  {
125  return m_instanceReferences;
126  }
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:706

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) const

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 870 of file sch_symbol.cpp.

871 {
872  if( m_part )
873  m_part->GetPins( aPinsList, m_unit, m_convert );
874 }
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:674
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:675

References m_convert, m_part, and m_unit.

◆ GetMenuImage()

BITMAPS SCH_COMPONENT::GetMenuImage ( ) const
overridevirtual

Return 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 1465 of file sch_symbol.cpp.

1466 {
1467  return BITMAPS::add_component;
1468 }

References add_component.

◆ GetMsgPanelInfo()

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

Populate 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 1383 of file sch_symbol.cpp.

1384 {
1385  wxString msg;
1386 
1387  SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( aFrame );
1388  SCH_SHEET_PATH* currentSheet = schframe ? &schframe->GetCurrentSheet() : nullptr;
1389 
1390  // part and alias can differ if alias is not the root
1391  if( m_part )
1392  {
1393  if( m_part.get() != dummy() )
1394  {
1395  aList.push_back( MSG_PANEL_ITEM( _( "Reference" ), GetRef( currentSheet ) ) );
1396 
1397  msg = m_part->IsPower() ? _( "Power symbol" ) : _( "Value" );
1398 
1399  aList.push_back( MSG_PANEL_ITEM( msg, GetValue( currentSheet, true ) ) );
1400 
1401 #if 0 // Display symbol flags, for debug only
1402  aList.push_back( MSG_PANEL_ITEM( _( "flags" ), wxString::Format( "%X",
1403  GetEditFlags() ) ) );
1404 #endif
1405 
1406  // Display symbol reference in library and library
1407  aList.push_back( MSG_PANEL_ITEM( _( "Name" ), GetLibId().GetLibItemName() ) );
1408 
1409  if( !m_part->IsRoot() )
1410  {
1411  msg = _( "Missing parent" );
1412 
1413  std::shared_ptr< LIB_PART > parent = m_part->GetParent().lock();
1414 
1415  if( parent )
1416  msg = parent->GetName();
1417 
1418  aList.push_back( MSG_PANEL_ITEM( _( "Alias of" ), msg ) );
1419  }
1420  else if( !m_lib_id.GetLibNickname().empty() )
1421  {
1422  aList.push_back( MSG_PANEL_ITEM( _( "Library" ), m_lib_id.GetLibNickname() ) );
1423  }
1424  else
1425  {
1426  aList.push_back( MSG_PANEL_ITEM( _( "Library" ), _( "Undefined!!!" ) ) );
1427  }
1428 
1429  // Display the current associated footprint, if exists.
1430  msg = GetFootprint( currentSheet, true );
1431 
1432  if( msg.IsEmpty() )
1433  msg = _( "<Unknown>" );
1434 
1435  aList.push_back( MSG_PANEL_ITEM( _( "Footprint" ), msg ) );
1436 
1437  // Display description of the symbol, and keywords found in lib
1438  aList.push_back( MSG_PANEL_ITEM( _( "Description" ), m_part->GetDescription(),
1439  DARKCYAN ) );
1440  aList.push_back( MSG_PANEL_ITEM( _( "Keywords" ), m_part->GetKeyWords() ) );
1441  }
1442  }
1443  else
1444  {
1445  aList.push_back( MSG_PANEL_ITEM( _( "Reference" ), GetRef( currentSheet ) ) );
1446 
1447  aList.push_back( MSG_PANEL_ITEM( _( "Value" ), GetValue( currentSheet, true ) ) );
1448  aList.push_back( MSG_PANEL_ITEM( _( "Name" ), GetLibId().GetLibItemName() ) );
1449 
1450  wxString libNickname = GetLibId().GetLibNickname();
1451 
1452  if( libNickname.empty() )
1453  {
1454  aList.push_back( MSG_PANEL_ITEM( _( "Library" ), _( "No library defined!" ) ) );
1455  }
1456  else
1457  {
1458  msg.Printf( _( "Symbol not found in %s!" ), libNickname );
1459  aList.push_back( MSG_PANEL_ITEM( _( "Library" ), msg ) );
1460  }
1461  }
1462 }
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
Definition: sch_symbol.cpp:69
Schematic editor (Eeschema) main window.
const wxString GetFootprint(const SCH_SHEET_PATH *sheet, bool aResolve) const
Return the instance-specific footprint assignment for the given sheet path.
Definition: sch_symbol.cpp:643
const wxString GetValue(const SCH_SHEET_PATH *sheet, bool aResolve) const
Return the instance-specific value for the given sheet path.
Definition: sch_symbol.cpp:593
STATUS_FLAGS GetEditFlags() const
Definition: eda_item.h:208
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:92
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_symbol.h:673
#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:54
const LIB_ID & GetLibId() const
Definition: sch_symbol.h:147
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:432
bool empty() const
Definition: utf8.h:103

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

◆ 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 mirrorV then a mirrorH 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 1254 of file sch_symbol.cpp.

1255 {
1256  int rotate_values[] =
1257  {
1258  CMP_ORIENT_0,
1259  CMP_ORIENT_90,
1265  CMP_MIRROR_Y,
1270  };
1271 
1272  // Try to find the current transform option:
1273  TRANSFORM transform = m_transform;
1274 
1275  for( int type_rotate : rotate_values )
1276  {
1277  SetOrientation( type_rotate );
1278 
1279  if( transform == m_transform )
1280  return type_rotate;
1281  }
1282 
1283  // Error: orientation not found in list (should not happen)
1284  wxFAIL_MSG( "Schematic symbol orientation matrix internal error." );
1285  m_transform = transform;
1286 
1287  return CMP_NORMAL;
1288 }
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:692
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::getPreferredSides(), orientLabel(), SCH_SEXPR_PLUGIN::saveSymbol(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetParent()

◆ GetPartRef() [1/2]

◆ GetPartRef() [2/2]

const std::unique_ptr< LIB_PART >& SCH_COMPONENT::GetPartRef ( ) const
inline

Definition at line 165 of file sch_symbol.h.

165 { return m_part; }
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695

References m_part.

◆ GetPenWidth()

virtual int SCH_ITEM::GetPenWidth ( ) const
inlinevirtualinherited

◆ GetPin() [1/2]

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

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 858 of file sch_symbol.cpp.

859 {
860  for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
861  {
862  if( pin->GetNumber() == aNumber )
863  return pin.get();
864  }
865 
866  return nullptr;
867 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:697

References m_pins, and pin.

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

◆ GetPin() [2/2]

SCH_PIN * SCH_COMPONENT::GetPin ( LIB_PIN aLibPin)

Definition at line 877 of file sch_symbol.cpp.

878 {
879  wxASSERT( m_pinMap.count( aLibPin ) );
880  return m_pins[ m_pinMap.at( aLibPin ) ].get();
881 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:697
std::unordered_map< LIB_PIN *, unsigned > m_pinMap
Definition: sch_symbol.h:698

References m_pinMap, and m_pins.

◆ GetPinPhysicalPosition()

wxPoint SCH_COMPONENT::GetPinPhysicalPosition ( const LIB_PIN Pin) const

Definition at line 1601 of file sch_symbol.cpp.

1602 {
1603  wxCHECK_MSG( Pin != NULL && Pin->Type() == LIB_PIN_T, wxPoint( 0, 0 ),
1604  wxT( "Cannot get physical position of pin." ) );
1605 
1606  return m_transform.TransformCoordinate( Pin->GetPosition() ) + m_pos;
1607 }
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
wxPoint m_pos
Definition: sch_symbol.h:672
#define NULL
wxPoint GetPosition() const override
Definition: lib_pin.h:210
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:692
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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

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

Since a symbol 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 884 of file sch_symbol.cpp.

885 {
886  std::vector<SCH_PIN*> pins;
887 
888  if( aSheet == nullptr )
889  {
890  wxCHECK_MSG( Schematic(), pins, "Can't call GetPins on a symbol with no schematic" );
891 
892  aSheet = &Schematic()->CurrentSheet();
893  }
894 
895  int unit = GetUnitSelection( aSheet );
896 
897  for( const auto& p : m_pins )
898  {
899  if( unit && p->GetLibPin()->GetUnit() && ( p->GetLibPin()->GetUnit() != unit ) )
900  continue;
901 
902  pins.push_back( p.get() );
903  }
904 
905  return pins;
906 }
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:697
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:119
int GetUnitSelection(const SCH_SHEET_PATH *aSheet) const
Return the instance-specific unit selection for the given sheet path.
Definition: sch_symbol.cpp:551

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

Referenced by NETLIST_EXPORTER_BASE::CreatePinList(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), SCH_EDITOR_CONTROL::nextMatch(), AUTOPLACER::pinsOnSide(), 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 227 of file sch_symbol.h.

227 { return m_prefix; }
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the symbol is.
Definition: sch_symbol.h:678

References m_prefix.

Referenced by SCH_LEGACY_PLUGIN::saveComponent().

◆ GetRawPins()

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

Definition at line 467 of file sch_symbol.h.

467 { return m_pins; }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:697

References m_pins.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ 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 432 of file sch_symbol.cpp.

433 {
434  KIID_PATH path = sheet->Path();
435  wxString ref;
436 
437  for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
438  {
439  if( instance.m_Path == path )
440  {
441  ref = instance.m_Reference;
442  break;
443  }
444  }
445 
446  // If it was not found in m_Paths array, then see if it is in m_Field[REFERENCE] -- if so,
447  // use this as a default for this path. This will happen if we load a version 1 schematic
448  // file. It will also mean that multiple instances of the same sheet by default all have
449  // the same symbol references, but perhaps this is best.
450  if( ref.IsEmpty() && !GetField( REFERENCE_FIELD )->GetText().IsEmpty() )
451  {
452  const_cast<SCH_COMPONENT*>( this )->SetRef( sheet, GetField( REFERENCE_FIELD )->GetText() );
453  ref = GetField( REFERENCE_FIELD )->GetText();
454  }
455 
456  if( ref.IsEmpty() )
457  ref = m_prefix;
458 
459  if( aIncludeUnit && GetUnitCount() > 1 )
460  ref += LIB_PART::SubReference( GetUnit() );
461 
462  return ref;
463 }
Field Reference of part, i.e. "IC21".
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:693
int GetUnitCount() const
Return the number of units per package of the symbol.
Definition: sch_symbol.cpp:361
int GetUnit() const
Definition: sch_symbol.h:195
A simple container for schematic symbol instance information.
static wxString SubReference(int aUnit, bool aAddSeparator=true)
Definition: lib_symbol.cpp:447
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:706
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the symbol is.
Definition: sch_symbol.h:678
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133

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

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), SCHEMATIC::ConvertKIIDsToRefs(), SCHEMATIC::ConvertRefsToKIIDs(), NETLIST_EXPORTER_BASE::CreatePinList(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), SCH_EDITOR_CONTROL::FindComponentAndItem(), NETLIST_EXPORTER_BASE::findNextSymbol(), SCH_PIN::GetDefaultNetName(), SCH_PIN::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_SHEET_PATH::GetMultiUnitSymbols(), SCH_SHEET_PATH::GetSymbols(), DIALOG_CHANGE_SYMBOLS::isMatch(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_FIELD::Matches(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), SCH_FIELD::Replace(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), ERC_TESTER::TestMultiunitFootprints(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

◆ GetSchSymbolLibraryName()

wxString SCH_COMPONENT::GetSchSymbolLibraryName ( ) const

Definition at line 239 of file sch_symbol.cpp.

240 {
241  if( !m_schLibSymbolName.IsEmpty() )
242  return m_schLibSymbolName;
243  else
244  return m_lib_id.Format().wx_str();
245 }
wxString m_schLibSymbolName
The name used to look up a symbol in the symbol library embedded in a schematic.
Definition: sch_symbol.h:690
UTF8 Format() const
Definition: lib_id.cpp:233
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_symbol.h:673
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(), SCH_SEXPR_PLUGIN::saveSymbol(), and SCH_SCREEN::SwapSymbolLinks().

◆ GetSelectMenuText()

wxString SCH_COMPONENT::GetSelectMenuText ( EDA_UNITS  aUnits) const
overridevirtual

Return 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 1648 of file sch_symbol.cpp.

1649 {
1650  return wxString::Format( _( "Symbol %s [%s]" ),
1651  GetField( REFERENCE_FIELD )->GetShownText(),
1652  GetLibId().GetLibItemName().wx_str() );
1653 }
Field Reference of part, i.e. "IC21".
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:693
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
const LIB_ID & GetLibId() const
Definition: sch_symbol.h:147

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

Referenced by Matches().

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 187 of file eda_item.h.

188  {
189  return m_status & type;
190  }
STATUS_FLAGS m_status
Definition: eda_item.h:528

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 200 of file eda_item.h.

200 { return m_status; }
STATUS_FLAGS m_status
Definition: eda_item.h:528

References EDA_ITEM::m_status.

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 235 of file sch_item.h.

235 { return m_storedPos; }
wxPoint m_storedPos
Definition: sch_item.h:499

References SCH_ITEM::m_storedPos.

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const
inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 464 of file sch_item.h.

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

◆ GetTransform() [1/2]

◆ GetTransform() [2/2]

const TRANSFORM& SCH_COMPONENT::GetTransform ( ) const
inline

Definition at line 232 of file sch_symbol.h.

232 { return m_transform; }
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:692

References m_transform.

◆ 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 361 of file sch_symbol.cpp.

362 {
363  if( m_part )
364  return m_part->GetUnitCount();
365 
366  return 0;
367 }
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695

References m_part.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), GetRef(), SCH_FIELD::GetShownText(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_FIELD::Matches(), SCH_DRAWING_TOOLS::PlaceSymbol(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetUnitSelection()

int SCH_COMPONENT::GetUnitSelection ( const SCH_SHEET_PATH aSheet) const

Return the instance-specific unit selection for the given sheet path.

Definition at line 551 of file sch_symbol.cpp.

552 {
553  KIID_PATH path = aSheet->Path();
554 
555  for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
556  {
557  if( instance.m_Path == path )
558  return instance.m_Unit;
559  }
560 
561  // If it was not found in m_Paths array, then use m_unit. This will happen if we load a
562  // version 1 schematic file.
563  return m_unit;
564 }
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
A simple container for schematic symbol instance information.
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:674
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:706

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

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), KIGFX::SCH_PAINTER::draw(), GetPins(), SCH_EDIT_FRAME::mapExistingAnnotation(), ResolveTextVar(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_REFERENCE::SCH_REFERENCE(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

◆ GetValue()

const wxString SCH_COMPONENT::GetValue ( const SCH_SHEET_PATH sheet,
bool  aResolve 
) const

Return the instance-specific value for the given sheet path.

Definition at line 593 of file sch_symbol.cpp.

594 {
595  KIID_PATH path = sheet->Path();
596 
597  for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
598  {
599  if( instance.m_Path == path && !instance.m_Value.IsEmpty() )
600  {
601  // This can only be an override from an Update Schematic from PCB, and therefore
602  // will always be fully resolved.
603  return instance.m_Value;
604  }
605  }
606 
607  if( !aResolve )
608  return GetField( VALUE_FIELD )->GetText();
609 
610  return GetField( VALUE_FIELD )->GetShownText();
611 }
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:693
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: sch_field.cpp:105
Field Value of part, i.e. "3.3K".
A simple container for schematic symbol instance information.
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:706
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133

References GetField(), SCH_FIELD::GetShownText(), EDA_TEXT::GetText(), m_instanceReferences, SCH_SHEET_PATH::Path(), path, and VALUE_FIELD.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), SCH_PIN::GetMsgPanelInfo(), GetMsgPanelInfo(), DIALOG_CHANGE_SYMBOLS::isMatch(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET_PATH::UpdateAllScreenReferences(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

◆ HasBrightenedPins()

bool SCH_COMPONENT::HasBrightenedPins ( )

Definition at line 1889 of file sch_symbol.cpp.

1890 {
1891  for( const auto& pin : m_pins )
1892  {
1893  if( pin->IsBrightened() )
1894  return true;
1895  }
1896 
1897  return false;
1898 }
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:697

References m_pins, and pin.

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 462 of file sch_item.h.

462 { return false; }

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

◆ HitTest() [1/2]

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

Test 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 1810 of file sch_symbol.cpp.

1811 {
1812  EDA_RECT bBox = GetBodyBoundingBox();
1813  bBox.Inflate( aAccuracy );
1814 
1815  if( bBox.Contains( aPosition ) )
1816  return true;
1817 
1818  return false;
1819 }
bool Contains(const wxPoint &aPoint) const
Definition: eda_rect.cpp:57
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
Handle the component boundary box.
Definition: eda_rect.h:42
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Inflate the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

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

Test 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 1822 of file sch_symbol.cpp.

1823 {
1825  return false;
1826 
1827  EDA_RECT rect = aRect;
1828 
1829  rect.Inflate( aAccuracy );
1830 
1831  if( aContained )
1832  return rect.Contains( GetBodyBoundingBox() );
1833 
1834  return rect.Intersects( GetBodyBoundingBox() );
1835 }
bool Contains(const wxPoint &aPoint) const
Definition: eda_rect.cpp:57
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: eda_item.h:116
Handle the component boundary box.
Definition: eda_rect.h:42
bool Intersects(const EDA_RECT &aRect) const
Test for a common area between rectangles.
Definition: eda_rect.cpp:150
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: eda_item.h:118
STATUS_FLAGS m_flags
Definition: eda_item.h:531
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Inflate the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

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 185 of file sch_symbol.cpp.

186 {
187  m_pos = pos;
188  m_unit = 1; // In multi unit chip - which unit to draw.
189  m_convert = LIB_ITEM::LIB_CONVERT::BASE; // De Morgan Handling
190 
191  // The rotation/mirror transformation matrix. pos normal
193 
194  // construct only the mandatory fields, which are the first 4 only.
195  for( int i = 0; i < MANDATORY_FIELDS; ++i )
196  {
197  m_fields.emplace_back( pos, i, this, TEMPLATE_FIELDNAME::GetDefaultFieldName( i ) );
198 
199  if( i == REFERENCE_FIELD )
200  m_fields.back().SetLayer( LAYER_REFERENCEPART );
201  else if( i == VALUE_FIELD )
202  m_fields.back().SetLayer( LAYER_VALUEPART );
203  else
204  m_fields.back().SetLayer( LAYER_FIELDS );
205  }
206 
207  m_prefix = wxString( wxT( "U" ) );
208  m_isInNetlist = true;
209  m_inBom = true;
210  m_onBoard = true;
211 }
Field Reference of part, i.e. "IC21".
bool m_onBoard
True to include in netlist when updating board.
Definition: sch_symbol.h:702
wxPoint m_pos
Definition: sch_symbol.h:672
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
Field Value of part, i.e. "3.3K".
bool m_isInNetlist
True if the symbol should appear in the netlist.
Definition: sch_symbol.h:700
static const wxString GetDefaultFieldName(int aFieldNdx, bool aTranslate=true)
Return a default symbol field name for field aFieldNdx for all components.
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:674
bool m_inBom
True to include in bill of materials export.
Definition: sch_symbol.h:701
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:675
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the symbol is.
Definition: sch_symbol.h:678
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:692
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

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_FIELD, and VALUE_FIELD.

Referenced by SCH_COMPONENT().

◆ InitializeConnection()

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

Create a new connection object associated with this object.

Parameters
aPathis the sheet path to initialize.

Definition at line 176 of file sch_item.cpp.

178 {
179  SCH_CONNECTION* connection = Connection( &aSheet );
180 
181  if( connection )
182  {
183  connection->Reset();
184  }
185  else
186  {
187  connection = new SCH_CONNECTION( this );
188  m_connection_map.insert( std::make_pair( aSheet, connection ) );
189  }
190 
191  connection->SetGraph( aGraph );
192  connection->SetSheet( aSheet );
193  return connection;
194 }
void SetSheet(SCH_SHEET_PATH aSheet)
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:131
void Reset()
Clears connectivity information.
void SetGraph(CONNECTION_GRAPH *aGraph)
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Store connectivity information, per sheet.
Definition: sch_item.h:506
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(), SCH_CONNECTION::SetGraph(), and SCH_CONNECTION::SetSheet().

◆ IsAnnotated()

bool SCH_COMPONENT::IsAnnotated ( const SCH_SHEET_PATH aSheet)

Check if the symbol has a valid annotation (reference) for the given sheet path.

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

Definition at line 537 of file sch_symbol.cpp.

538 {
539  KIID_PATH path = aSheet->Path();
540 
541  for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
542  {
543  if( instance.m_Path == path )
544  return instance.m_Reference.Last() != '?';
545  }
546 
547  return false;
548 }
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
A simple container for schematic symbol instance information.
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:706

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

Referenced by SCH_EDIT_FRAME::mapExistingAnnotation(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

◆ 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 597 of file sch_symbol.h.

597 { return true; }

◆ IsConnected()

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

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

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

Definition at line 122 of file sch_item.cpp.

123 {
124  if(( m_flags & STRUCT_DELETED ) || ( m_flags & SKIP_STRUCT ) )
125  return false;
126 
127  return doIsConnected( aPosition );
128 }
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:116
virtual bool doIsConnected(const wxPoint &aPosition) const
Provide the object specific test to see if it is connected to aPosition.
Definition: sch_item.h:493
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: eda_item.h:118
STATUS_FLAGS m_flags
Definition: eda_item.h:531

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

Referenced by SCH_SCREEN::IsJunctionNeeded(), and SCH_SCREEN::IsTerminalPoint().

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( )
inlineinherited

Definition at line 424 of file sch_item.h.

424 { return m_connectivity_dirty; }
bool m_connectivity_dirty
Definition: sch_item.h:508

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 355 of file sch_item.h.

355 { return false; }

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 171 of file eda_item.h.

171 { return m_flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:109
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References IS_DRAGGED, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const
inlineinherited

Definition at line 174 of file eda_item.h.

174 { return m_flags & ENTERED; }
#define ENTERED
indicates a group has been entered
Definition: eda_item.h:138
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References ENTERED, and EDA_ITEM::m_flags.

Referenced by KIGFX::PCB_PAINTER::draw().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 256 of file eda_item.h.

256 { return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:530

References EDA_ITEM::m_forceVisible.

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

◆ IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const
inlinevirtualinherited

Allow items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD.

Definition at line 265 of file sch_item.h.

265 { return false; }

◆ IsInNetlist()

bool SCH_COMPONENT::IsInNetlist ( ) const
Returns
true if the symbol is in netlist.

Definition at line 1866 of file sch_symbol.cpp.

1867 {
1868  return m_isInNetlist;
1869 }
bool m_isInNetlist
True if the symbol should appear in the netlist.
Definition: sch_symbol.h:700

References m_isInNetlist.

Referenced by AUTOPLACER::AUTOPLACER().

◆ IsLocked()

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

Definition at line 255 of file sch_item.h.

255 { return false; }

Referenced by SCH_EDIT_TOOL::DeleteItemCursor().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 168 of file eda_item.h.

168 { return m_flags & IS_CHANGED; }
#define IS_CHANGED
Item was edited, and modified.
Definition: eda_item.h:103
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

bool SCH_COMPONENT::IsMovableFromAnchorPoint ( ) const
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, symbols).

Note
We used to try and be smart about this and return false for symbols 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 symbols.
Returns
true for a symbol.

Reimplemented from SCH_ITEM.

Definition at line 143 of file sch_symbol.h.

143 { return true; }

◆ IsMoving()

◆ IsNew()

◆ IsPointClickableAnchor()

bool SCH_COMPONENT::IsPointClickableAnchor ( const wxPoint &  aPos) const
overridevirtual
Returns
true if the given point can start drawing (usually means the anchor is unused/free/dangling).

Reimplemented from SCH_ITEM.

Definition at line 1908 of file sch_symbol.cpp.

1909 {
1910  for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
1911  {
1912  int pin_unit = pin->GetLibPin()->GetUnit();
1913  int pin_convert = pin->GetLibPin()->GetConvert();
1914 
1915  if( pin_unit > 0 && pin_unit != GetUnit() )
1916  continue;
1917 
1918  if( pin_convert > 0 && pin_convert != GetConvert() )
1919  continue;
1920 
1921  if( pin->IsPointClickableAnchor( aPos ) )
1922  return true;
1923  }
1924 
1925  return false;
1926 }
int GetUnit() const
Definition: sch_symbol.h:195
int GetConvert() const
Definition: sch_symbol.h:223
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:697

References GetConvert(), GetUnit(), m_pins, and pin.

◆ IsReferenceStringValid()

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

Test 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 466 of file sch_symbol.cpp.

467 {
468  wxString text = aReferenceString;
469  bool ok = true;
470 
471  // Try to unannotate this reference
472  while( !text.IsEmpty() && ( text.Last() == '?' || wxIsdigit( text.Last() ) ) )
473  text.RemoveLast();
474 
475  if( text.IsEmpty() )
476  ok = false;
477 
478  return ok;
479 }

References text.

Referenced by ClearAnnotation(), SetRef(), DIALOG_EDIT_ONE_FIELD::TransferDataFromWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::Validate(), and DIALOG_SYMBOL_PROPERTIES::Validate().

◆ IsReplaceable()

bool SCH_COMPONENT::IsReplaceable ( ) const
inlineoverridevirtual

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 639 of file sch_symbol.h.

639 { return true; }

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 175 of file eda_item.h.

175 { return m_flags & IS_RESIZED; }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:108
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References IS_RESIZED, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 173 of file eda_item.h.

173 { return m_flags & SELECTED; }
#define SELECTED
Definition: eda_item.h:114
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), KIGFX::SCH_PAINTER::getTextThickness(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), RENDER_3D_LEGACY::renderFootprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), and GERBVIEW_SELECTION_TOOL::unselect().

◆ IsType()

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

Check 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_BASE, PAD, PCB_SHAPE, SCH_FIELD, FP_TEXT, SCH_LINE, FP_SHAPE, and PCB_TEXT.

Definition at line 233 of file eda_item.h.

234  {
235  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
236  return true;
237 
238  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
239  {
240  if( m_structType == *p )
241  return true;
242  }
243 
244  return false;
245  }
search types array terminator (End Of Types)
Definition: typeinfo.h:81
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
KICAD_T m_structType
Run time identification, keep private so it can never be changed after a ctor sets it.
Definition: eda_item.h:538

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by ROUTER_TOOL::CanInlineDrag(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), SCH_LINE::IsType(), FP_TEXT::IsType(), SCH_FIELD::IsType(), PCB_SHAPE::IsType(), PAD::IsType(), DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), SCH_BASE_FRAME::UpdateItem(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 172 of file eda_item.h.

172 { return m_flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:111
STATUS_FLAGS m_flags
Definition: eda_item.h:531

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

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

Definition at line 345 of file eda_item.h.

349  {
350  for( auto it : aList )
351  {
352  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
354  return SEARCH_RESULT::QUIT;
355  }
356 
358  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:91

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

Change first parameter to avoid the DList and use std::vector instead.

Definition at line 364 of file eda_item.h.

366  {
367  for( auto it : aList )
368  {
369  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
371  return SEARCH_RESULT::QUIT;
372  }
373 
375  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:91

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

◆ Matches() [1/2]

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

Compare 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 116 of file eda_item.cpp.

117 {
118  wxString text = aText;
119  wxString searchText = aSearchData.GetFindString();
120 
121  // Don't match if searching for replaceable item and the item doesn't support text replace.
122  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
123  return false;
124 
125  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
126  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
127 
128  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
129  {
130  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
131  return text.Matches( searchText );
132 
133  return text.MakeUpper().Matches( searchText.MakeUpper() );
134  }
135 
136  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
137  return aText.Find( searchText ) != wxNOT_FOUND;
138 
139  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
140 }
virtual bool IsReplaceable() const
Override this method in any derived object that supports test find and replace.
Definition: eda_item.h:453

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

◆ Matches() [2/2]

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

Compare 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 1526 of file sch_symbol.cpp.

1527 {
1528  wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText( EDA_UNITS::MILLIMETRES ) );
1529 
1530  // Symbols are searchable via the child field and pin item text.
1531  return false;
1532 }
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Return the text to display to be used in the selection clarification context menu when multiple items...
const wxChar *const traceFindItem
Flag to enable find debug tracing.

References GetSelectMenuText(), MILLIMETRES, and traceFindItem.

◆ MirrorHorizontally()

void SCH_COMPONENT::MirrorHorizontally ( int  aCenter)
overridevirtual

Mirror item horizontally about aCenter.

Implements SCH_ITEM.

Definition at line 1471 of file sch_symbol.cpp.

1472 {
1473  int dx = m_pos.x;
1474 
1476  MIRROR( m_pos.x, aCenter );
1477  dx -= m_pos.x; // dx,0 is the move vector for this transform
1478 
1479  for( SCH_FIELD& field : m_fields )
1480  {
1481  // Move the fields to the new position because the symbol itself has moved.
1482  wxPoint pos = field.GetTextPos();
1483  pos.x -= dx;
1484  field.SetTextPos( pos );
1485  }
1486 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:40
wxPoint m_pos
Definition: sch_symbol.h:672
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693
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(), and SetOrientation().

◆ MirrorVertically()

void SCH_COMPONENT::MirrorVertically ( int  aCenter)
overridevirtual

Mirror item vertically about aCenter.

Implements SCH_ITEM.

Definition at line 1489 of file sch_symbol.cpp.

1490 {
1491  int dy = m_pos.y;
1492 
1494  MIRROR( m_pos.y, aCenter );
1495  dy -= m_pos.y; // dy,0 is the move vector for this transform
1496 
1497  for( SCH_FIELD& field : m_fields )
1498  {
1499  // Move the fields to the new position because the symbol itself has moved.
1500  wxPoint pos = field.GetTextPos();
1501  pos.y -= dy;
1502  field.SetTextPos( pos );
1503  }
1504 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:40
wxPoint m_pos
Definition: sch_symbol.h:672
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693
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(), and SetOrientation().

◆ Move()

void SCH_COMPONENT::Move ( const wxPoint &  aMoveVector)
inlineoverridevirtual

Move the item by aMoveVector to a new position.

Implements SCH_ITEM.

Definition at line 561 of file sch_symbol.h.

562  {
563  if( aMoveVector == wxPoint( 0, 0 ) )
564  return;
565 
566  m_pos += aMoveVector;
567 
568  for( SCH_FIELD& field : m_fields )
569  field.Move( aMoveVector );
570 
571  SetModified();
572  }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
void SetModified()
Definition: eda_item.cpp:63
wxPoint m_pos
Definition: sch_symbol.h:672
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References m_fields, m_pos, and EDA_ITEM::SetModified().

Referenced by SetPosition().

◆ NetClass()

NETCLASSPTR SCH_ITEM::NetClass ( const SCH_SHEET_PATH aSheet = nullptr) const
inherited

Definition at line 145 of file sch_item.cpp.

146 {
147  if( m_connection_map.size() )
148  {
149  SCH_CONNECTION* connection = Connection( aSheet );
150 
151  if( connection )
152  {
153  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
154  const wxString& netclassName = netSettings.GetNetclassName( connection->Name() );
155 
156  return netSettings.m_NetClasses.Find( netclassName );
157  }
158  }
159 
160  return nullptr;
161 }
NETCLASSPTR Find(const wxString &aName) const
Search this container for a NETCLASS given by aName.
Definition: netclass.cpp:132
const wxString & GetNetclassName(const wxString &aNetName) const
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:145
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
NET_SETTINGS & NetSettings()
Definition: project_file.h:94
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:131
NETCLASSES m_NetClasses
Definition: net_settings.h:39
wxString Name(bool aIgnoreSheet=false) const
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
Store connectivity information, per sheet.
Definition: sch_item.h:506
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
Definition: schematic.h:75
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).

References SCH_ITEM::Connection(), NETCLASSES::Find(), NET_SETTINGS::GetNetclassName(), PROJECT::GetProjectFile(), SCH_ITEM::m_connection_map, NET_SETTINGS::m_NetClasses, SCH_CONNECTION::Name(), PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

Referenced by SCH_LINE::GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_JUNCTION::GetJunctionColor(), 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 aSymbol) const

Definition at line 1767 of file sch_symbol.cpp.

1768 {
1769  return !( *this == aSymbol );
1770 }

◆ 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 169 of file eda_item.cpp.

170 {
171  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
172  GetClass() ) );
173 
174  return false;
175 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
virtual wxString GetClass() const =0
Return the class name.

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

◆ operator<() [2/2]

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

Reimplemented from SCH_ITEM.

Definition at line 1730 of file sch_symbol.cpp.

1731 {
1732  if( Type() != aItem.Type() )
1733  return Type() < aItem.Type();
1734 
1735  auto component = static_cast<const SCH_COMPONENT*>( &aItem );
1736 
1737  EDA_RECT rect = GetBodyBoundingBox();
1738 
1739  if( rect.GetArea() != component->GetBodyBoundingBox().GetArea() )
1740  return rect.GetArea() < component->GetBodyBoundingBox().GetArea();
1741 
1742  if( m_pos.x != component->m_pos.x )
1743  return m_pos.x < component->m_pos.x;
1744 
1745  if( m_pos.y != component->m_pos.y )
1746  return m_pos.y < component->m_pos.y;
1747 
1748  return m_Uuid < aItem.m_Uuid; // Ensure deterministic sort
1749 }
wxPoint m_pos
Definition: sch_symbol.h:672
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
double GetArea() const
Return the area of the rectangle.
Definition: eda_rect.cpp:481
const KIID m_Uuid
Definition: eda_item.h:525
Handle the component boundary box.
Definition: eda_rect.h:42
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

References EDA_RECT::GetArea(), GetBodyBoundingBox(), m_pos, EDA_ITEM::m_Uuid, and EDA_ITEM::Type().

◆ operator=()

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

Definition at line 1773 of file sch_symbol.cpp.

1774 {
1775  wxCHECK_MSG( Type() == aItem.Type(), *this,
1776  wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
1777  GetClass() );
1778 
1779  if( &aItem != this )
1780  {
1781  SCH_ITEM::operator=( aItem );
1782 
1783  SCH_COMPONENT* c = (SCH_COMPONENT*) &aItem;
1784 
1785  m_lib_id = c->m_lib_id;
1786 
1787  LIB_PART* libSymbol = c->m_part ? new LIB_PART( *c->m_part.get() ) : nullptr;
1788 
1789  m_part.reset( libSymbol );
1790  m_pos = c->m_pos;
1791  m_unit = c->m_unit;
1792  m_convert = c->m_convert;
1793  m_transform = c->m_transform;
1794 
1796 
1797  m_fields = c->m_fields; // std::vector's assignment operator
1798 
1799  // Reparent fields after assignment to new symbol.
1800  for( SCH_FIELD& field : m_fields )
1801  field.SetParent( this );
1802 
1803  UpdatePins();
1804  }
1805 
1806  return *this;
1807 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
wxPoint m_pos
Definition: sch_symbol.h:672
Define a library symbol object.
Definition: lib_symbol.h:93
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Assign the members of aItem to another object.
Definition: eda_item.cpp:177
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:674
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_symbol.h:673
Schematic symbol object.
Definition: sch_symbol.h:78
virtual wxString GetClass() const override
Return the class name.
Definition: sch_item.h:206
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:706
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:675
void UpdatePins()
Updates the cache of SCH_PIN objects for each pin.
Definition: sch_symbol.cpp:275
wxString GetClass() const override
Return the class name.
Definition: sch_symbol.h:118
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:692
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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 aSymbol) const

Definition at line 1752 of file sch_symbol.cpp.

1753 {
1754  if( GetFieldCount() != aSymbol.GetFieldCount() )
1755  return false;
1756 
1757  for( int i = VALUE_FIELD; i < GetFieldCount(); i++ )
1758  {
1759  if( GetFields()[i].GetText().Cmp( aSymbol.GetFields()[i].GetText() ) != 0 )
1760  return false;
1761  }
1762 
1763  return true;
1764 }
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with SCH_FIELDs.
Definition: sch_symbol.cpp:729
Field Value of part, i.e. "3.3K".
std::vector< SCH_FIELD > & GetFields()
Return a vector of fields from the symbol.
Definition: sch_symbol.h:366
int GetFieldCount() const
Return the number of fields in this symbol.
Definition: sch_symbol.h:421

References GetFieldCount(), GetFields(), and VALUE_FIELD.

◆ Plot()

void SCH_COMPONENT::Plot ( PLOTTER aPlotter) const
overridevirtual

Plot the schematic item to aPlotter.

Parameters
aPlotteris the PLOTTER object to plot to.

Reimplemented from SCH_ITEM.

Definition at line 1872 of file sch_symbol.cpp.

1873 {
1874  if( m_part )
1875  {
1876  TRANSFORM temp = GetTransform();
1877  aPlotter->StartBlock( nullptr );
1878 
1879  m_part->Plot( aPlotter, GetUnit(), GetConvert(), m_pos, temp );
1880 
1881  for( SCH_FIELD field : m_fields )
1882  field.Plot( aPlotter );
1883 
1884  aPlotter->EndBlock( nullptr );
1885  }
1886 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
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:484
virtual void StartBlock(void *aData)
calling this function allows one to define the beginning of a group of drawing items,...
Definition: plotter.h:475
int GetUnit() const
Definition: sch_symbol.h:195
wxPoint m_pos
Definition: sch_symbol.h:672
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM & GetTransform()
Definition: sch_symbol.h:231
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695
int GetConvert() const
Definition: sch_symbol.h:223
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References PLOTTER::EndBlock(), GetConvert(), GetTransform(), GetUnit(), m_fields, m_part, m_pos, and PLOTTER::StartBlock().

◆ Print()

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

Print a symbol.

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 370 of file sch_symbol.cpp.

371 {
372  PART_DRAW_OPTIONS opts;
373  opts.transform = m_transform;
374  opts.draw_visible_fields = false;
375  opts.draw_hidden_fields = false;
376 
377  if( m_part )
378  {
379  m_part->Print( aSettings, m_pos + aOffset, m_unit, m_convert, opts );
380  }
381  else // Use dummy() part if the actual cannot be found.
382  {
383  dummy()->Print( aSettings, m_pos + aOffset, 0, 0, opts );
384  }
385 
386  for( SCH_FIELD& field : m_fields )
387  field.Print( aSettings, aOffset );
388 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
Definition: sch_symbol.cpp:69
bool draw_hidden_fields
Definition: lib_symbol.h:66
wxPoint m_pos
Definition: sch_symbol.h:672
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:674
void Print(const RENDER_SETTINGS *aSettings, const wxPoint &aOffset, int aMulti, int aConvert, const PART_DRAW_OPTIONS &aOpts)
Print part.
Definition: lib_symbol.cpp:479
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:675
bool draw_visible_fields
Definition: lib_symbol.h:65
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_symbol.h:692
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693
TRANSFORM transform
Definition: lib_symbol.h:64

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)

Remove 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 748 of file sch_symbol.cpp.

749 {
750  for( unsigned i = MANDATORY_FIELDS; i < m_fields.size(); ++i )
751  {
752  if( aFieldName == m_fields[i].GetName( false ) )
753  {
754  m_fields.erase( m_fields.begin() + i );
755  return;
756  }
757  }
758 }
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

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 ( const wxFindReplaceData &  aSearchData,
wxString &  aText 
)
staticinherited

Perform 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 143 of file eda_item.cpp.

144 {
145  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
146 
147  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
148  aSearchData.GetFindString() :
149  aSearchData.GetFindString().Upper() );
150 
151  if( result == wxNOT_FOUND )
152  return false;
153 
154  wxString prefix = aText.Left( result );
155  wxString suffix;
156 
157  if( aSearchData.GetFindString().length() + result < aText.length() )
158  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
159 
160  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
161  aText, prefix, aSearchData.GetReplaceString(), suffix );
162 
163  aText = prefix + aSearchData.GetReplaceString() + suffix;
164 
165  return true;
166 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.

References traceFindReplace.

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

◆ Replace() [2/2]

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

Perform 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_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 442 of file eda_item.h.

443  {
444  return false;
445  }

◆ 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 1099 of file sch_symbol.cpp.

1101 {
1102  auto it = std::find_if( m_instanceReferences.begin(), m_instanceReferences.end(),
1103  [ aOldSheetPath ]( SYMBOL_INSTANCE_REFERENCE& r )->bool
1104  {
1105  return aOldSheetPath == r.m_Path;
1106  }
1107  );
1108 
1109  if( it != m_instanceReferences.end() )
1110  {
1111  wxLogTrace( traceSchSheetPaths,
1112  "Replacing sheet path %s\n with sheet path %s\n for symbol %s.",
1113  aOldSheetPath.AsString(), aNewSheetPath.AsString(), m_Uuid.AsString() );
1114 
1115  it->m_Path = aNewSheetPath;
1116  return true;
1117  }
1118 
1119  wxLogTrace( traceSchSheetPaths,
1120  "Could not find sheet path %s\n to replace with sheet path %s\n for symbol %s.",
1121  aOldSheetPath.AsString(), aNewSheetPath.AsString(), m_Uuid.AsString() );
1122 
1123  return false;
1124 }
const wxChar *const traceSchSheetPaths
Flag to enable debug output of schematic symbol sheet path manipulation code.
wxString AsString() const
Definition: kiid.cpp:218
A simple container for schematic symbol instance information.
const KIID m_Uuid
Definition: eda_item.h:525
wxString AsString() const
Definition: kiid.cpp:256
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:706

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 symbol.

Parameters
aDeptha counter to limit recursion and circular references.

Definition at line 960 of file sch_symbol.cpp.

961 {
962  SCHEMATIC* schematic = Schematic();
963 
964  for( int i = 0; i < MANDATORY_FIELDS; ++i )
965  {
966  if( token->IsSameAs( m_fields[ i ].GetCanonicalName().Upper() ) )
967  {
968  if( i == REFERENCE_FIELD && schematic )
969  *token = GetRef( &schematic->CurrentSheet(), true );
970  else if( i == VALUE_FIELD && schematic )
971  *token = GetValue( &schematic->CurrentSheet(), true );
972  else if( i == FOOTPRINT_FIELD && schematic )
973  *token = GetFootprint( &schematic->CurrentSheet(), true );
974  else
975  *token = m_fields[ i ].GetShownText( aDepth + 1 );
976 
977  return true;
978  }
979  }
980 
981  for( size_t i = MANDATORY_FIELDS; i < m_fields.size(); ++i )
982  {
983  if( token->IsSameAs( m_fields[ i ].GetName() )
984  || token->IsSameAs( m_fields[ i ].GetName().Upper() ) )
985  {
986  *token = m_fields[ i ].GetShownText( aDepth + 1 );
987  return true;
988  }
989  }
990 
991  if( token->IsSameAs( wxT( "FOOTPRINT_LIBRARY" ) ) )
992  {
993  wxString footprint;
994 
995  if( schematic )
996  footprint = GetFootprint( &schematic->CurrentSheet(), true );
997  else
998  footprint = m_fields[ FOOTPRINT_FIELD ].GetShownText();
999 
1000  wxArrayString parts = wxSplit( footprint, ':' );
1001 
1002  *token = parts[ 0 ];
1003  return true;
1004  }
1005  else if( token->IsSameAs( wxT( "FOOTPRINT_NAME" ) ) )
1006  {
1007  wxString footprint;
1008 
1009  if( schematic )
1010  footprint = GetFootprint( &schematic->CurrentSheet(), true );
1011  else
1012  footprint = m_fields[ FOOTPRINT_FIELD ].GetShownText();
1013 
1014  wxArrayString parts = wxSplit( footprint, ':' );
1015 
1016  *token = parts[ std::min( 1, (int) parts.size() - 1 ) ];
1017  return true;
1018  }
1019  else if( token->IsSameAs( wxT( "UNIT" ) ) )
1020  {
1021  int unit;
1022 
1023  if( schematic )
1024  unit = GetUnitSelection( &schematic->CurrentSheet() );
1025  else
1026  unit = GetUnit();
1027 
1028  *token = LIB_PART::SubReference( unit );
1029  return true;
1030  }
1031 
1032  return false;
1033 }
Field Reference of part, i.e. "IC21".
Holds all the data relating to one schematic.
Definition: schematic.h:59
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
const wxString GetFootprint(const SCH_SHEET_PATH *sheet, bool aResolve) const
Return the instance-specific footprint assignment for the given sheet path.
Definition: sch_symbol.cpp:643
int GetUnit() const
Definition: sch_symbol.h:195
Field Value of part, i.e. "3.3K".
const wxString GetValue(const SCH_SHEET_PATH *sheet, bool aResolve) const
Return the instance-specific value for the given sheet path.
Definition: sch_symbol.cpp:593
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
static wxString SubReference(int aUnit, bool aAddSeparator=true)
Definition: lib_symbol.cpp:447
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:119
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693
int GetUnitSelection(const SCH_SHEET_PATH *aSheet) const
Return the instance-specific unit selection for the given sheet path.
Definition: sch_symbol.cpp:551
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:432
Field Name Module PCB, i.e. "16DIP300".

References SCHEMATIC::CurrentSheet(), FOOTPRINT_FIELD, GetFootprint(), GetRef(), GetUnit(), GetUnitSelection(), GetValue(), m_fields, MANDATORY_FIELDS, REFERENCE_FIELD, SCH_ITEM::Schematic(), LIB_PART::SubReference(), and VALUE_FIELD.

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

◆ Rotate()

void SCH_COMPONENT::Rotate ( wxPoint  aCenter)
overridevirtual

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

Implements SCH_ITEM.

Definition at line 1507 of file sch_symbol.cpp.

1508 {
1509  wxPoint prev = m_pos;
1510 
1511  RotatePoint( &m_pos, aCenter, 900 );
1512 
1514 
1515  for( SCH_FIELD& field : m_fields )
1516  {
1517  // Move the fields to the new position because the symbol itself has moved.
1518  wxPoint pos = field.GetTextPos();
1519  pos.x -= prev.x - m_pos.x;
1520  pos.y -= prev.y - m_pos.y;
1521  field.SetTextPos( pos );
1522  }
1523 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
wxPoint m_pos
Definition: sch_symbol.h:672
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693
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(), and SetOrientation().

◆ RunOnChildren()

void SCH_COMPONENT::RunOnChildren ( const std::function< void(SCH_ITEM *)> &  aFunction)
overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 848 of file sch_symbol.cpp.

849 {
850  for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
851  aFunction( pin.get() );
852 
853  for( SCH_FIELD& field : m_fields )
854  aFunction( &field );
855 }
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
std::vector< std::unique_ptr< SCH_PIN > > m_pins
Definition: sch_symbol.h:697
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References m_fields, m_pins, and pin.

◆ 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 symbols).

Every SCH_SCREEN should be parented to the SCHEMATIC.

Note
This hierarchy is not the same as the sheet hierarchy!
Returns
the parent schematic this item lives on, or nullptr.

Definition at line 97 of file sch_item.cpp.

98 {
99  EDA_ITEM* parent = GetParent();
100 
101  while( parent )
102  {
103  if( parent->Type() == SCHEMATIC_T )
104  return static_cast<SCHEMATIC*>( parent );
105  else
106  parent = parent->GetParent();
107  }
108 
109  return nullptr;
110 }
EDA_ITEM * GetParent() const
Definition: eda_item.h:165
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:150
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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

Referenced by SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_FIELD::DoHypertextMenu(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::getEffectiveShape(), 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_TEXT::GetTextOffset(), inheritNetclass(), SCH_SHEET::IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), SCH_GLOBALLABEL::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_SHEET::ResolveTextVar(), ResolveTextVar(), SCH_GLOBALLABEL::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 42 of file inspectable.h.

43  {
45  TYPE_ID thisType = TYPE_HASH( *this );
46  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
47 
48  if( object )
49  aProperty->setter( object, aValue );
50 
51  return object != nullptr;
52  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
virtual void setter(void *aObject, wxAny &aValue)=0
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

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

Referenced by isCoupledDiffPair().

◆ Set() [2/3]

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

Definition at line 55 of file inspectable.h.

56  {
58  TYPE_ID thisType = TYPE_HASH( *this );
59  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
60 
61  if( object )
62  aProperty->set<T>( object, aValue );
63 
64  return object != nullptr;
65  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
void set(void *aObject, T aValue)
Definition: property.h:261
virtual size_t OwnerHash() const =0
Return 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 68 of file inspectable.h.

69  {
71  TYPE_ID thisType = TYPE_HASH( *this );
72  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
73  void* object = nullptr;
74 
75  if( prop )
76  {
77  object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
78 
79  if( object )
80  prop->set<T>( object, aValue );
81  }
82 
83  return object != nullptr;
84  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
void set(void *aObject, T aValue)
Definition: property.h:261
virtual size_t OwnerHash() const =0
Return 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()

void EDA_ITEM::SetBrightened ( )
inlineinherited

◆ SetConnectivityDirty()

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

Definition at line 426 of file sch_item.h.

426 { m_connectivity_dirty = aDirty; }
bool m_connectivity_dirty
Definition: sch_item.h:508

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetConvert()

void SCH_COMPONENT::SetConvert ( int  aConvert)

Definition at line 338 of file sch_symbol.cpp.

339 {
340  if( m_convert != aConvert )
341  {
342  m_convert = aConvert;
343 
344  // The convert may have a different pin layout so the update the pin map.
345  UpdatePins();
346  SetModified();
347  }
348 }
void SetModified()
Definition: eda_item.cpp:63
int m_convert
The alternate body style for symbols that have more than one body style defined.
Definition: sch_symbol.h:675
void UpdatePins()
Updates the cache of SCH_PIN objects for each pin.
Definition: sch_symbol.cpp:275

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

Referenced by SCH_EDIT_FRAME::ConvertPart(), and DIALOG_SYMBOL_PROPERTIES::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 400 of file sch_symbol.h.

401  {
402  m_fields = aFields; // vector copying, length is changed possibly
403  }
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693

References m_fields.

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )
inlineinherited

Definition at line 435 of file sch_item.h.

References FIELDS_AUTOPLACED_AUTO, and SCH_ITEM::m_fieldsAutoplaced.

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 203 of file eda_item.h.

203 { m_flags |= aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References EDA_ITEM::m_flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SCH_MOVE_TOOL::AlignElements(), PCB_CONTROL::AppendBoard(), FOOTPRINT::BuildPolyCourtyards(), SCH_EDIT_TOOL::ChangeTextType(), GRAPHICS_CLEANER::cleanupSegments(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::EnterGroup(), SCH_MOVE_TOOL::getConnectedDragItems(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EE_SELECTION_TOOL::Main(), TRACKS_CLEANER::mergeCollinearSegments(), SYMBOL_EDITOR_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), EE_SELECTION_TOOL::narrowSelection(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseJunction(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParseNoERC(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_ALTIUM_PLUGIN::ParseWire(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), 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(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SYMBOL_EDITOR_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 664 of file sch_symbol.cpp.

665 {
666  if( sheet == nullptr )
667  {
668  // Clear instance overrides and set primary field value
670  instance.m_Footprint = wxEmptyString;
671 
672  m_fields[ FOOTPRINT_FIELD ].SetText( aFootprint );
673  return;
674  }
675 
676  KIID_PATH path = sheet->Path();
677 
678  // check to see if it is already there before inserting it
680  {
681  if( instance.m_Path == path )
682  {
683  instance.m_Footprint = aFootprint;
684  return;
685  }
686  }
687 
688  // didn't find it; better add it
689  AddHierarchicalReference( path, m_prefix, m_unit, wxEmptyString, aFootprint );
690 }
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
A simple container for schematic symbol instance information.
int m_unit
The unit for multiple part per package symbols.
Definition: sch_symbol.h:674
std::vector< SYMBOL_INSTANCE_REFERENCE > m_instanceReferences
Definition: sch_symbol.h:706
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.
Definition: sch_symbol.cpp:391
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the symbol is.
Definition: sch_symbol.h:678
SCH_FIELDS m_fields
Variable length list of fields.
Definition: sch_symbol.h:693
Field Name Module PCB, i.e. "16DIP300".

References AddHierarchicalReference(), FOOTPRINT_FIELD, m_fields, m_instanceReferences, m_prefix, m_unit, SCH_SHEET_PATH::Path(), and path.

Referenced by BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SetFootprint(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), UpdateFields(), and SCH_EDITOR_CONTROL::updatePastedInstances().

◆ SetFootprint() [2/2]

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

Set the value for all instances (the default GUI behavior).

Definition at line 554 of file sch_symbol.h.

555  {
556  SetFootprint( nullptr, aFootprint );
557  }
void SetFootprint(const SCH_SHEET_PATH *sheet, const wxString &aFootprint)
Definition: sch_symbol.cpp:664

References SetFootprint().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

Set and clear 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 254 of file eda_item.h.

254 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: eda_item.h:530

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetIncludeInBom()

void SCH_COMPONENT::SetIncludeInBom ( bool  aIncludeInBom)
inline

Definition at line 660 of file sch_symbol.h.

660 { m_inBom = aIncludeInBom; }
bool m_inBom
True to include in bill of materials export.
Definition: sch_symbol.h:701

References m_inBom.

Referenced by DIALOG_CHANGE_SYMBOLS::processSymbol(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetIncludeOnBoard()

void SCH_COMPONENT::SetIncludeOnBoard ( bool  aIncludeOnBoard)
inline

Definition at line 663 of file sch_symbol.h.

663 { m_onBoard = aIncludeOnBoard; }
bool m_onBoard
True to include in netlist when updating board.
Definition: sch_symbol.h:702

References m_onBoard.

Referenced by DIALOG_CHANGE_SYMBOLS::processSymbol(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetLayer()

◆ SetLibId()

void SCH_COMPONENT::SetLibId ( const LIB_ID aName)

Definition at line 229 of file sch_symbol.cpp.

230 {
231  if( m_lib_id != aLibId )
232  {
233  m_lib_id = aLibId;
234  SetModified();
235  }
236 }
void SetModified()
Definition: eda_item.cpp:63
LIB_ID m_lib_id
Name and library the symbol was loaded from, i.e. 74xx:74LS00.
Definition: sch_symbol.h:673

References m_lib_id, and EDA_ITEM::SetModified().

Referenced by SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), 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 248 of file sch_symbol.cpp.

249 {
250  wxCHECK2( ( aLibSymbol == nullptr ) || ( aLibSymbol->IsRoot() ), aLibSymbol = nullptr );
251 
252  m_part.reset( aLibSymbol );
253  UpdatePins();
254 }
std::unique_ptr< LIB_PART > m_part
Definition: sch_symbol.h:695
bool IsRoot() const override
For symbols derived from other symbols, IsRoot() indicates no derivation.
Definition: lib_symbol.h:167
void UpdatePins()
Updates the cache of SCH_PIN objects for each pin.
Definition: sch_symbol.cpp:275

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

Referenced by SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EDITOR_CONTROL::Paste(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), and SCH_COMPONENT().

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

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

Definition at line 260 of file sch_item.h.

260 {}

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

Definition at line 63 of file eda_item.cpp.

64 {
66 
67  // If this a child object, then the parent modification state also needs to be set.
68  if( m_parent )
70 }
void SetModified()
Definition: eda_item.cpp:63
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:529
#define IS_CHANGED
Item was edited, and modified.
Definition: eda_item.h:103
void SetFlags(STATUS_FLAGS aMask)
Definition: eda_item.h:203

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

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), 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 1127 of file sch_symbol.cpp.

1128 {
1129  TRANSFORM temp = TRANSFORM();
1130  bool transform = false;
1131 
1132  switch( aOrientation )
1133  {
1134  case CMP_ORIENT_0:
1135  case CMP_NORMAL: // default transform matrix
1136  m_transform.x1 = 1;
1137  m_transform.y2 = -1;
1138  m_transform.x2 = m_transform.y1 = 0;
1139  break;
1140 
1141  case CMP_ROTATE_COUNTERCLOCKWISE: // Rotate + (incremental rotation)
1142  temp.x1 = temp.y2 = 0;
1143  temp.y1 = 1;
1144  temp.x2 = -1;
1145  transform = true;
1146  break;
1147 
1148  case CMP_ROTATE_CLOCKWISE: // Rotate - (incremental rotation)
1149  temp.x1 = temp.y2 = 0;
1150  temp.y1 = -1;
1151  temp.x2 = 1;
1152  transform = true;
1153  break;
1154 
1155  case CMP_MIRROR_Y: // Mirror Y (incremental rotation)
1156  temp.x1 = -1;
1157  temp.y2 = 1;
1158  temp.y1 = temp.x2 = 0;
1159  transform = true;
1160  break;
1161 
1162  case CMP_MIRROR_X: // Mirror X (incremental rotation)
1163  temp.x1 = 1;
1164  temp.y2 = -1;
1165  temp.y1 = temp.x2 = 0;
1166  transform = true;
1167  break;
1168 
1169  case CMP_ORIENT_90:
1172  break;
1173 
1174  case CMP_ORIENT_180:
1178  break;
1179 
1180  case CMP_ORIENT_270:
1183  break;
1184 
1185  case ( CMP_ORIENT_0 + CMP_MIRROR_X ):
1188  break;
1189 
1190  case ( CMP_ORIENT_0 + CMP_MIRROR_Y ):
1193  break;
1194 
1195  case ( CMP_ORIENT_90 + CMP_MIRROR_X ):
1198  break;
1199 
1200  case ( CMP_ORIENT_90 + CMP_MIRROR_Y ):
1203  break;
1204 
1205  case ( CMP_ORIENT_180 + CMP_MIRROR_X ):
1208  break;
1209 
1210  case ( CMP_ORIENT_180 + CMP_MIRROR_Y ):
1213  break;
1214 
1215  case ( CMP_ORIENT_270 + CMP_MIRROR_X ):
1218  break;
1219 
1220  case ( CMP_ORIENT_270 + CMP_MIRROR_Y ):
1223  break;
1224 
1225  default:
1226  transform = false;
1227  wxFAIL_MSG( "Invalid schematic symbol orientation type." );
1228  break;
1229  }
1230 
1231  if( transform )
1232  {
1233  /* The new matrix transform is the old matrix transform modified by the
1234  * requested transformation, which is the temp transform (rot,
1235  * mirror ..) in order to have (in term of matrix transform):
1236  * transform coord = new_m_transform * coord
1237  * where transform coord is the coord modified by new_m_transform from
1238  * the initial value coord.
1239  * new_m_transform is computed (from old_m_transform and temp) to
1240  * have:
1241  * transform coord = old_m_transform * temp
1242  */
1243  TRANSFORM newTransform;
1244 
1245  newTransform.x1 = m_transform.x1 * temp.x1 + m_transform.x2 * temp.y1;
1246  newTransform.y1 = m_transform.y1 * temp.x1 + m_transform.y2 * temp.y1;
1247  newTransform.x2 = m_transform.x1 * temp.x2 + m_transform.x2 * temp.y2;
1248  newTransform.y2 = m_transform.y1 * temp.x2 + m_transform.y2 * temp.y2;
1249  m_transform = newTransform;
1250  }
1251 }
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.
Definition: sch_symbol.h:692
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(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_EDIT_TOOL::Mirror(), MirrorHorizontally(), MirrorVertically(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EDIT_TOOL::Rotate(), Rotate(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Reimplemented in DIMENSION_BASE.

Definition at line 166 of file eda_item.h.

166 { m_parent = aParent; }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:529

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_PART::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_PART::LIB_PART(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), FOOTPRINT::operator=(), LIB_PART::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), 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_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_SHEET::SwapData(), SCH_GLOBALLABEL::SwapData(), SwapData(), and SwapItemData().

◆ SetPosition()

void SCH_COMPONENT::SetPosition ( const wxPoint &  aPosition)
inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 642 of file sch_symbol.h.

642 { Move( aPosition - m_pos ); }
void Move(const wxPoint &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_symbol.h:561
wxPoint m_pos
Definition: sch_symbol.h:672

References m_pos, and Move().

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), and SCH_DRAWING_TOOLS::PlaceSymbol().

◆ SetPrefix()

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

Definition at line 229 of file sch_symbol.h.

229 { m_prefix = aPrefix; }
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the symbol is.
Definition: sch_symbol.h:678

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 482 of file sch_symbol.cpp.

483 {
484  KIID_PATH path = sheet->Path();
485  bool notInArray = true;
486 
487  // check to see if it is already there before inserting it
489  {
490  if( instance.m_Path == path )
491  {
492  instance.m_Reference = ref;
493  notInArray = false;
494  }
495  }
496 
497  if( notInArray )
499 
500  for( std::unique_ptr<SCH_PIN>& pin : m_pins )
501  pin->ClearDefaultNetName( sheet );
502 
504 
505  // @todo Should we really be checking for what is a "reasonable" position?
506  if( rf->GetText().IsEmpty()
507  || ( abs( rf->GetTextPos().x - m_pos.x ) +
508  abs( rf->GetTextPos().y - m_pos.y ) > Mils2iu( 10000 ) ) )
509  {
510  // move it to a reasonable position
511  rf->SetTextPos( m_pos + wxPoint( Mils2iu( 50 ), Mils2iu( 50 ) ) );
512  }
513 
514  rf->SetText( ref ); // for drawing.
515 
516  // Reinit the m_prefix member if needed
517  wxString prefix = ref;
518 
519  if( IsReferenceStringValid( prefix ) )
520  {
521  while( prefix.Last() == '?' || wxIsdigit( prefix.Last() ) )
522  prefix.RemoveLast();
523  }
524  else
525  {
526  prefix = wxT( "U" ); // Set to default ref prefix
527  }
528 
529  if( m_prefix != prefix )
530  m_prefix = prefix;
531 
532  // Power symbols have references starting with # and are not included in netlists
533  m_isInNetlist = ! ref.StartsWith( wxT( "#" ) );
534 }
Field Reference of part, i.e. "IC21".
Instances are attached to a symbol or sheet and provide a place for the component's value,...
Definition: sch_field.h:50
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:693
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:253
wxPoint m_pos
Definition: sch_symbol.h:672
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:121
bool m_isInNetlist
True if the symbol should appear in the netlist.
Definition: sch_symbol.h:700
A simple container for schematic symbol instance information.