KiCad PCB EDA Suite
SCH_COMPONENT Class Reference

Class SCH_COMPONENT describes a real schematic component. More...

#include <sch_component.h>

Inheritance diagram for SCH_COMPONENT:
SCH_ITEM EDA_ITEM KIGFX::VIEW_ITEM

Public Types

enum  AUTOPLACED { AUTOPLACED_NO = 0, AUTOPLACED_AUTO, AUTOPLACED_MANUAL }
 

Public Member Functions

 SCH_COMPONENT (const wxPoint &pos=wxPoint(0, 0), SCH_ITEM *aParent=NULL)
 
 SCH_COMPONENT (LIB_PART &aPart, SCH_SHEET_PATH *aSheet, int unit=0, int convert=0, const wxPoint &pos=wxPoint(0, 0), bool setNewItemFlag=false)
 Create schematic component from library component object. More...
 
 SCH_COMPONENT (const SCH_COMPONENT &aComponent)
 Clones aComponent into a new schematic symbol object. More...
 
 ~SCH_COMPONENT ()
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
const wxArrayString & GetPathsAndReferences () const
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
bool IsMovableFromAnchorPoint () override
 Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor. More...
 
void SetLibId (const LIB_ID &aName, PART_LIBS *aLibs=NULL)
 
void SetLibId (const LIB_ID &aLibId, SYMBOL_LIB_TABLE *aSymLibTable, PART_LIB *aCacheLib)
 
const LIB_IDGetLibId () const
 
PART_REFGetPartRef ()
 
wxString GetAliasDescription () const
 Return information about the aliased parts. More...
 
wxString GetAliasDocumentation () const
 Return the documentation text for the given part alias. More...
 
bool Resolve (PART_LIBS *aLibs)
 Assigns the current LIB_PART from aLibs which this symbol is based on. More...
 
bool Resolve (SYMBOL_LIB_TABLE &aLibTable, PART_LIB *aCacheLib=NULL)
 
int GetUnit () const
 
void UpdatePinCache ()
 Updates the local cache of pin positions. More...
 
void SetUnit (int aUnit)
 Change the unit number to aUnit. More...
 
void UpdateUnit (int aUnit)
 Change the unit number to aUnit without setting any internal flags. More...
 
int GetConvert () const
 
void SetConvert (int aConvert)
 
wxString GetPrefix () const
 
void SetPrefix (const wxString &aPrefix)
 
TRANSFORMGetTransform () const
 
void SetTransform (const TRANSFORM &aTransform)
 
int GetUnitCount () const
 Return the number of units per package of the symbol. More...
 
void SetOrientation (int aOrientation)
 Compute the new transform matrix based on aOrientation for the symbol which is applied to the current transform. More...
 
int GetOrientation ()
 Get the display symbol orientation. More...
 
wxPoint GetScreenCoord (const wxPoint &aPoint)
 Returns the coordinate points relative to the orientation of the symbol to aPoint. More...
 
void GetMsgPanelInfo (EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
void ClearAnnotation (SCH_SHEET_PATH *aSheetPath)
 Clear exiting component annotation. More...
 
bool AddSheetPathReferenceEntryIfMissing (const wxString &aSheetPathName)
 Add aSheetPath in m_PathsAndReferences alternate references list, if this entry does not exist Do nothing if already exists. More...
 
void SetTimeStamp (timestamp_t aNewTimeStamp)
 Change the time stamp to aNewTimeStamp and updates the reference path. More...
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
EDA_RECT GetBodyBoundingBox () const
 Return a bounding box for the symbol body but not the fields. More...
 
SCH_FIELDGetField (int aFieldNdx) const
 Returns 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)
 Populates a std::vector with SCH_FIELDs. More...
 
SCH_FIELDAddField (const SCH_FIELD &aField)
 Add a field to the symbol. More...
 
void RemoveField (const wxString &aFieldName)
 Removes a user field from the symbol. More...
 
SCH_FIELDFindField (const wxString &aFieldName, bool aIncludeDefaultFields=true)
 Search for a SCH_FIELD with aFieldName. More...
 
void SetFields (const SCH_FIELDS &aFields)
 Set multiple schematic fields. More...
 
void UpdateFields (bool aResetStyle, bool aResetRef=false)
 Restores fields to the original library values. More...
 
int GetFieldCount () const
 Return the number of fields in this symbol. More...
 
AUTOPLACED GetFieldsAutoplaced () const
 Return whether the fields have been automatically placed. More...
 
void ClearFieldsAutoplaced ()
 Set fields automatically placed flag false. More...
 
void AutoplaceFields (SCH_SCREEN *aScreen, bool aManual)
 Automatically orient all the fields in the component. More...
 
void AutoAutoplaceFields (SCH_SCREEN *aScreen)
 Autoplace fields only if correct to do so automatically. More...
 
LIB_PINGetPin (const wxString &number)
 Find a symbol pin by number. More...
 
void GetPins (std::vector< LIB_PIN * > &aPinsList)
 Populate a vector with all the pins. More...
 
std::vector< bool > * GetDanglingPinFlags ()
 
void Draw (EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, GR_DRAWMODE aDrawMode, COLOR4D aColor=COLOR4D::UNSPECIFIED) override
 Function Draw Draw a schematic item. More...
 
void Draw (EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, GR_DRAWMODE aDrawMode, COLOR4D aColor, bool aDrawPinText)
 Draw a component with or without pin text. More...
 
void SwapData (SCH_ITEM *aItem) override
 Function SwapData swap the internal data structures aItem with the schematic item. More...
 
wxString GetPath (const SCH_SHEET_PATH *sheet) const
 
void SetCurrentSheetPath (const SCH_SHEET_PATH *aSheetPath)
 
const wxString GetRef (const SCH_SHEET_PATH *aSheet)
 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...
 
void AddHierarchicalReference (const wxString &aPath, const wxString &aRef, int aMulti)
 Add a full hierarchical reference to this symbol. More...
 
int GetUnitSelection (SCH_SHEET_PATH *aSheet)
 
void SetUnitSelection (SCH_SHEET_PATH *aSheet, int aUnitSelection)
 
void Move (const wxPoint &aMoveVector) override
 Function Move moves the item by aMoveVector to a new position. More...
 
void MirrorY (int aYaxis_position) override
 Function MirrorY mirrors item relative to the Y axis about aYaxis_position. More...
 
void MirrorX (int aXaxis_position) override
 Function MirrorX mirrors item relative to the X axis about aXaxis_position. More...
 
void Rotate (wxPoint aPosition) override
 Function Rotate rotates the item around aPosition 90 degrees in the clockwise direction. More...
 
bool Matches (wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation) override
 Function Matches compares the item against the search criteria in aSearchData. More...
 
void GetEndPoints (std::vector< DANGLING_END_ITEM > &aItemList) override
 Function GetEndPoints adds the schematic item end points to aItemList if the item has end points. More...
 
bool UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemList) override
 Test if the component's dangling state has changed for all pins. More...
 
wxPoint GetPinPhysicalPosition (const LIB_PIN *Pin) const
 
bool IsSelectStateChanged (const wxRect &aRect) override
 Function IsSelectStateChanged checks if the selection state of an item inside aRect has changed. More...
 
bool IsConnectable () const override
 Function IsConnectable returns true if the schematic item can connect to another schematic item. More...
 
bool CanConnect (const SCH_ITEM *aItem) const override
 
bool IsInNetlist () const
 
void GetConnectionPoints (std::vector< wxPoint > &aPoints) const override
 Function GetConnectionPoints add all the connection points for this item to aPoints. More...
 
SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
LIB_ITEMGetDrawItem (const wxPoint &aPosition, KICAD_T aType=TYPE_NOT_INIT)
 Return the component library item at aPosition that is part of this component. More...
 
wxString GetSelectMenuText (EDA_UNITS_T aUnits) const override
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAP_DEF GetMenuImage () const override
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
void GetNetListItem (NETLIST_OBJECT_LIST &aNetListItems, SCH_SHEET_PATH *aSheetPath) override
 Function GetNetListItem creates a new NETLIST_OBJECT for the schematic object and adds it to aNetListItems. More...
 
bool operator< (const SCH_ITEM &aItem) const override
 
bool operator== (const SCH_COMPONENT &aComponent) const
 
bool operator!= (const SCH_COMPONENT &aComponent) const
 
SCH_ITEMoperator= (const SCH_ITEM &aItem)
 
bool IsReplaceable () const override
 Function IsReplaceable. More...
 
wxPoint GetPosition () const override
 Function GetPosition. More...
 
void SetPosition (const wxPoint &aPosition) override
 Function SetPosition set the schematic item position to aPosition. More...
 
bool HitTest (const wxPoint &aPosition, int aAccuracy) const override
 Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained=false, int aAccuracy=0) const override
 Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
 
void Plot (PLOTTER *aPlotter) override
 Function Plot plots the schematic item to aPlotter. More...
 
EDA_ITEMClone () const override
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
SCH_ITEMNext () const
 
SCH_ITEMBack () const
 
wxPointGetStoredPos ()
 
void SetStoredPos (wxPoint aPos)
 
SCH_LAYER_ID GetLayer () const
 Function GetLayer returns the layer this item is on. More...
 
void SetLayer (SCH_LAYER_ID aLayer)
 Function SetLayer sets the layer this item is on. More...
 
virtual int GetPenSize () const
 Function GetPenSize virtual pure. More...
 
virtual bool Load (LINE_READER &aLine, wxString &aErrorMsg)
 Function Load reads a schematic item from aLine in a .sch file. More...
 
virtual bool IsDangling () const
 
void ClearConnections ()
 Function ClearConnections clears all of the connection items from the list. More...
 
bool IsConnected (const wxPoint &aPoint) const
 Function IsConnected tests the item to see if it is connected to aPoint. More...
 
virtual bool HitTest (const wxPoint &aPosition) const override
 Function HitTest tests if aPosition is contained within or on the bounding area of an item. More...
 
virtual bool CanIncrementLabel () const
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
KICAD_T Type () const
 Function Type() More...
 
timestamp_t GetTimeStamp () const
 
EDA_ITEMGetParent () const
 
DHEADGetList () const
 
void SetNext (EDA_ITEM *aNext)
 
void SetBack (EDA_ITEM *aBack)
 
void SetParent (EDA_ITEM *aParent)
 
void SetList (DHEAD *aList)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool IsType (const KICAD_T aScanTypes[])
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 

Static Public Member Functions

static void ResolveAll (const SCH_COLLECTOR &aComponents, PART_LIBS *aLibs)
 
static void ResolveAll (const SCH_COLLECTOR &aComponents, SYMBOL_LIB_TABLE &aLibTable, PART_LIB *aCacheLib=NULL)
 
static void UpdateAllPinCaches (const SCH_COLLECTOR &aComponents)
 Update the pin cache for all components in aComponents. More...
 
static bool IsReferenceStringValid (const wxString &aReferenceString)
 Tests for an acceptable reference string. More...
 
static std::string FormatInternalUnits (int aValue)
 Function FormatInternalUnits converts aValue from schematic internal units to a string appropriate for writing to file. More...
 
static std::string FormatInternalUnits (const wxPoint &aPoint)
 
static std::string FormatInternalUnits (const wxSize &aSize)
 
static std::string FormatAngle (double aAngle)
 Function FormatAngle converts aAngle from board units to a string appropriate for writing to file. More...
 
static SEARCH_RESULT IterateForward (EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Protected Member Functions

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

Protected Attributes

SCH_LAYER_ID m_Layer
 
EDA_ITEMS m_connections
 List of items connected to this item. More...
 
wxPoint m_storedPos
 a temporary variable used in some move commands

to store a initial pos (of the item or mouse cursor)

More...
 
EDA_ITEMPnext
 next in linked list More...
 
EDA_ITEMPback
 previous in linked list More...
 
DHEADm_List
 which DLIST I am on. More...
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
timestamp_t m_TimeStamp
 Time stamp used for logical links. More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Private Member Functions

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

Private Attributes

wxPoint m_Pos
 Name and library where symbol was loaded from, i.e. "74xx:74LS00". More...
 
LIB_ID m_lib_id
 
int m_unit
 The unit for multiple part per package components. More...
 
int m_convert
 The alternate body style for components that have more than one body style defined. More...
 
wxString m_prefix
 C, R, U, Q etc - the first character which typically indicates what the component is. More...
 
TRANSFORM m_transform
 The rotation/mirror transformation matrix. More...
 
SCH_FIELDS m_Fields
 Variable length list of fields. More...
 
PART_REF m_part
 points into the PROJECT's libraries to the LIB_PART for this component More...
 
std::vector< bool > m_isDangling
 One isDangling per pin. More...
 
std::vector< wxPointm_Pins
 
AUTOPLACED m_fieldsAutoplaced
 indicates status of field autoplacement More...
 
const SCH_SHEET_PATHm_currentSheetPath
 A temporary sheet path is required to generate the correct reference designator string in complex hierarchies. More...
 
wxArrayString m_PathsAndReferences
 Defines the hierarchical path and reference of the component. More...
 

Detailed Description

Class SCH_COMPONENT describes a real schematic component.

Definition at line 69 of file sch_component.h.

Member Enumeration Documentation

Enumerator
AUTOPLACED_NO 
AUTOPLACED_AUTO 
AUTOPLACED_MANUAL 

Definition at line 72 of file sch_component.h.

Constructor & Destructor Documentation

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

Definition at line 122 of file sch_component.cpp.

References AUTOPLACED_NO, Init(), m_currentSheetPath, and m_fieldsAutoplaced.

Referenced by Clone().

122  :
123  SCH_ITEM( aParent, SCH_COMPONENT_T )
124 {
125  Init( aPos );
126  m_currentSheetPath = NULL;
128 }
const SCH_SHEET_PATH * m_currentSheetPath
A temporary sheet path is required to generate the correct reference designator string in complex hie...
void Init(const wxPoint &pos=wxPoint(0, 0))
AUTOPLACED m_fieldsAutoplaced
indicates status of field autoplacement
Definition: sch_component.h:96
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
SCH_COMPONENT::SCH_COMPONENT ( LIB_PART aPart,
SCH_SHEET_PATH aSheet,
int  unit = 0,
int  convert = 0,
const wxPoint pos = wxPoint( 0, 0 ),
bool  setNewItemFlag = false 
)

Create schematic component from library component object.

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

Definition at line 131 of file sch_component.cpp.

References AUTOPLACED_NO, GetField(), GetLibId(), LIB_PART::GetName(), GetNewTimeStamp(), LIB_PART::GetReferenceField(), EDA_TEXT::GetText(), Init(), IS_MOVED, IS_NEW, m_convert, m_currentSheetPath, m_fieldsAutoplaced, EDA_ITEM::m_Flags, m_lib_id, m_part, m_prefix, m_unit, LIB_ID::SetLibItemName(), SetRef(), EDA_TEXT::SetText(), SetTimeStamp(), LIB_PART::SharedPtr(), UpdateFields(), UpdatePinCache(), and VALUE.

132  :
133  SCH_ITEM( NULL, SCH_COMPONENT_T )
134 {
135  Init( pos );
136 
137  m_unit = unit;
138  m_convert = convert;
139  m_lib_id.SetLibItemName( aPart.GetName(), false );
140  m_part = aPart.SharedPtr();
141  m_currentSheetPath = NULL;
143 
145 
146  if( setNewItemFlag )
147  m_Flags = IS_NEW | IS_MOVED;
148 
149  // Import user defined fields from the library component
150  UpdateFields( true, true );
151 
152  // Update the pin locations
153  UpdatePinCache();
154 
155  wxString msg = aPart.GetReferenceField().GetText();
156 
157  if( msg.IsEmpty() )
158  msg = wxT( "U" );
159 
160  m_prefix = msg;
161 
162  // update the reference -- just the prefix for now.
163  msg += wxT( "?" );
164  SetRef( sheet, msg );
165 
166  // Use the schematic component name instead of the library value field name.
167  GetField( VALUE )->SetText( GetLibId().GetLibItemName() );
168 }
void UpdateFields(bool aResetStyle, bool aResetRef=false)
Restores fields to the original library values.
void SetTimeStamp(timestamp_t aNewTimeStamp)
Change the time stamp to aNewTimeStamp and updates the reference path.
const SCH_SHEET_PATH * m_currentSheetPath
A temporary sheet path is required to generate the correct reference designator string in complex hie...
#define IS_NEW
New item, just created.
Definition: base_struct.h:114
timestamp_t GetNewTimeStamp()
Definition: common.cpp:212
void UpdatePinCache()
Updates the local cache of pin positions.
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
LIB_FIELD & GetReferenceField()
Return reference to the reference designator field.
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:143
PART_SPTR SharedPtr()
int SetLibItemName(const UTF8 &aLibItemName, bool aTestForRev=true)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:206
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
void Init(const wxPoint &pos=wxPoint(0, 0))
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
const LIB_ID & GetLibId() const
const wxString & GetName() const
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
AUTOPLACED m_fieldsAutoplaced
indicates status of field autoplacement
Definition: sch_component.h:96
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:84
#define VALUE
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
virtual void SetText(const wxString &aText)
Definition: eda_text.h:154
#define IS_MOVED
Item being moved.
Definition: base_struct.h:113
SCH_COMPONENT::SCH_COMPONENT ( const SCH_COMPONENT aComponent)

Clones aComponent into a new schematic symbol object.

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

Parameters
aComponentis the schematic symbol to clone.

Definition at line 171 of file sch_component.cpp.

References GetField(), GetFieldCount(), i, m_convert, m_currentSheetPath, m_Fields, m_fieldsAutoplaced, m_isDangling, m_lib_id, EDA_ITEM::m_Parent, m_part, m_PathsAndReferences, m_Pins, m_Pos, m_prefix, EDA_ITEM::m_TimeStamp, m_transform, m_unit, EDA_ITEM::SetParent(), and SetTimeStamp().

171  :
172  SCH_ITEM( aComponent )
173 {
174  m_currentSheetPath = NULL;
175  m_Parent = aComponent.m_Parent;
176  m_Pos = aComponent.m_Pos;
177  m_unit = aComponent.m_unit;
178  m_convert = aComponent.m_convert;
179  m_lib_id = aComponent.m_lib_id;
180  m_part = aComponent.m_part;
181  m_Pins = aComponent.m_Pins;
182 
183  SetTimeStamp( aComponent.m_TimeStamp );
184 
185  m_transform = aComponent.m_transform;
186  m_prefix = aComponent.m_prefix;
188  m_Fields = aComponent.m_Fields;
189 
190  // Re-parent the fields, which before this had aComponent as parent
191  for( int i = 0; i<GetFieldCount(); ++i )
192  {
193  GetField( i )->SetParent( this );
194  }
195 
196  m_isDangling = aComponent.m_isDangling;
198 }
void SetTimeStamp(timestamp_t aNewTimeStamp)
Change the time stamp to aNewTimeStamp and updates the reference path.
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:171
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:172
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
const SCH_SHEET_PATH * m_currentSheetPath
A temporary sheet path is required to generate the correct reference designator string in complex hie...
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
std::vector< bool > m_isDangling
One isDangling per pin.
Definition: sch_component.h:93
std::vector< wxPoint > m_Pins
Definition: sch_component.h:94
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:216
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
int GetFieldCount() const
Return the number of fields in this symbol.
size_t i
Definition: json11.cpp:597
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
AUTOPLACED m_fieldsAutoplaced
indicates status of field autoplacement
Definition: sch_component.h:96
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:84
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
SCH_COMPONENT::~SCH_COMPONENT ( )
inline

Definition at line 147 of file sch_component.h.

147 { }

Member Function Documentation

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 936 of file sch_component.cpp.

References m_Fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), GetTransform(), Init(), and UpdateFields().

937 {
938  int newNdx = m_Fields.size();
939 
940  m_Fields.push_back( aField );
941  return &m_Fields[newNdx];
942 }
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
void SCH_COMPONENT::AddHierarchicalReference ( const wxString &  aPath,
const wxString &  aRef,
int  aMulti 
)

Add a full hierarchical reference to this symbol.

Parameters
aPathis the hierarchical path (/&ltsheet timestamp&gt/&ltcomponent timestamp&gt like /05678E50/A23EF560)
aRefis the local reference like C45, R56
aMultiis the unit selection used for symbols with multiple units per package.

Definition at line 661 of file sch_component.cpp.

References m_PathsAndReferences.

Referenced by AddSheetPathReferenceEntryIfMissing(), SetCurrentSheetPath(), SetRef(), and SetUnitSelection().

664 {
665  wxString h_path, h_ref;
666  wxStringTokenizer tokenizer;
667  wxString separators( wxT( " " ) );
668 
669  // Search for an existing path and remove it if found (should not occur)
670  for( unsigned ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
671  {
672  tokenizer.SetString( m_PathsAndReferences[ii], separators );
673  h_path = tokenizer.GetNextToken();
674 
675  if( h_path.Cmp( aPath ) == 0 )
676  {
677  m_PathsAndReferences.RemoveAt( ii );
678  ii--;
679  }
680  }
681 
682  h_ref = aPath + wxT( " " ) + aRef;
683  h_ref << wxT( " " ) << aMulti;
684  m_PathsAndReferences.Add( h_ref );
685 }
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
bool SCH_COMPONENT::AddSheetPathReferenceEntryIfMissing ( const wxString &  aSheetPathName)

Add aSheetPath in m_PathsAndReferences alternate references list, if this entry does not exist Do nothing if already exists.

In component lists shared by more than one sheet path, an entry for each sheet path must exist to manage references

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

Definition at line 1135 of file sch_component.cpp.

References AddHierarchicalReference(), Format(), GetText(), EDA_ITEM::GetTimeStamp(), m_Fields, m_PathsAndReferences, m_unit, and REFERENCE.

Referenced by GetTransform().

1136 {
1137  // a empty sheet path is illegal:
1138  wxCHECK( !aSheetPathName.IsEmpty(), false );
1139 
1140  wxString reference_path;
1141 
1142  // The full component reference path is aSheetPathName + the component time stamp itself
1143  // full_AR_path is the alternate reference path to search
1144  wxString full_AR_path = aSheetPathName
1145  + wxString::Format( "%8.8lX", (unsigned long) GetTimeStamp() );
1146 
1147  for( unsigned int ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
1148  {
1149  // Break hierarchical reference in path, ref and multi selection:
1150  reference_path = m_PathsAndReferences[ii].BeforeFirst( ' ' );
1151 
1152  // if aSheetPath is found, nothing to do:
1153  if( reference_path.Cmp( full_AR_path ) == 0 )
1154  return false;
1155  }
1156 
1157  // This entry does not exist: add it, with a (temporary?) reference (last ref used for display)
1159  return true;
1160 }
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
Field Reference of part, i.e. "IC21".
wxString GetText(GRAPHIC_PINSHAPE shape)
Definition: pin_shape.cpp:33
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void AddHierarchicalReference(const wxString &aPath, const wxString &aRef, int aMulti)
Add a full hierarchical reference to this symbol.
timestamp_t GetTimeStamp() const
Definition: base_struct.h:207
void SCH_COMPONENT::AutoAutoplaceFields ( SCH_SCREEN aScreen)
inline

Autoplace fields only if correct to do so automatically.

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

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

Definition at line 435 of file sch_component.h.

References AutoplaceFields(), GetFieldsAutoplaced(), GetPin(), and GetPins().

Referenced by SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::OnOrient(), SCH_EDIT_FRAME::OnRotate(), and SCH_EDIT_FRAME::OnSelectUnit().

436  {
437  if( GetFieldsAutoplaced() )
439  }
AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Automatically orient all the fields in the component.
void SCH_COMPONENT::AutoplaceFields ( SCH_SCREEN aScreen,
bool  aManual 
)

Automatically orient all the fields in the component.

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

Definition at line 717 of file autoplace_fields.cpp.

References AUTOPLACER::DoAutoplace().

Referenced by AutoAutoplaceFields(), ClearFieldsAutoplaced(), SCH_EDIT_FRAME::Load_Component(), and SCH_EDIT_FRAME::OnAutoplaceFields().

718 {
719  if( aManual )
720  wxASSERT_MSG( aScreen, "A SCH_SCREEN pointer must be given for manual autoplacement" );
721  AUTOPLACER autoplacer( this, aScreen );
722  autoplacer.DoAutoplace( aManual );
724 }
AUTOPLACED m_fieldsAutoplaced
indicates status of field autoplacement
Definition: sch_component.h:96
SCH_ITEM* SCH_ITEM::Back ( ) const
inlineinherited

Definition at line 144 of file sch_item_struct.h.

Referenced by DrawSegment(), SCH_SHEET_PATH::FindPreviousItem(), and SCH_SHEET_LIST::FindPreviousItem().

144 { return static_cast<SCH_ITEM*>( Pback ); }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:168
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
bool SCH_COMPONENT::CanConnect ( const SCH_ITEM aItem) const
inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 584 of file sch_component.h.

References GetConnectionPoints(), GetDrawItem(), SCH_ITEM::GetLayer(), GetMenuImage(), GetNetListItem(), GetSelectMenuText(), IsInNetlist(), LAYER_WIRE, operator!=(), operator<(), operator=(), operator==(), SCH_JUNCTION_T, SCH_LINE_T, SCH_NO_CONNECT_T, EDA_ITEM::Type(), TYPE_NOT_INIT, and Visit().

585  {
586  return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
587  ( aItem->Type() == SCH_NO_CONNECT_T ) ||
588  ( aItem->Type() == SCH_JUNCTION_T );
589  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
virtual bool SCH_ITEM::CanIncrementLabel ( ) const
inlinevirtualinherited

Reimplemented in SCH_TEXT.

Definition at line 344 of file sch_item_struct.h.

Referenced by SCH_EDIT_FRAME::RepeatDrawItem().

344 { return false; }
void SCH_COMPONENT::ClearAnnotation ( SCH_SHEET_PATH aSheetPath)

Clear exiting component annotation.

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

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

Definition at line 1085 of file sch_component.cpp.

References GetPath(), IsReferenceStringValid(), m_Fields, m_part, m_PathsAndReferences, m_prefix, REFERENCE, and EDA_ITEM::SetModified().

Referenced by SCH_SCREEN::ClearAnnotation(), GetTransform(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), and SCH_EDIT_FRAME::PasteListOfItems().

1086 {
1087  wxArrayString reference_fields;
1088  static const wxChar separators[] = wxT( " " );
1089  PART_SPTR part = m_part.lock();
1090 
1091  // Build a reference with no annotation,
1092  // i.e. a reference ended by only one '?'
1093  wxString defRef = m_prefix;
1094 
1095  if( !IsReferenceStringValid( defRef ) )
1096  { // This is a malformed reference: reinit this reference
1097  m_prefix = defRef = wxT("U"); // Set to default ref prefix
1098  }
1099 
1100  while( defRef.Last() == '?' )
1101  defRef.RemoveLast();
1102 
1103  defRef.Append( wxT( "?" ) );
1104 
1105  wxString path;
1106 
1107  if( aSheetPath )
1108  path = GetPath( aSheetPath );
1109 
1110  for( unsigned int ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
1111  {
1112  // Break hierarchical reference in path, ref and multi selection:
1113  reference_fields = wxStringTokenize( m_PathsAndReferences[ii], separators );
1114 
1115  // For all components: if aSheetPath is not NULL,
1116  // remove annotation only for the given path
1117  if( aSheetPath == NULL || reference_fields[0].Cmp( path ) == 0 )
1118  {
1119  wxString NewHref = reference_fields[0];
1120  NewHref << wxT( " " ) << defRef << wxT( " " ) << reference_fields[2];
1121  m_PathsAndReferences[ii] = NewHref;
1122  }
1123  }
1124 
1125  // These 2 changes do not work in complex hierarchy.
1126  // When a clear annotation is made, the calling function must call a
1127  // UpdateAllScreenReferences for the active sheet.
1128  // But this call cannot made here.
1129  m_Fields[REFERENCE].SetText( defRef ); //for drawing.
1130 
1131  SetModified();
1132 }
void SetModified()
wxString GetPath(const SCH_SHEET_PATH *sheet) const
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
Field Reference of part, i.e. "IC21".
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
static bool IsReferenceStringValid(const wxString &aReferenceString)
Tests for an acceptable reference string.
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:84
void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 236 of file base_struct.h.

References BRIGHTENED, EDA_ITEM::ClearFlags(), and EDA_ITEM::SetModified().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::unhighlight().

236 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:138
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
void SCH_ITEM::ClearConnections ( )
inlineinherited

Function ClearConnections 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 304 of file sch_item_struct.h.

304 { m_connections.clear(); }
EDA_ITEMS m_connections
List of items connected to this item.
void SCH_COMPONENT::ClearFieldsAutoplaced ( )
inline

Set fields automatically placed flag false.

Definition at line 414 of file sch_component.h.

References AUTOPLACED_NO, and AutoplaceFields().

Referenced by SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::PrepareMoveItem(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

AUTOPLACED m_fieldsAutoplaced
indicates status of field autoplacement
Definition: sch_component.h:96
void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 257 of file base_struct.h.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_Move_Pad(), Abort_MoveOrCopyModule(), Abort_MoveTrack(), Abort_Zone_Create_Outline(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveAndEditTarget(), AbortMoveDimensionText(), abortMoveItem(), AbortMoveTextModule(), AbortPinMove(), SCH_SCREEN::addConnectedItemsToBlock(), SCH_EDIT_FRAME::addCurrentItemToScreen(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), LIB_EDIT_FRAME::BlockCopySelectedItems(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearHighlighted(), DRAG_LIST::ClearList(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::End_Edge(), FOOTPRINT_EDIT_FRAME::End_Edge_Module(), PCB_EDIT_FRAME::End_Move_Zone_Corner_Or_Outlines(), PCB_EDIT_FRAME::End_Route(), PCB_EDIT_FRAME::End_Zone(), EraseDragList(), PCB_EDIT_FRAME::Exchange_Module(), ExitSheet(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), IsSelectStateChanged(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), MarkItemsInBloc(), MirrorX(), MirrorY(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnOrient(), LIB_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_FIELD::Place(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_EDIT_FRAME::PlaceDimensionText(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::PlacePad(), PCB_EDIT_FRAME::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_BASE_FRAME::PlaceTexteModule(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), BOARD_COMMIT::Revert(), PCB_BASE_FRAME::Rotate_Module(), RotateListOfItems(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SetRepeatItem(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

257 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 235 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

235 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:137
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
void EDA_ITEM::ClearSelected ( )
inlineinherited

Definition at line 234 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), GAL_ARRAY_CREATOR::prePushAction(), SELECTION_TOOL::unhighlight(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

234 { ClearFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:121
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
EDA_ITEM * SCH_COMPONENT::Clone ( ) const
overridevirtual

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

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

Returns
A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 230 of file sch_component.cpp.

References SCH_COMPONENT().

Referenced by SetPosition().

231 {
232  return new SCH_COMPONENT( *this );
233 }
SCH_COMPONENT(const wxPoint &pos=wxPoint(0, 0), SCH_ITEM *aParent=NULL)
bool SCH_COMPONENT::doIsConnected ( const wxPoint aPosition) const
overrideprivatevirtual

Function doIsConnected provides the object specific test to see if it is connected to aPosition.

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

Reimplemented from SCH_ITEM.

Definition at line 1953 of file sch_component.cpp.

References TRANSFORM::InverseTransform(), m_Pins, m_Pos, m_transform, and TRANSFORM::TransformCoordinate().

Referenced by SetPosition().

1954 {
1955  wxPoint new_pos = m_transform.InverseTransform().TransformCoordinate( aPosition - m_Pos );
1956  return std::find( m_Pins.begin(), m_Pins.end(), new_pos ) != m_Pins.end();
1957 }
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
std::vector< wxPoint > m_Pins
Definition: sch_component.h:94
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
TRANSFORM InverseTransform() const
Calculate the Inverse mirror/rotation transform.
Definition: transform.cpp:58
void SCH_COMPONENT::Draw ( EDA_DRAW_PANEL aPanel,
wxDC *  aDC,
const wxPoint aOffset,
GR_DRAWMODE  aDrawMode,
COLOR4D  aColor = COLOR4D::UNSPECIFIED 
)
inlineoverridevirtual

Function Draw Draw a schematic item.

Each schematic item should have its own method

Parameters
aPanelDrawPanel to use (can be null) mainly used for clipping purposes.
aDCDevice Context (can be null)
aOffsetdrawing Offset (usually wxPoint(0,0), but can be different when moving an object)
aDrawModeGR_OR, GR_XOR, ...
aColorCOLOR4D::UNSPECIFIED to use the normal body item color, or force this color if it is a valid color

Implements SCH_ITEM.

Definition at line 463 of file sch_component.h.

References GetPath(), IsReferenceStringValid(), and SwapData().

465  {
466  Draw( aPanel, aDC, aOffset, aDrawMode, aColor, true );
467  }
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, GR_DRAWMODE aDrawMode, COLOR4D aColor=COLOR4D::UNSPECIFIED) override
Function Draw Draw a schematic item.
void SCH_COMPONENT::Draw ( EDA_DRAW_PANEL aPanel,
wxDC *  aDC,
const wxPoint aOffset,
GR_DRAWMODE  aDrawMode,
COLOR4D  aColor,
bool  aDrawPinText 
)

Draw a component with or without pin text.

Parameters
aPanelis the panel to use (can be null) mainly used for clipping purposes.
aDCis the device context (can be null)
aOffsetis the drawing offset (usually wxPoint(0,0), but can be different when moving an object)
aDrawModeis the drawing mode, GR_OR, GR_XOR, ...
aColoruse COLOR4D::UNSPECIFIED for the normal body item color or use this color if >= 0
aDrawPinTextuse true to draw pin texts, false to draw only the pin shape usually false to draw a component when moving it and true otherwise.

Definition at line 592 of file sch_component.cpp.

References boundingBox(), BROWN, PART_DRAW_OPTIONS::Default(), SCH_FIELD::Draw(), LIB_PART::Draw(), dummy(), SCH_FIELD::GetBoundingBox(), GetBoundingBox(), EDA_DRAW_PANEL::GetClipBox(), BASE_SCREEN::GetCurItem(), GetField(), GetFieldCount(), EDA_DRAW_PANEL::GetScreen(), GRRect(), EDA_DRAW_PANEL::IsMouseCaptured(), EDA_ITEM::IsMoving(), EDA_TEXT::IsVisible(), m_convert, m_isDangling, m_part, m_Pos, m_transform, m_unit, REFERENCE, and VALUE.

595 {
596  auto opts = PART_DRAW_OPTIONS::Default();
597  opts.draw_mode = aDrawMode;
598  opts.color = aColor;
599  opts.transform = m_transform;
600  opts.show_pin_text = aDrawPinText;
601  opts.draw_visible_fields = false;
602  opts.draw_hidden_fields = false;
603 
604  if( PART_SPTR part = m_part.lock() )
605  {
606  // Draw pin targets if part is being dragged
607  bool dragging = aPanel->GetScreen()->GetCurItem() == this && aPanel->IsMouseCaptured();
608 
609  if( !dragging )
610  {
611  opts.dangling = m_isDangling;
612  }
613 
614  part->Draw( aPanel, aDC, m_Pos + aOffset, m_unit, m_convert, opts );
615  }
616  else // Use dummy() part if the actual cannot be found.
617  {
618  dummy()->Draw( aPanel, aDC, m_Pos + aOffset, 0, 0, opts );
619  }
620 
621  SCH_FIELD* field = GetField( REFERENCE );
622 
623  if( field->IsVisible() && !field->IsMoving() )
624  {
625  field->Draw( aPanel, aDC, aOffset, aDrawMode );
626  }
627 
628  for( int ii = VALUE; ii < GetFieldCount(); ii++ )
629  {
630  field = GetField( ii );
631 
632  if( field->IsMoving() )
633  continue;
634 
635  field->Draw( aPanel, aDC, aOffset, aDrawMode );
636  }
637 
638 #if 0
639  // Only for testing purposes, draw the component bounding box
640  {
642  GRRect( aPanel->GetClipBox(), aDC, boundingBox, 0, BROWN );
643 #if 1
644  if( GetField( REFERENCE )->IsVisible() )
645  {
646  boundingBox = GetField( REFERENCE )->GetBoundingBox();
647  GRRect( aPanel->GetClipBox(), aDC, boundingBox, 0, BROWN );
648  }
649 
650  if( GetField( VALUE )->IsVisible() )
651  {
652  boundingBox = GetField( VALUE )->GetBoundingBox();
653  GRRect( aPanel->GetClipBox(), aDC, boundingBox, 0, BROWN );
654  }
655 #endif
656  }
657 #endif
658 }
virtual BASE_SCREEN * GetScreen()=0
Class SCH_FIELD instances are attached to a component and provide a place for the component&#39;s value...
Definition: sch_field.h:56
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDc, const wxPoint &aOffset, int aMulti, int aConvert, const PART_DRAW_OPTIONS &aOpts)
Draw part.
bool IsMoving() const
Definition: base_struct.h:221
EDA_ITEM * GetCurItem() const
Definition: base_screen.h:233
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, GR_DRAWMODE aDrawMode, COLOR4D aColor=COLOR4D::UNSPECIFIED) override
Function Draw Draw a schematic item.
Definition: sch_field.cpp:119
virtual EDA_RECT * GetClipBox()
std::vector< bool > m_isDangling
One isDangling per pin.
Definition: sch_component.h:93
Field Reference of part, i.e. "IC21".
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
BOX2I boundingBox(T aObject)
boundingBox template method
Definition: shape_index.h:59
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:1003
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
static PART_DRAW_OPTIONS Default()
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
int GetFieldCount() const
Return the number of fields in this symbol.
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
Definition: sch_field.cpp:252
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
bool IsVisible() const
Definition: eda_text.h:189
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
#define VALUE
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
Definition: colors.h:62
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 958 of file sch_component.cpp.

References i, m_Fields, and MANDATORY_FIELDS.

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

959 {
960  unsigned start = aIncludeDefaultFields ? 0 : MANDATORY_FIELDS;
961 
962  for( unsigned i = start; i<m_Fields.size(); ++i )
963  {
964  if( aFieldName == m_Fields[i].GetName( false ) )
965  {
966  return &m_Fields[i];
967  }
968  }
969 
970  return NULL;
971 }
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
size_t i
Definition: json11.cpp:597
std::string SCH_ITEM::FormatAngle ( double  aAngle)
staticinherited

Function FormatAngle converts aAngle from board units to a string appropriate for writing to file.

Note
Internal angles for board items can be either degrees or tenths of degree on how KiCad is built.
Parameters
aAngleA angle value to convert.
Returns
A std::string object containing the converted angle.

Definition at line 131 of file sch_item_struct.cpp.

132 {
133  char temp[50];
134  int len;
135 
136  len = snprintf( temp, sizeof(temp), "%.10g", aAngle / 10.0 );
137 
138  return std::string( temp, len );
139 }
std::string SCH_ITEM::FormatInternalUnits ( int  aValue)
staticinherited

Function FormatInternalUnits converts aValue from schematic internal units to a string appropriate for writing to file.

Parameters
aValueA coordinate value to convert.
Returns
A std::string object containing the converted value.

Definition at line 107 of file sch_item_struct.cpp.

Referenced by SCH_ITEM::FormatInternalUnits().

108 {
109  char buf[50];
110  double engUnits = aValue;
111  int len;
112 
113  if( engUnits != 0.0 && fabs( engUnits ) <= 0.0001 )
114  {
115  len = snprintf( buf, sizeof(buf), "%.10f", engUnits );
116 
117  while( --len > 0 && buf[len] == '0' )
118  buf[len] = '\0';
119 
120  ++len;
121  }
122  else
123  {
124  len = snprintf( buf, sizeof(buf), "%.10g", engUnits );
125  }
126 
127  return std::string( buf, len );
128 }
std::string SCH_ITEM::FormatInternalUnits ( const wxPoint aPoint)
staticinherited

Definition at line 142 of file sch_item_struct.cpp.

References SCH_ITEM::FormatInternalUnits(), wxPoint::x, and wxPoint::y.

143 {
144  return FormatInternalUnits( aPoint.x ) + " " + FormatInternalUnits( aPoint.y );
145 }
static std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from schematic internal units to a string appropriate fo...
std::string SCH_ITEM::FormatInternalUnits ( const wxSize &  aSize)
staticinherited

Definition at line 148 of file sch_item_struct.cpp.

References SCH_ITEM::FormatInternalUnits().

149 {
150  return FormatInternalUnits( aSize.GetWidth() ) + " " + FormatInternalUnits( aSize.GetHeight() );
151 }
static std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from schematic internal units to a string appropriate fo...
wxString SCH_COMPONENT::GetAliasDescription ( ) const

Return information about the aliased parts.

Definition at line 283 of file sch_component.cpp.

References LIB_ALIAS::GetDescription(), GetLibId(), and m_part.

Referenced by GetPartRef(), and NETLIST_EXPORTER_GENERIC::makeComponents().

284 {
285  if( PART_SPTR part = m_part.lock() )
286  {
287  LIB_ALIAS* alias = part->GetAlias( GetLibId().GetLibItemName() );
288 
289  if( !alias )
290  return wxEmptyString;
291 
292  return alias->GetDescription();
293  }
294 
295  return wxEmptyString;
296 }
Part library alias object definition.
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
const wxString & GetDescription() override
const LIB_ID & GetLibId() const
wxString SCH_COMPONENT::GetAliasDocumentation ( ) const

Return the documentation text for the given part alias.

Definition at line 299 of file sch_component.cpp.

References LIB_ALIAS::GetDocFileName(), GetLibId(), and m_part.

Referenced by GetPartRef().

300 {
301  if( PART_SPTR part = m_part.lock() )
302  {
303  LIB_ALIAS* alias = part->GetAlias( GetLibId().GetLibItemName() );
304 
305  if( !alias )
306  return wxEmptyString;
307 
308  return alias->GetDocFileName();
309  }
310 
311  return wxEmptyString;
312 }
Part library alias object definition.
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
const wxString & GetDocFileName() const
const LIB_ID & GetLibId() const
EDA_RECT SCH_COMPONENT::GetBodyBoundingBox ( ) const

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

Definition at line 1365 of file sch_component.cpp.

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::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(), GetTransform(), HitTest(), and operator<().

1366 {
1367  EDA_RECT bBox;
1368 
1369  if( PART_SPTR part = m_part.lock() )
1370  {
1371  bBox = part->GetBodyBoundingBox( m_unit, m_convert );
1372  }
1373  else
1374  {
1375  bBox = dummy()->GetBodyBoundingBox( m_unit, m_convert );
1376  }
1377 
1378  int x0 = bBox.GetX();
1379  int xm = bBox.GetRight();
1380 
1381  // We must reverse Y values, because matrix orientation
1382  // suppose Y axis normal for the library items coordinates,
1383  // m_transform reverse Y values, but bBox is already reversed!
1384  int y0 = -bBox.GetY();
1385  int ym = -bBox.GetBottom();
1386 
1387  // Compute the real Boundary box (rotated, mirrored ...)
1388  int x1 = m_transform.x1 * x0 + m_transform.y1 * y0;
1389  int y1 = m_transform.x2 * x0 + m_transform.y2 * y0;
1390  int x2 = m_transform.x1 * xm + m_transform.y1 * ym;
1391  int y2 = m_transform.x2 * xm + m_transform.y2 * ym;
1392 
1393  // H and W must be > 0:
1394  if( x2 < x1 )
1395  std::swap( x2, x1 );
1396 
1397  if( y2 < y1 )
1398  std::swap( y2, y1 );
1399 
1400  bBox.SetX( x1 );
1401  bBox.SetY( y1 );
1402  bBox.SetWidth( x2 - x1 );
1403  bBox.SetHeight( y2 - y1 );
1404 
1405  bBox.Offset( m_Pos );
1406  return bBox;
1407 }
void Offset(int dx, int dy)
Definition: eda_rect.h:128
int y2
Definition: transform.h:51
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
const EDA_RECT GetBodyBoundingBox(int aUnit, int aConvert) const
Get the symbol bounding box excluding fields.
int x2
Definition: transform.h:50
int x1
Definition: transform.h:48
int y1
Definition: transform.h:49
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
void SetHeight(int val)
Definition: eda_rect.h:133
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
void SetX(int val)
Definition: eda_rect.h:130
int GetBottom() const
Definition: eda_rect.h:122
int GetRight() const
Definition: eda_rect.h:119
void SetWidth(int val)
Definition: eda_rect.h:132
void SetY(int val)
Definition: eda_rect.h:131
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int GetX() const
Definition: eda_rect.h:109
int GetY() const
Definition: eda_rect.h:110
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
const EDA_RECT SCH_COMPONENT::GetBoundingBox ( ) const
overridevirtual

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

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

Reimplemented from EDA_ITEM.

Definition at line 1410 of file sch_component.cpp.

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

Referenced by Draw(), GetTransform(), and IsSelectStateChanged().

1411 {
1412  EDA_RECT bbox = GetBodyBoundingBox();
1413 
1414  for( size_t i = 0; i < m_Fields.size(); i++ )
1415  {
1416  bbox.Merge( m_Fields[i].GetBoundingBox() );
1417  }
1418 
1419  return bbox;
1420 }
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect...
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
size_t i
Definition: json11.cpp:597
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
wxString SCH_COMPONENT::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from SCH_ITEM.

Definition at line 149 of file sch_component.h.

Referenced by GetScreenCoord(), and operator=().

150  {
151  return wxT( "SCH_COMPONENT" );
152  }
void SCH_COMPONENT::GetConnectionPoints ( std::vector< wxPoint > &  aPoints) const
overridevirtual

Function GetConnectionPoints add all the connection points for this item to aPoints.

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

Parameters
aPointsList of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 1684 of file sch_component.cpp.

References m_Pins, m_Pos, m_transform, and TRANSFORM::TransformCoordinate().

Referenced by CanConnect(), and SCH_EDIT_FRAME::importFile().

1685 {
1686  for( auto pin : m_Pins )
1687  aPoints.push_back( m_transform.TransformCoordinate( pin ) + m_Pos );
1688 }
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
std::vector< wxPoint > m_Pins
Definition: sch_component.h:94
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
std::vector<bool>* SCH_COMPONENT::GetDanglingPinFlags ( )
inline

Definition at line 461 of file sch_component.h.

References m_isDangling.

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

461 { return &m_isDangling; }
std::vector< bool > m_isDangling
One isDangling per pin.
Definition: sch_component.h:93
LIB_ITEM * SCH_COMPONENT::GetDrawItem ( const wxPoint aPosition,
KICAD_T  aType = TYPE_NOT_INIT 
)

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

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

Definition at line 1691 of file sch_component.cpp.

References LIB_PIN_T, m_convert, m_part, m_Pins, m_Pos, m_transform, and m_unit.

Referenced by CanConnect(), and SCH_SCREEN::GetPin().

1692 {
1693  if( PART_SPTR part = m_part.lock() )
1694  {
1695 
1696  m_Pins.clear();
1697 
1698  for( LIB_PIN* pin = part->GetNextPin(); pin; pin = part->GetNextPin( pin ) )
1699  {
1700  wxASSERT( pin->Type() == LIB_PIN_T );
1701 
1702  if( pin->GetUnit() && m_unit && ( m_unit != pin->GetUnit() ) )
1703  continue;
1704 
1705  if( pin->GetConvert() && m_convert && ( m_convert != pin->GetConvert() ) )
1706  continue;
1707 
1708  m_Pins.push_back( pin->GetPosition() );
1709  }
1710 
1711  // Calculate the position relative to the component.
1712  wxPoint libPosition = aPosition - m_Pos;
1713 
1714  return part->LocateDrawItem( m_unit, m_convert, aType, libPosition, m_transform );
1715  }
1716 
1717  return NULL;
1718 }
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
std::vector< wxPoint > m_Pins
Definition: sch_component.h:94
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
void SCH_COMPONENT::GetEndPoints ( std::vector< DANGLING_END_ITEM > &  aItemList)
overridevirtual

Function GetEndPoints adds the schematic item end points to aItemList if the item has end points.

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

Parameters
aItemList- List of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 1577 of file sch_component.cpp.

References GetPinPhysicalPosition(), LIB_PIN_T, m_convert, m_part, m_unit, and PIN_END.

Referenced by Move().

1578 {
1579  if( PART_SPTR part = m_part.lock() )
1580  {
1581  for( LIB_PIN* pin = part->GetNextPin(); pin; pin = part->GetNextPin( pin ) )
1582  {
1583  wxASSERT( pin->Type() == LIB_PIN_T );
1584 
1585  if( pin->GetUnit() && m_unit && ( m_unit != pin->GetUnit() ) )
1586  continue;
1587 
1588  if( pin->GetConvert() && m_convert && ( m_convert != pin->GetConvert() ) )
1589  continue;
1590 
1591  DANGLING_END_ITEM item( PIN_END, pin, GetPinPhysicalPosition( pin ), this );
1592  aItemList.push_back( item );
1593  }
1594  }
1595 }
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
Class DANGLING_END_ITEM is a helper class used to store the state of schematic items that can be conn...
wxPoint GetPinPhysicalPosition(const LIB_PIN *Pin) const
SCH_FIELD * SCH_COMPONENT::GetField ( int  aFieldNdx) const

Returns a field in this symbol.

Parameters
aFieldNdxis the index into the array of fields, not a field id.
Returns
is the field at aFieldNdx or NULL if the field does not exist.

Definition at line 898 of file sch_component.cpp.

References m_Fields.

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), SCH_EAGLE_PLUGIN::addImplicitConnections(), AddMenusForComponent(), SIM_PLOT_FRAME::AddTuner(), SCH_EDIT_FRAME::AnnotateComponents(), SCH_EDIT_FRAME::backAnnotateFootprints(), SCH_SHEET::ComponentCount(), Draw(), SCH_EDIT_FRAME::FindComponentAndItem(), FormatProbeItem(), SCH_SCREEN::GetItem(), LIB_PIN::GetMsgPanelInfo(), GetMsgPanelInfo(), GetRef(), GetScreenCoord(), GetSelectMenuText(), NETLIST_EXPORTER_PSPICE::GetSpiceFieldDefVal(), GetTransform(), SCH_EDIT_FRAME::importFile(), DIALOG_EDIT_COMPONENTS_LIBID::initDlg(), IsInNetlist(), SCH_EDIT_FRAME::Load_Component(), DIALOG_FIELDS_EDITOR_GLOBAL::LoadFieldNames(), SCH_EAGLE_PLUGIN::loadSchematic(), mapExistingAnnotation(), MirrorX(), MirrorY(), Move(), TUNER_SLIDER::onSave(), operator=(), operator==(), SCH_EDIT_FRAME::ProcessCmpToFootprintLinkFile(), Rotate(), SCH_LEGACY_PLUGIN::saveComponent(), SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SCREEN::SetComponentFootprint(), SetRef(), SCH_REFERENCE_LIST::sortByReferenceOnly(), SwapData(), TestMultiunitFootprints(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), TUNER_SLIDER::TUNER_SLIDER(), SCH_SHEET_PATH::UpdateAllScreenReferences(), UpdateFields(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), Visit(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

899 {
900  const SCH_FIELD* field;
901 
902  if( (unsigned) aFieldNdx < m_Fields.size() )
903  field = &m_Fields[aFieldNdx];
904  else
905  field = NULL;
906 
907  wxASSERT( field );
908 
909  // use cast to remove const-ness
910  return (SCH_FIELD*) field;
911 }
Class SCH_FIELD instances are attached to a component and provide a place for the component&#39;s value...
Definition: sch_field.h:56
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
void SCH_COMPONENT::GetFields ( std::vector< SCH_FIELD * > &  aVector,
bool  aVisibleOnly 
)

Populates a std::vector with SCH_FIELDs.

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

Definition at line 926 of file sch_component.cpp.

References m_Fields.

Referenced by AUTOPLACER::AUTOPLACER(), KIGFX::SCH_PAINTER::draw(), GetTransform(), and DIALOG_UPDATE_FIELDS::updateFields().

927 {
928  for( SCH_FIELD& each_field : m_Fields )
929  {
930  if( !aVisibleOnly || ( each_field.IsVisible() && !each_field.IsVoid() ) )
931  aVector.push_back( &each_field );
932  }
933 }
Class SCH_FIELD instances are attached to a component and provide a place for the component&#39;s value...
Definition: sch_field.h:56
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
AUTOPLACED SCH_COMPONENT::GetFieldsAutoplaced ( ) const
inline

Return whether the fields have been automatically placed.

Definition at line 409 of file sch_component.h.

References m_fieldsAutoplaced.

Referenced by AutoAutoplaceFields().

409 { return m_fieldsAutoplaced; }
AUTOPLACED m_fieldsAutoplaced
indicates status of field autoplacement
Definition: sch_component.h:96
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 914 of file sch_component.cpp.

References GetText(), and m_Fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), and GetTransform().

915 {
916  for( unsigned int ii = 0; ii < m_Fields.size(); ii++ )
917  {
918  if( aFieldName == m_Fields[ii].GetName() )
919  return m_Fields[ii].GetText();
920  }
921 
922  return wxEmptyString;
923 }
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
wxString GetText(GRAPHIC_PINSHAPE shape)
Definition: pin_shape.cpp:33
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 258 of file base_struct.h.

References EDA_ITEM::m_Flags.

Referenced by AbortMoveAndEditTarget(), SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForBitmap(), AddMenusForBusEntry(), AddMenusForComponent(), AddMenusForComponentField(), AddMenusForEditComponent(), AddMenusForGLabel(), AddMenusForHierchicalSheet(), AddMenusForHLabel(), AddMenusForLabel(), AddMenusForSheetPin(), AddMenusForText(), SCH_EDIT_FRAME::BeginSegment(), SCH_EDIT_FRAME::ChangeTextOrient(), Collect_TrackSegmentsToDrag(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), LIB_EDIT_FRAME::copySelectedItems(), LIB_EDIT_FRAME::CreatePin(), PCB_EDIT_FRAME::createPopUpMenuForFootprints(), PCB_EDIT_FRAME::createPopUpMenuForFpPads(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), PCB_EDIT_FRAME::createPopUpMenuForTexts(), PCB_EDIT_FRAME::createPopupMenuForTracks(), PCB_EDIT_FRAME::createPopUpMenuForZones(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteItem(), SCH_EDIT_FRAME::DeleteItemsInList(), SCH_EDIT_FRAME::DeleteJunction(), PCB_BASE_FRAME::DeleteTextModule(), BOARD::Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), SCH_EDIT_FRAME::GeneralControl(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_SCREEN::GetConnection(), InitialiseDragParameters(), EDA_DRAW_FRAME::isBusy(), Magnetize(), SCH_EDIT_FRAME::MirrorImage(), SCH_EDIT_FRAME::MirrorSheet(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyBeginRoute(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), EDA_DRAW_PANEL::OnMouseEvent(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_EDIT_FRAME::OrientComponent(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_EDIT_FRAME::RotateField(), SCH_EDIT_FRAME::RotateHierarchicalSheet(), SCH_EDIT_FRAME::RotateImage(), PCB_BASE_FRAME::RotateTextModule(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SCREEN::SelectBlockItems(), SCH_EDIT_FRAME::SetBusEntryShape(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

258 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited
BITMAP_DEF SCH_COMPONENT::GetMenuImage ( ) const
overridevirtual

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

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

Returns
The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 1506 of file sch_component.cpp.

Referenced by CanConnect().

1507 {
1508  return add_component_xpm;
1509 }
void SCH_COMPONENT::GetMsgPanelInfo ( EDA_UNITS_T  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

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

Note
This method replaces DisplayInfo() so that KiCad objects no longer have any knowledge of wxWidgets UI objects.
Parameters
aListis the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 1423 of file sch_component.cpp.

References BROWN, DARKCYAN, DARKRED, dummy(), UTF8::empty(), FOOTPRINT, Format(), LIB_ALIAS::GetDescription(), GetField(), LIB_ALIAS::GetKeyWords(), LIB_ALIAS::GetLib(), GetLibId(), LIB_ID::GetLibNickname(), LIB_ALIAS::GetLibNickname(), LIB_ALIAS::GetName(), GetRef(), EDA_TEXT::GetShownText(), PART_LIB::IsCache(), m_currentSheetPath, m_lib_id, m_part, RED, and VALUE.

Referenced by GetTransform(), and SCH_EDIT_FRAME::Load_Component().

1424 {
1425  wxString msg;
1426 
1427  // part and alias can differ if alias is not the root
1428  if( PART_SPTR part = m_part.lock() )
1429  {
1430  if( part.get() != dummy() )
1431  {
1432  LIB_ALIAS* alias = nullptr;
1433 
1434  if( part->GetLib() && part->GetLib()->IsCache() )
1435  alias = part->GetAlias( GetLibId().Format() );
1436  else
1437  alias = part->GetAlias( GetLibId().GetLibItemName() );
1438 
1439  if( !alias )
1440  return;
1441 
1442  if( m_currentSheetPath )
1443  aList.push_back( MSG_PANEL_ITEM( _( "Reference" ),
1445  DARKCYAN ) );
1446 
1447  msg = part->IsPower() ? _( "Power symbol" ) : _( "Value" );
1448 
1449  aList.push_back( MSG_PANEL_ITEM( msg, GetField( VALUE )->GetShownText(), DARKCYAN ) );
1450 
1451  // Display component reference in library and library
1452  aList.push_back( MSG_PANEL_ITEM( _( "Name" ), GetLibId().GetLibItemName(),
1453  BROWN ) );
1454 
1455  if( alias->GetName() != part->GetName() )
1456  aList.push_back( MSG_PANEL_ITEM( _( "Alias of" ), part->GetName(), BROWN ) );
1457 
1458  if( alias->GetLib() && alias->GetLib()->IsCache() )
1459  aList.push_back( MSG_PANEL_ITEM( _( "Library" ), alias->GetLibNickname(), RED ) );
1460  else if( !m_lib_id.GetLibNickname().empty() )
1461  aList.push_back( MSG_PANEL_ITEM( _( "Library" ), m_lib_id.GetLibNickname(),
1462  BROWN ) );
1463  else
1464  aList.push_back( MSG_PANEL_ITEM( _( "Library" ), _( "Undefined!!!" ), RED ) );
1465 
1466  // Display the current associated footprint, if exists.
1467  if( !GetField( FOOTPRINT )->IsVoid() )
1468  msg = GetField( FOOTPRINT )->GetShownText();
1469  else
1470  msg = _( "<Unknown>" );
1471 
1472  aList.push_back( MSG_PANEL_ITEM( _( "Footprint" ), msg, DARKRED ) );
1473 
1474  // Display description of the component, and keywords found in lib
1475  aList.push_back( MSG_PANEL_ITEM( _( "Description" ), alias->GetDescription(),
1476  DARKCYAN ) );
1477  aList.push_back( MSG_PANEL_ITEM( _( "Key words" ), alias->GetKeyWords(), DARKCYAN ) );
1478  }
1479  }
1480  else
1481  {
1482  if( m_currentSheetPath )
1483  aList.push_back( MSG_PANEL_ITEM( _( "Reference" ), GetRef( m_currentSheetPath ),
1484  DARKCYAN ) );
1485 
1486  aList.push_back( MSG_PANEL_ITEM( _( "Value" ), GetField( VALUE )->GetShownText(),
1487  DARKCYAN ) );
1488  aList.push_back( MSG_PANEL_ITEM( _( "Name" ), GetLibId().GetLibItemName(), BROWN ) );
1489 
1490  wxString libNickname = GetLibId().GetLibNickname();
1491 
1492  if( libNickname.empty() )
1493  {
1494  aList.push_back( MSG_PANEL_ITEM( _( "Library" ),
1495  _( "No library defined!!!" ), RED ) );
1496  }
1497  else
1498  {
1499  msg.Printf( _( "Symbol not found in %s!!!" ), libNickname );
1500  aList.push_back( MSG_PANEL_ITEM( _( "Library" ), msg , RED ) );
1501  }
1502  }
1503 }
Part library alias object definition.
const SCH_SHEET_PATH * m_currentSheetPath
A temporary sheet path is required to generate the correct reference designator string in complex hie...
bool IsCache() const
PART_LIB * GetLib()
Field Name Module PCB, i.e. "16DIP300".
Definition: colors.h:54
wxString GetLibNickname() const override
virtual wxString GetShownText() const
Returns the string actually shown after processing of the base text.
Definition: eda_text.h:148
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
bool empty() const
Definition: utf8.h:108
const wxString & GetKeyWords() const
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
Definition: colors.h:60
const wxString GetRef(const SCH_SHEET_PATH *aSheet)
Return the reference for the given sheet path.
const wxString & GetDescription() override
const wxString & GetName() const override
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
const LIB_ID & GetLibId() const
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
#define VALUE
Definition: colors.h:62
void SCH_COMPONENT::GetNetListItem ( NETLIST_OBJECT_LIST aNetListItems,
SCH_SHEET_PATH aSheetPath 
)
overridevirtual

Function GetNetListItem creates a new NETLIST_OBJECT for the schematic object and adds it to aNetListItems.

Not all schematic objects have net list items associated with them. This method only needs to be overridden for those schematic objects that have net list objects associated with them.

Reimplemented from SCH_ITEM.

Definition at line 1798 of file sch_component.cpp.

References GetConvert(), GetTransform(), GetUnitSelection(), LIB_PIN_T, NETLIST_OBJECT::m_Comp, NETLIST_OBJECT::m_ElectricalPinType, NETLIST_OBJECT::m_End, NETLIST_OBJECT::m_Label, NETLIST_OBJECT::m_Link, m_part, NETLIST_OBJECT::m_PinNum, m_Pos, NETLIST_OBJECT::m_SheetPath, NETLIST_OBJECT::m_SheetPathInclude, NETLIST_OBJECT::m_Start, NETLIST_OBJECT::m_Type, NET_PIN, NET_PINLABEL, and TRANSFORM::TransformCoordinate().

Referenced by CanConnect().

1800 {
1801  if( PART_SPTR part = m_part.lock() )
1802  {
1803  for( LIB_PIN* pin = part->GetNextPin(); pin; pin = part->GetNextPin( pin ) )
1804  {
1805  wxASSERT( pin->Type() == LIB_PIN_T );
1806 
1807  if( pin->GetUnit() && ( pin->GetUnit() != GetUnitSelection( aSheetPath ) ) )
1808  continue;
1809 
1810  if( pin->GetConvert() && ( pin->GetConvert() != GetConvert() ) )
1811  continue;
1812 
1813  wxPoint pos = GetTransform().TransformCoordinate( pin->GetPosition() ) + m_Pos;
1814 
1815  NETLIST_OBJECT* item = new NETLIST_OBJECT();
1816  item->m_SheetPathInclude = *aSheetPath;
1817  item->m_Comp = (SCH_ITEM*) pin;
1818  item->m_SheetPath = *aSheetPath;
1819  item->m_Type = NET_PIN;
1820  item->m_Link = (SCH_ITEM*) this;
1821  item->m_ElectricalPinType = pin->GetType();
1822  item->m_PinNum = pin->GetNumber();
1823  item->m_Label = pin->GetName();
1824  item->m_Start = item->m_End = pos;
1825 
1826  aNetListItems.push_back( item );
1827 
1828  if( pin->IsPowerConnection() )
1829  {
1830  // There is an associated PIN_LABEL.
1831  item = new NETLIST_OBJECT();
1832  item->m_SheetPathInclude = *aSheetPath;
1833  item->m_Comp = NULL;
1834  item->m_SheetPath = *aSheetPath;
1835  item->m_Type = NET_PINLABEL;
1836  item->m_Label = pin->GetName();
1837  item->m_Start = pos;
1838  item->m_End = item->m_Start;
1839 
1840  aNetListItems.push_back( item );
1841  }
1842  }
1843  }
1844 }
TRANSFORM & GetTransform() const
SCH_SHEET_PATH m_SheetPathInclude
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
int GetUnitSelection(SCH_SHEET_PATH *aSheet)
SCH_SHEET_PATH m_SheetPath
ELECTRICAL_PINTYPE m_ElectricalPinType
NETLIST_ITEM_T m_Type
EDA_ITEM * m_Comp
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
int GetConvert() const
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
SCH_ITEM * m_Link
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
int SCH_COMPONENT::GetOrientation ( )

Get the display symbol orientation.

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

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

Definition at line 1290 of file sch_component.cpp.

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

Referenced by KIGFX::SCH_PAINTER::draw(), AUTOPLACER::get_preferred_sides(), GetTransform(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow().

1291 {
1292  int rotate_values[] =
1293  {
1294  CMP_ORIENT_0,
1295  CMP_ORIENT_90,
1301  CMP_MIRROR_Y,
1302  CMP_MIRROR_Y + CMP_ORIENT_0,
1303  CMP_MIRROR_Y + CMP_ORIENT_90,
1304  CMP_MIRROR_Y + CMP_ORIENT_180,
1305  CMP_MIRROR_Y + CMP_ORIENT_270
1306  };
1307 
1308  // Try to find the current transform option:
1309  TRANSFORM transform = m_transform;
1310 
1311  for( int type_rotate : rotate_values )
1312  {
1313  SetOrientation( type_rotate );
1314 
1315  if( transform == m_transform )
1316  return type_rotate;
1317  }
1318 
1319  // Error: orientation not found in list (should not happen)
1320  wxMessageBox( wxT( "Component orientation matrix internal error" ) );
1321  m_transform = transform;
1322 
1323  return CMP_NORMAL;
1324 }
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
wxString SCH_COMPONENT::GetPath ( const SCH_SHEET_PATH sheet) const

Definition at line 688 of file sch_component.cpp.

References EDA_ITEM::m_TimeStamp, SCH_SHEET_PATH::Path(), and str.

Referenced by ClearAnnotation(), Draw(), GetRef(), GetUnitSelection(), SetRef(), SetUnitSelection(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

689 {
690  wxCHECK_MSG( sheet != NULL, wxEmptyString,
691  wxT( "Cannot get component path with invalid sheet object." ) );
692 
693  wxString str;
694 
695  str.Printf( wxT( "%8.8lX" ), (long unsigned) m_TimeStamp );
696  return sheet->Path() + str;
697 }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:172
const string & str
Definition: json11.cpp:596
wxString Path() const
Function Path the path uses the time stamps which do not changes even when editing sheet parameters a...
const wxArrayString& SCH_COMPONENT::GetPathsAndReferences ( ) const
inline

Definition at line 154 of file sch_component.h.

References m_PathsAndReferences, and ViewGetLayers().

Referenced by SCH_LEGACY_PLUGIN::saveComponent().

154 { return m_PathsAndReferences; }
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
virtual int SCH_ITEM::GetPenSize ( ) const
inlinevirtualinherited

Function GetPenSize virtual pure.

Returns
the size of the "pen" that be used to draw or plot this item

Reimplemented in SCH_SHEET, SCH_BUS_BUS_ENTRY, SCH_TEXT, SCH_BUS_WIRE_ENTRY, SCH_FIELD, SCH_SHEET_PIN, SCH_LINE, and SCH_NO_CONNECT.

Definition at line 182 of file sch_item_struct.h.

References MirrorX(), and MirrorY().

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_JUNCTION::GetBoundingBox(), SCH_BUS_WIRE_ENTRY::GetClass(), SCH_BUS_BUS_ENTRY::GetClass(), and SCH_BITMAP::Plot().

182 { return 0; }
LIB_PIN * SCH_COMPONENT::GetPin ( const wxString &  number)

Find a symbol pin by number.

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

Definition at line 1021 of file sch_component.cpp.

References m_convert, m_part, and m_unit.

Referenced by AutoAutoplaceFields(), and SCH_EDIT_FRAME::FindComponentAndItem().

1022 {
1023  if( PART_SPTR part = m_part.lock() )
1024  {
1025  return part->GetPin( number, m_unit, m_convert );
1026  }
1027  return NULL;
1028 }
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
wxPoint SCH_COMPONENT::GetPinPhysicalPosition ( const LIB_PIN Pin) const

Definition at line 1660 of file sch_component.cpp.

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

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

1661 {
1662  wxCHECK_MSG( Pin != NULL && Pin->Type() == LIB_PIN_T, wxPoint( 0, 0 ),
1663  wxT( "Cannot get physical position of pin." ) );
1664 
1665  return m_transform.TransformCoordinate( Pin->GetPosition() ) + m_Pos;
1666 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
wxPoint GetPosition() const override
Return the current draw object position.
Definition: lib_pin.h:463
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
void SCH_COMPONENT::GetPins ( std::vector< LIB_PIN * > &  aPinsList)

Populate a vector with all the pins.

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

Definition at line 1031 of file sch_component.cpp.

References m_convert, m_part, and m_unit.

Referenced by AutoAutoplaceFields(), and AUTOPLACER::pins_on_side().

1032 {
1033  if( m_part.expired() )
1034  {
1035  // no pins; nothing to get
1036  }
1037  else if( PART_SPTR part = m_part.lock() )
1038  {
1039  part->GetPins( aPinsList, m_unit, m_convert );
1040  }
1041  else
1042  wxFAIL_MSG( "Could not obtain PART_SPTR lock" );
1043 }
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
wxString SCH_COMPONENT::GetPrefix ( ) const
inline

Definition at line 239 of file sch_component.h.

References m_prefix.

Referenced by SCH_LEGACY_PLUGIN::saveComponent().

239 { return m_prefix; }
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:84
const wxString SCH_COMPONENT::GetRef ( const SCH_SHEET_PATH aSheet)

Return the reference for the given sheet path.

Returns
the reference for the sheet.

Definition at line 700 of file sch_component.cpp.

References GetField(), GetPath(), GetText(), EDA_TEXT::GetText(), m_PathsAndReferences, m_prefix, REFERENCE, and SetRef().

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), Diagnose(), NETLIST_EXPORTER::findAllUnitsOfComponent(), SCH_EDIT_FRAME::FindComponentAndItem(), NETLIST_EXPORTER::findNextComponent(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), SCH_SHEET_PATH::GetComponents(), GetMsgPanelInfo(), SCH_SHEET_PATH::GetMultiUnitComponents(), NETLIST_OBJECT::GetShortNetName(), NETLIST_EXPORTER_GENERIC::makeComponents(), NETLIST_EXPORTER_GENERIC::makeListOfNets(), SCH_FIELD::Matches(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SCREEN::SetComponentFootprint(), SetCurrentSheetPath(), TestMultiunitFootprints(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), NETLIST_EXPORTER_CADSTAR::writeListOfNets(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

701 {
702  wxString path = GetPath( sheet );
703  wxString h_path, h_ref;
704  wxStringTokenizer tokenizer;
705  wxString separators( wxT( " " ) );
706 
707  for( unsigned ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
708  {
709  tokenizer.SetString( m_PathsAndReferences[ii], separators );
710  h_path = tokenizer.GetNextToken();
711 
712  if( h_path.Cmp( path ) == 0 )
713  {
714  h_ref = tokenizer.GetNextToken();
715 
716  /* printf( "GetRef hpath: %s\n",
717  * TO_UTF8( m_PathsAndReferences[ii] ) ); */
718  return h_ref;
719  }
720  }
721 
722  // if it was not found in m_Paths array, then see if it is in
723  // m_Field[REFERENCE] -- if so, use this as a default for this path.
724  // this will happen if we load a version 1 schematic file.
725  // it will also mean that multiple instances of the same sheet by default
726  // all have the same component references, but perhaps this is best.
727  if( !GetField( REFERENCE )->GetText().IsEmpty() )
728  {
729  SetRef( sheet, GetField( REFERENCE )->GetText() );
730  return GetField( REFERENCE )->GetText();
731  }
732 
733  return m_prefix;
734 }
wxString GetPath(const SCH_SHEET_PATH *sheet) const
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
Field Reference of part, i.e. "IC21".
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:143
wxString GetText(GRAPHIC_PINSHAPE shape)
Definition: pin_shape.cpp:33
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:84
wxPoint SCH_COMPONENT::GetScreenCoord ( const wxPoint aPoint)

Returns the coordinate points relative to the orientation of the symbol to aPoint.

The coordinates are always relative to the anchor position of the component.

Parameters
aPointThe coordinates to transform.
Returns
The transformed point.

Definition at line 1327 of file sch_component.cpp.

References LIB_ID::Format(), GetClass(), GetField(), GetFieldCount(), GetLibId(), EDA_TEXT::GetText(), i, SCH_ITEM::m_Layer, m_Pos, m_transform, TO_UTF8, and TRANSFORM::TransformCoordinate().

Referenced by SCH_FIELD::Draw(), and GetTransform().

1328 {
1329  return m_transform.TransformCoordinate( aPoint );
1330 }
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
wxString SCH_COMPONENT::GetSelectMenuText ( EDA_UNITS_T  aUnits) const
overridevirtual

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

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

Returns
The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 1721 of file sch_component.cpp.

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

Referenced by CanConnect(), and Matches().

1722 {
1723  return wxString::Format( _( "Symbol %s, %s" ),
1724  GetLibId().GetLibItemName().wx_str(),
1725  GetField( REFERENCE )->GetShownText() );
1726 }
Field Reference of part, i.e. "IC21".
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
const LIB_ID & GetLibId() const
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 253 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format(), and GERBER_DRAW_ITEM::HitTest().

253 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:164
wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 155 of file sch_item_struct.h.

Referenced by moveItemWithMouseCursor().

155 { return m_storedPos; }
wxPoint m_storedPos
a temporary variable used in some move commands to store a initial pos (of the item or mouse cursor) ...
timestamp_t EDA_ITEM::GetTimeStamp ( ) const
inlineinherited

Definition at line 207 of file base_struct.h.

References EDA_ITEM::m_TimeStamp.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), AddSheetPathReferenceEntryIfMissing(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), PCB_EDIT_FRAME::Delete_OldZone_Fill(), PCB_EDIT_FRAME::Delete_Zone_Contour(), DuplicateStruct(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::format(), FormatProbeItem(), NETLIST_OBJECT::GetShortNetName(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), NETLIST_EXPORTER_GENERIC::makeComponents(), mapExistingAnnotation(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), SCH_SHEET_PATH::Path(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_REFERENCE::SCH_REFERENCE(), ZONE_FILLER_TOOL::SegzoneDeleteFill(), SortByTimeStamp(), SwapItemData(), DIALOG_SCH_SHEET_PROPS::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::~DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS().

207 { return m_TimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:172
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 581 of file sch_component.cpp.

References m_part.

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), SCH_EDIT_FRAME::AnnotateComponents(), SCH_FIELD::GetFullyQualifiedText(), GetTransform(), SCH_FIELD::Matches(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow().

582 {
583  if( PART_SPTR part = m_part.lock() )
584  {
585  return part->GetUnitCount();
586  }
587 
588  return 0;
589 }
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
int SCH_COMPONENT::GetUnitSelection ( SCH_SHEET_PATH aSheet)

Definition at line 835 of file sch_component.cpp.

References GetPath(), m_PathsAndReferences, and m_unit.

Referenced by NETLIST_EXPORTER::findAllUnitsOfComponent(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), GetNetListItem(), SCH_REFERENCE::SCH_REFERENCE(), SetCurrentSheetPath(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

836 {
837  wxString path = GetPath( aSheet );
838  wxString h_path, h_multi;
839  wxStringTokenizer tokenizer;
840  wxString separators( wxT( " " ) );
841 
842  for( unsigned ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
843  {
844  tokenizer.SetString( m_PathsAndReferences[ii], separators );
845  h_path = tokenizer.GetNextToken();
846 
847  if( h_path.Cmp( path ) == 0 )
848  {
849  tokenizer.GetNextToken(); // Skip reference
850  h_multi = tokenizer.GetNextToken();
851  long imulti = 1;
852  h_multi.ToLong( &imulti );
853  return imulti;
854  }
855  }
856 
857  // if it was not found in m_Paths array, then use m_unit.
858  // this will happen if we load a version 1 schematic file.
859  return m_unit;
860 }
wxString GetPath(const SCH_SHEET_PATH *sheet) const
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
virtual bool SCH_ITEM::HitTest ( const wxPoint aPosition) const
inlineoverridevirtualinherited

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

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
Returns
True if aPosition is within or on the item bounding area.

Reimplemented from EDA_ITEM.

Definition at line 315 of file sch_item_struct.h.

Referenced by SCH_SCREEN::addConnectedItemsToBlock().

316  {
317  return HitTest( aPosition, 0 );
318  }
virtual bool HitTest(const wxPoint &aPosition) const override
Function HitTest tests if aPosition is contained within or on the bounding area of an item...
bool SCH_COMPONENT::HitTest ( const wxPoint aPosition,
int  aAccuracy 
) const
overridevirtual

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

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

Reimplemented from SCH_ITEM.

Definition at line 1925 of file sch_component.cpp.

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

Referenced by SetPosition().

1926 {
1927  EDA_RECT bBox = GetBodyBoundingBox();
1928  bBox.Inflate( aAccuracy );
1929 
1930  if( bBox.Contains( aPosition ) )
1931  return true;
1932 
1933  return false;
1934 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
bool SCH_COMPONENT::HitTest ( const EDA_RECT aRect,
bool  aContained = false,
int  aAccuracy = 0 
) const
overridevirtual

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

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

Reimplemented from SCH_ITEM.

Definition at line 1937 of file sch_component.cpp.

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

1938 {
1940  return false;
1941 
1942  EDA_RECT rect = aRect;
1943 
1944  rect.Inflate( aAccuracy );
1945 
1946  if( aContained )
1947  return rect.Contains( GetBodyBoundingBox() );
1948 
1949  return rect.Intersects( GetBodyBoundingBox() );
1950 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:125
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:123
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
void SCH_COMPONENT::Init ( const wxPoint pos = wxPoint( 0, 0 ))
private

Definition at line 201 of file sch_component.cpp.

References AddField(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), i, LAYER_REFERENCEPART, LAYER_VALUEPART, m_convert, m_Pos, m_prefix, m_transform, m_unit, MANDATORY_FIELDS, REFERENCE, SCH_ITEM::SetLayer(), and VALUE.

Referenced by SCH_COMPONENT().

202 {
203  m_Pos = pos;
204  m_unit = 0; // In multi unit chip - which unit to draw.
205  m_convert = 0; // De Morgan Handling
206 
207  // The rotation/mirror transformation matrix. pos normal
209 
210  // construct only the mandatory fields, which are the first 4 only.
211  for( int i = 0; i < MANDATORY_FIELDS; ++i )
212  {
213  SCH_FIELD field( pos, i, this, TEMPLATE_FIELDNAME::GetDefaultFieldName( i ) );
214 
215  if( i == REFERENCE )
216  field.SetLayer( LAYER_REFERENCEPART );
217  else if( i == VALUE )
218  field.SetLayer( LAYER_VALUEPART );
219 
220  // else keep LAYER_FIELDS from SCH_FIELD constructor
221 
222  // SCH_FIELD's implicitly created copy constructor is called in here
223  AddField( field );
224  }
225 
226  m_prefix = wxString( wxT( "U" ) );
227 }
Class SCH_FIELD instances are attached to a component and provide a place for the component&#39;s value...
Definition: sch_field.h:56
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
static const wxString GetDefaultFieldName(int aFieldNdx)
Function GetDefaultFieldName returns a default symbol field name for field aFieldNdx for all componen...
Field Reference of part, i.e. "IC21".
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
SCH_FIELD * AddField(const SCH_FIELD &aField)
Add a field to the symbol.
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
size_t i
Definition: json11.cpp:597
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:84
#define VALUE
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 227 of file base_struct.h.

References BRIGHTENED.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::GERBVIEW_PAINTER::draw(), and KIGFX::PCB_RENDER_SETTINGS::GetColor().

227 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:138
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
bool SCH_COMPONENT::IsConnectable ( ) const
inlineoverridevirtual

Function IsConnectable returns true if the schematic item can connect to another schematic item.

Reimplemented from SCH_ITEM.

Definition at line 582 of file sch_component.h.

582 { return true; }
bool SCH_ITEM::IsConnected ( const wxPoint aPoint) const
inherited

Function IsConnected tests the item to see if it is connected to aPoint.

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

Definition at line 79 of file sch_item_struct.cpp.

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

Referenced by SCH_SCREEN::addConnectedItemsToBlock(), SCH_SCREEN::CountConnectedItems(), and SCH_SCREEN::IsTerminalPoint().

80 {
82  return false;
83 
84  return doIsConnected( aPosition );
85 }
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:125
virtual bool doIsConnected(const wxPoint &aPosition) const
Function doIsConnected provides the object specific test to see if it is connected to aPosition...
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:123
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
virtual bool SCH_ITEM::IsDangling ( ) const
inlinevirtualinherited

Reimplemented in SCH_TEXT, SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 265 of file sch_item_struct.h.

265 { return false; }
bool EDA_ITEM::IsDragging ( ) const
inlineinherited
bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 226 of file base_struct.h.

References HIGHLIGHTED.

226 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:137
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
bool SCH_COMPONENT::IsInNetlist ( ) const
Returns
true if the component is in netlist which means this is not a power component, or something like a component reference starting by #

Definition at line 1960 of file sch_component.cpp.

References GetField(), EDA_TEXT::GetText(), and REFERENCE.

Referenced by AUTOPLACER::AUTOPLACER(), CanConnect(), and NETLIST_OBJECT_LIST::findBestNetNameForEachNet().

1961 {
1962  SCH_FIELD* rf = GetField( REFERENCE );
1963  return ! rf->GetText().StartsWith( wxT( "#" ) );
1964 }
Class SCH_FIELD instances are attached to a component and provide a place for the component&#39;s value...
Definition: sch_field.h:56
Field Reference of part, i.e. "IC21".
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:143
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 220 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

220 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:110
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
bool SCH_COMPONENT::IsMovableFromAnchorPoint ( )
inlineoverridevirtual

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

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

Returns
false for a component

Reimplemented from SCH_ITEM.

Definition at line 167 of file sch_component.h.

References SetLibId().

167 { return false; }
bool EDA_ITEM::IsNew ( ) const
inlineinherited

Definition at line 219 of file base_struct.h.

References IS_NEW.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), Abort_Zone_Create_Outline(), AbortBuildDimension(), AbortMoveAndEditTarget(), abortMoveItem(), AbortPinMove(), AbortSymbolTraceOn(), SCH_EDIT_FRAME::addCurrentItemToScreen(), SCH_EDIT_FRAME::addJunctionMenuEntries(), AddMenusForBus(), AddMenusForWire(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteCurrentSegment(), LIB_ARC::drawEditGraphics(), LIB_ARC::drawGraphic(), LIB_PIN::EnableEditMode(), LIB_EDIT_FRAME::EndDrawGraphicItem(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), LIB_PART::LIB_PART(), EDIT_TOOL::MoveExact(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnHotKey(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_EDIT_FRAME::PlacePin(), PCB_EDIT_FRAME::PlaceTarget(), SCH_EDIT_FRAME::PrepareMoveItem(), SCH_EDIT_FRAME::ReSizeSheet(), ShowClearance(), PCB_EDIT_FRAME::StartMoveTextePcb(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_SCH_EDIT_SHEET_PIN::TransferDataFromWindow(), and DIALOG_LABEL_EDITOR::TransferDataFromWindow().

219 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:114
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
bool SCH_COMPONENT::IsReferenceStringValid ( const wxString &  aReferenceString)
static

Tests for an acceptable reference string.

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

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

Definition at line 737 of file sch_component.cpp.

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

738 {
739  wxString text = aReferenceString;
740  bool ok = true;
741 
742  // Try to unannotate this reference
743  while( !text.IsEmpty() && ( text.Last() == '?' || std::isdigit( text.Last().GetValue() ) ) )
744  text.RemoveLast();
745 
746  if( text.IsEmpty() )
747  ok = false;
748 
749  // Add here other constraints
750  // Currently:no other constraint
751 
752  return ok;
753 }
bool SCH_COMPONENT::IsReplaceable ( ) const
inlineoverridevirtual

Function IsReplaceable.

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

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

Reimplemented from EDA_ITEM.

Definition at line 626 of file sch_component.h.

626 { return true; }
bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 225 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

225 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:115
bool EDA_ITEM::IsSelected ( ) const
inlineinherited
bool SCH_COMPONENT::IsSelectStateChanged ( const wxRect &  aRect)
overridevirtual

Function IsSelectStateChanged checks if the selection state of an item inside aRect has changed.

This is used by the block selection code to verify if an item is selected or not. True is be return anytime the select state changes. If you need to know the the current selection state, use the IsSelected() method.

Parameters
aRect- Rectangle to test against.

Reimplemented from SCH_ITEM.

Definition at line 1669 of file sch_component.cpp.

References boundingBox(), EDA_ITEM::ClearFlags(), GetBoundingBox(), EDA_ITEM::IsSelected(), SELECTED, and EDA_ITEM::SetFlags().

Referenced by Move().

1670 {
1671  bool previousState = IsSelected();
1672 
1674 
1675  if( aRect.Intersects( boundingBox ) )
1676  SetFlags( SELECTED );
1677  else
1678  ClearFlags( SELECTED );
1679 
1680  return previousState != IsSelected();
1681 }
bool IsSelected() const
Definition: base_struct.h:224
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
BOX2I boundingBox(T aObject)
boundingBox template method
Definition: shape_index.h:59
#define SELECTED
Definition: base_struct.h:121
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[])
inlineinherited

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

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

Definition at line 266 of file base_struct.h.

References EOT.

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

Definition at line 223 of file base_struct.h.

References IS_WIRE_IMAGE.

Referenced by SCH_FIELD::Draw().

223 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:118
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
SEARCH_RESULT EDA_ITEM::IterateForward ( EDA_ITEM listStart,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
staticinherited

Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes.

Parameters
listStartThe first in a list of EDA_ITEMs to iterate over.
inspectorIs an INSPECTOR to call on each object that is one of the requested scanTypes.
testDataIs an aid to testFunc, and should be sufficient to allow it to fully determine if an item meets the match criteria, but it may also be used to collect output.
scanTypesA KICAD_T array that is EOT terminated, and provides both the order and interest level of of the types of objects to be iterated over.
Returns
SEARCH_RESULT SEARCH_QUIT if the called INSPECTOR returned SEARCH_QUIT, else SCAN_CONTINUE;

Definition at line 130 of file base_struct.cpp.

References EDA_ITEM::Pnext, SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Visit().

Referenced by SCH_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::Collect(), SCH_TYPE_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::GetItem(), EDA_ITEM::HitTest(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and BOARD::Visit().

134 {
135  EDA_ITEM* p = listStart;
136 
137  for( ; p; p = p->Pnext )
138  {
139  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
140  return SEARCH_QUIT;
141  }
142 
143  return SEARCH_CONTINUE;
144 }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:167
virtual bool SCH_ITEM::Load ( LINE_READER aLine,
wxString &  aErrorMsg 
)
inlinevirtualinherited

Function Load reads a schematic item from aLine in a .sch file.

Parameters
aLine- Essentially this is file to read the object from.
aErrorMsg- Description of the error if an error occurs while loading the object.
Returns
True if the object loaded successfully.

Definition at line 235 of file sch_item_struct.h.

235 { return false; }
bool EDA_ITEM::Matches ( const wxString &  aText,
wxFindReplaceData &  aSearchData 
)
protectedinherited

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

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

Definition at line 182 of file base_struct.cpp.

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

183 {
184  wxString text = aText;
185  wxString searchText = aSearchData.GetFindString();
186 
187  // Don't match if searching for replaceable item and the item doesn't support text replace.
188  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
189  return false;
190 
191  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
192  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
193 
194  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
195  {
196  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
197  return text.Matches( searchText );
198 
199  return text.MakeUpper().Matches( searchText.MakeUpper() );
200  }
201 
202  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
203  return aText.Find( searchText ) != wxNOT_FOUND;
204 
205  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
206 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:464
Perform search using simple wild card matching (* & ?).
Perform a search for a item that has replaceable text.
bool SCH_COMPONENT::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData,
wxPoint aFindLocation 
)
overridevirtual

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

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

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
aFindLocationA pointer to a wxPoint object to store the location of matched item. The pointer can be NULL if it is not used.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented from EDA_ITEM.

Definition at line 1567 of file sch_component.cpp.

References GetSelectMenuText(), MILLIMETRES, and traceFindItem.

Referenced by Move().

1569 {
1570  wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText( MILLIMETRES ) );
1571 
1572  // Components are searchable via the child field and pin item text.
1573  return false;
1574 }
wxString GetSelectMenuText(EDA_UNITS_T aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
const wxChar *const traceFindItem
Flag to enable find debug tracing.
void SCH_COMPONENT::MirrorX ( int  aXaxis_position)
overridevirtual

Function MirrorX mirrors item relative to the X axis about aXaxis_position.

Parameters
aXaxis_positionThe X axis position to mirror around.

Implements SCH_ITEM.

Definition at line 1530 of file sch_component.cpp.

References CMP_MIRROR_X, GetField(), GetFieldCount(), EDA_TEXT::GetTextPos(), m_Pos, MIRROR(), SetOrientation(), EDA_TEXT::SetTextPos(), and wxPoint::y.

Referenced by Move().

1531 {
1532  int dy = m_Pos.y;
1533 
1535  MIRROR( m_Pos.y, aXaxis_position );
1536  dy -= m_Pos.y; // dy,0 is the move vector for this transform
1537 
1538  for( int ii = 0; ii < GetFieldCount(); ii++ )
1539  {
1540  // Move the fields to the new position because the component itself has moved.
1541  wxPoint pos = GetField( ii )->GetTextPos();
1542  pos.y -= dy;
1543  GetField( ii )->SetTextPos( pos );
1544  }
1545 }
const wxPoint & GetTextPos() const
Definition: eda_text.h:237
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:236
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:111
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
int GetFieldCount() const
Return the number of fields in this symbol.
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
void SCH_COMPONENT::MirrorY ( int  aYaxis_position)
overridevirtual

Function MirrorY mirrors item relative to the Y axis about aYaxis_position.

Parameters
aYaxis_positionThe Y axis position to mirror around.

Implements SCH_ITEM.

Definition at line 1512 of file sch_component.cpp.

References CMP_MIRROR_Y, GetField(), GetFieldCount(), EDA_TEXT::GetTextPos(), m_Pos, MIRROR(), SetOrientation(), EDA_TEXT::SetTextPos(), and wxPoint::x.

Referenced by Move().

1513 {
1514  int dx = m_Pos.x;
1515 
1517  MIRROR( m_Pos.x, aYaxis_position );
1518  dx -= m_Pos.x; // dx,0 is the move vector for this transform
1519 
1520  for( int ii = 0; ii < GetFieldCount(); ii++ )
1521  {
1522  // Move the fields to the new position because the component itself has moved.
1523  wxPoint pos = GetField( ii )->GetTextPos();
1524  pos.x -= dx;
1525  GetField( ii )->SetTextPos( pos );
1526  }
1527 }
const wxPoint & GetTextPos() const
Definition: eda_text.h:237
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:236
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:111
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
int GetFieldCount() const
Return the number of fields in this symbol.
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
void SCH_COMPONENT::Move ( const wxPoint aMoveVector)
inlineoverridevirtual

Function Move moves the item by aMoveVector to a new position.

Parameters
aMoveVector= the displacement vector

Implements SCH_ITEM.

Definition at line 542 of file sch_component.h.

References GetEndPoints(), GetField(), GetFieldCount(), GetPinPhysicalPosition(), IsSelectStateChanged(), Matches(), MirrorX(), MirrorY(), SCH_FIELD::Move(), Rotate(), EDA_ITEM::SetModified(), and UpdateDanglingState().

Referenced by SetPosition().

543  {
544  if( aMoveVector == wxPoint( 0, 0 ) )
545  return;
546 
547  m_Pos += aMoveVector;
548 
549  for( int ii = 0; ii < GetFieldCount(); ii++ )
550  GetField( ii )->Move( aMoveVector );
551 
552  SetModified();
553  }
void Move(const wxPoint &aMoveVector) override
Function Move moves the item by aMoveVector to a new position.
Definition: sch_field.h:148
void SetModified()
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
int GetFieldCount() const
Return the number of fields in this symbol.
SCH_ITEM* SCH_ITEM::Next ( ) const
inlineinherited

Definition at line 143 of file sch_item_struct.h.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_SCREEN::addConnectedItemsToBlock(), SCH_BASE_FRAME::AddToScreen(), SCH_SHEET_LIST::AnnotatePowerSymbols(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), NETLIST_OBJECT_LIST::BuildNetListInfo(), SCH_SCREENS::ChangeSymbolLibNickname(), SCH_SCREEN::CheckIfOnDrawList(), SCH_SCREEN::ClearAnnotation(), SCH_SCREEN::ClearDrawingState(), SCH_SCREEN::CountConnectedItems(), SCH_EDIT_FRAME::CreateArchiveLibrary(), SCH_SCREENS::DeleteAllMarkers(), SCH_EDIT_FRAME::DeleteJunction(), DIALOG_ERC::DisplayERC_MarkersList(), KIGFX::SCH_VIEW::DisplaySheet(), SCH_SCREEN::Draw(), DrawSegment(), SCH_EDIT_FRAME::EndSegment(), SCH_SCREEN::EnsureAlternateReferencesExist(), SCH_EDIT_FRAME::FindComponentAndItem(), SCH_SHEET_PATH::FindNextItem(), SCH_SHEET_LIST::FindNextItem(), SCH_SHEET_PATH::FirstDrawList(), SCH_LEGACY_PLUGIN::Format(), get_components(), AUTOPLACER::get_possible_colliders(), SCH_SHEET_PATH::GetComponents(), SCH_SCREEN::GetConnection(), SCH_SCREEN::GetHierarchicalItems(), SCH_SCREEN::GetItem(), SCH_SCREEN::GetLabel(), SCH_SCREENS::GetLibNicknames(), SCH_SCREEN::GetLine(), SCH_SCREENS::GetMarkerCount(), SCH_SHEET_PATH::GetMultiUnitComponents(), SCH_SCREEN::GetNode(), SCH_SCREEN::GetPin(), SCH_SCREEN::GetSheet(), getSheetBbox(), SCH_SCREEN::GetSheetLabel(), getSheetPin(), SCH_SCREEN::GetWireOrBus(), SCH_SCREENS::HasNoFullyDefinedLibIds(), DIALOG_EDIT_COMPONENTS_LIBID::initDlg(), SCH_SCREEN::IsJunctionNeeded(), SCH_EAGLE_PLUGIN::loadSheet(), SCH_SCREEN::MarkConnections(), SCH_EAGLE_PLUGIN::moveLabels(), SCH_EDIT_FRAME::OnConvertTextType(), DIALOG_ERC::OnLeftClickMarkersList(), SCH_EDIT_FRAME::OnUpdateFields(), SCH_SCREEN::Plot(), SCH_EDIT_FRAME::PutDataInPreviousState(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), SCH_SCREEN::ReplaceWires(), SCH_EDIT_FRAME::SaveWireImage(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SCREEN::SetComponentFootprint(), SCH_EDIT_FRAME::SetCurrentSheetHighlightFlags(), SCH_SCREEN::TestDanglingEnds(), TestDuplicateSheetNames(), DIALOG_ERC::TestErc(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), SCH_EDIT_FRAME::TrimWire(), and SCH_SCREEN::UpdatePickList().

143 { return static_cast<SCH_ITEM*>( Pnext ); }
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:167
bool SCH_COMPONENT::operator!= ( const SCH_COMPONENT aComponent) const

Definition at line 1884 of file sch_component.cpp.

Referenced by CanConnect().

1885 {
1886  return !( *this == aComponent );
1887 }
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 239 of file base_struct.cpp.

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

Referenced by EDA_ITEM::IsReplaceable(), and LIB_ALIAS::operator==().

240 {
241  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
242  GetChars( GetClass() ) ) );
243 
244  return false;
245 }
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
bool SCH_COMPONENT::operator< ( const SCH_ITEM aItem) const
overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1847 of file sch_component.cpp.

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

Referenced by CanConnect().

1848 {
1849  if( Type() != aItem.Type() )
1850  return Type() < aItem.Type();
1851 
1852  SCH_COMPONENT* component = (SCH_COMPONENT*) &aItem;
1853 
1854  EDA_RECT rect = GetBodyBoundingBox();
1855 
1856  if( rect.GetArea() != component->GetBodyBoundingBox().GetArea() )
1857  return rect.GetArea() < component->GetBodyBoundingBox().GetArea();
1858 
1859  if( m_Pos.x != component->m_Pos.x )
1860  return m_Pos.x < component->m_Pos.x;
1861 
1862  if( m_Pos.y != component->m_Pos.y )
1863  return m_Pos.y < component->m_Pos.y;
1864 
1865  return false;
1866 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the symbol body but not the fields.
double GetArea() const
Function GetArea returns the area of the rectangle.
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
SCH_ITEM & SCH_COMPONENT::operator= ( const SCH_ITEM aItem)

Definition at line 1890 of file sch_component.cpp.

References SCH_ITEM::GetClass(), GetClass(), GetField(), GetFieldCount(), m_convert, m_Fields, m_lib_id, m_part, m_PathsAndReferences, m_Pins, m_Pos, m_transform, m_unit, EDA_ITEM::operator=(), EDA_ITEM::SetParent(), and EDA_ITEM::Type().

Referenced by CanConnect().

1891 {
1892  wxCHECK_MSG( Type() == aItem.Type(), *this,
1893  wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
1894  GetClass() );
1895 
1896  if( &aItem != this )
1897  {
1898  SCH_ITEM::operator=( aItem );
1899 
1900  SCH_COMPONENT* c = (SCH_COMPONENT*) &aItem;
1901 
1902  m_lib_id = c->m_lib_id;
1903  m_part = c->m_part;
1904  m_Pos = c->m_Pos;
1905  m_unit = c->m_unit;
1906  m_convert = c->m_convert;
1907  m_transform = c->m_transform;
1908  m_Pins = c->m_Pins;
1909 
1911 
1912  m_Fields = c->m_Fields; // std::vector's assignment operator.
1913 
1914  // Reparent fields after assignment to new component.
1915  for( int ii = 0; ii < GetFieldCount(); ++ii )
1916  {
1917  GetField( ii )->SetParent( this );
1918  }
1919  }
1920 
1921  return *this;
1922 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
std::vector< wxPoint > m_Pins
Definition: sch_component.h:94
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:216
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Operator assignment is used to assign the members of aItem to another object.
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
int GetFieldCount() const
Return the number of fields in this symbol.
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
virtual wxString GetClass() const override
Function GetClass returns the class name.
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
wxString GetClass() const override
Function GetClass returns the class name.
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
bool SCH_COMPONENT::operator== ( const SCH_COMPONENT aComponent) const

Definition at line 1869 of file sch_component.cpp.

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

Referenced by CanConnect().

1870 {
1871  if( GetFieldCount() != aComponent.GetFieldCount() )
1872  return false;
1873 
1874  for( int i = VALUE; i < GetFieldCount(); i++ )
1875  {
1876  if( GetField( i )->GetText().Cmp( aComponent.GetField( i )->GetText() ) != 0 )
1877  return false;
1878  }
1879 
1880  return true;
1881 }
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:143
int GetFieldCount() const
Return the number of fields in this symbol.
size_t i
Definition: json11.cpp:597
#define VALUE
void SCH_COMPONENT::Plot ( PLOTTER aPlotter)
overridevirtual

Function Plot plots the schematic item to aPlotter.

Parameters
aPlotterA pointer to a PLOTTER object.

Reimplemented from SCH_ITEM.

Definition at line 1967 of file sch_component.cpp.

References GetConvert(), GetTransform(), GetUnit(), i, m_Fields, m_part, and m_Pos.

Referenced by SetPosition().

1968 {
1969  TRANSFORM temp;
1970 
1971  if( PART_SPTR part = m_part.lock() )
1972  {
1973  temp = GetTransform();
1974 
1975  part->Plot( aPlotter, GetUnit(), GetConvert(), m_Pos, temp );
1976 
1977  for( size_t i = 0; i < m_Fields.size(); i++ )
1978  {
1979  m_Fields[i].Plot( aPlotter );
1980  }
1981  }
1982 }
TRANSFORM & GetTransform() const
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
int GetConvert() const
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
int GetUnit() const
size_t i
Definition: json11.cpp:597
void SCH_COMPONENT::RemoveField ( const wxString &  aFieldName)

Removes a user field from the symbol.

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

Definition at line 945 of file sch_component.cpp.

References i, m_Fields, and MANDATORY_FIELDS.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), and GetTransform().

946 {
947  for( unsigned i = MANDATORY_FIELDS; i < m_Fields.size(); ++i )
948  {
949  if( aFieldName == m_Fields[i].GetName( false ) )
950  {
951  m_Fields.erase( m_Fields.begin() + i );
952  return;
953  }
954  }
955 }
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
size_t i
Definition: json11.cpp:597
bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
wxString &  aText 
)
inherited

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

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

Definition at line 209 of file base_struct.cpp.

References GetChars(), EDA_ITEM::GetClass(), EDA_ITEM::IsReplaceable(), and traceFindReplace.

Referenced by EDA_ITEM::Matches(), SCH_TEXT::Replace(), SCH_FIELD::Replace(), SCH_SHEET_PIN::Replace(), SCH_SHEET::Replace(), and SCH_FIND_COLLECTOR::ReplaceItem().

210 {
211  wxCHECK_MSG( IsReplaceable(), false,
212  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
213 
214  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
215 
216  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
217  aSearchData.GetFindString() :
218  aSearchData.GetFindString().Upper() );
219 
220  if( result == wxNOT_FOUND )
221  return false;
222 
223  wxString prefix = aText.Left( result );
224  wxString suffix;
225 
226  if( aSearchData.GetFindString().length() + result < aText.length() )
227  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
228 
229  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
230  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
231  GetChars( suffix ) );
232 
233  aText = prefix + aSearchData.GetReplaceString() + suffix;
234 
235  return true;
236 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:464
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
virtual bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
void *  aAuxData = NULL 
)
inlinevirtualinherited

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

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

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

Reimplemented in SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 452 of file base_struct.h.

452 { return false; }
bool SCH_COMPONENT::Resolve ( PART_LIBS aLibs)

Assigns the current LIB_PART from aLibs which this symbol is based on.

Parameters
aLibsis the current set of LIB_PARTs to choose from.

Definition at line 315 of file sch_component.cpp.

References PART_LIBS::FindLibPart(), m_lib_id, and m_part.

Referenced by GetPartRef(), SCH_EDIT_FRAME::Load_Component(), ResolveAll(), and SetLibId().

316 {
317  // I've never been happy that the actual individual PART_LIB is left up to
318  // flimsy search path ordering. None-the-less find a part based on that design:
319  if( LIB_PART* part = aLibs->FindLibPart( m_lib_id ) )
320  {
321  m_part = part->SharedPtr();
322  return true;
323  }
324 
325  return false;
326 }
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
Define a library symbol object.
LIB_PART * FindLibPart(const LIB_ID &aLibId, const wxString &aLibraryName=wxEmptyString)
Search all libraries in the list for a part.
bool SCH_COMPONENT::Resolve ( SYMBOL_LIB_TABLE aLibTable,
PART_LIB aCacheLib = NULL 
)

Definition at line 329 of file sch_component.cpp.

References PART_LIB::FindAlias(), LIB_ID::Format(), LIB_ID::GetLibNickname(), LIB_ALIAS::GetPart(), LIB_TABLE::HasLibrary(), LIB_ID::IsValid(), SYMBOL_LIB_TABLE::LoadSymbol(), m_lib_id, m_part, LIB_PART::SharedPtr(), and UTF8::wx_str().

330 {
331  LIB_ALIAS* alias = nullptr;
332 
333  try
334  {
335  // LIB_TABLE_BASE::LoadSymbol() throws an IO_ERROR if the the library nickname
336  // is not found in the table so check if the library still exists in the table
337  // before attempting to load the symbol.
338  if( m_lib_id.IsValid() && aLibTable.HasLibrary( m_lib_id.GetLibNickname() ) )
339  alias = aLibTable.LoadSymbol( m_lib_id );
340 
341  // Fall back to cache library. This is temporary until the new schematic file
342  // format is implemented.
343  if( !alias && aCacheLib )
344  alias = aCacheLib->FindAlias( m_lib_id.Format().wx_str() );
345 
346  if( alias && alias->GetPart() )
347  {
348  m_part = alias->GetPart()->SharedPtr();
349  return true;
350  }
351  }
352  catch( const IO_ERROR& )
353  {
354  wxLogDebug( "Cannot resolve library symbol %s", m_lib_id.Format().wx_str() );
355  }
356 
357  return false;
358 }
LIB_ALIAS * LoadSymbol(const wxString &aNickname, const wxString &aAliasName)
Load a LIB_ALIAS having aAliasName from the library given by aNickname.
bool IsValid() const
Definition: lib_id.h:171
Part library alias object definition.
wxString wx_str() const
Definition: utf8.cpp:51
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
PART_SPTR SharedPtr()
LIB_ALIAS * FindAlias(const wxString &aName) const
Find LIB_ALIAS by aName.
LIB_PART * GetPart() const
Get the shared LIB_PART.
UTF8 Format() const
Definition: lib_id.cpp:237
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
void SCH_COMPONENT::ResolveAll ( const SCH_COLLECTOR aComponents,
PART_LIBS aLibs 
)
static

Definition at line 377 of file sch_component.cpp.

References COLLECTOR::GetCount(), i, m_convert, m_lib_id, m_part, m_Pins, m_unit, Resolve(), sort_by_libid(), and UpdatePinCache().

Referenced by GetPartRef(), and SCH_SCREEN::UpdateSymbolLinks().

378 {
379  // Usually, many components use the same part lib.
380  // to avoid too long calculation time the list of components is grouped
381  // and once the lib part is found for one member of a group, it is also
382  // set for all other members of this group
383  std::vector<SCH_COMPONENT*> cmp_list;
384 
385  // build the cmp list.
386  for( int i = 0; i < aComponents.GetCount(); ++i )
387  {
388  SCH_COMPONENT* cmp = dynamic_cast<SCH_COMPONENT*>( aComponents[i] );
389  wxASSERT( cmp );
390 
391  if( cmp ) // cmp == NULL should not occur.
392  cmp_list.push_back( cmp );
393  }
394 
395  // sort it by lib part. Cmp will be grouped by same lib part.
396  std::sort( cmp_list.begin(), cmp_list.end(), sort_by_libid );
397 
398  LIB_ID curr_libid;
399 
400  for( unsigned ii = 0; ii < cmp_list.size (); ++ii )
401  {
402  SCH_COMPONENT* cmp = cmp_list[ii];
403  curr_libid = cmp->m_lib_id;
404  cmp->Resolve( aLibs );
405  cmp->UpdatePinCache();
406 
407  // Propagate the m_part pointer to other members using the same lib_id
408  for( unsigned jj = ii+1; jj < cmp_list.size (); ++jj )
409  {
410  SCH_COMPONENT* next_cmp = cmp_list[jj];
411 
412  if( curr_libid != next_cmp->m_lib_id )
413  break;
414 
415  next_cmp->m_part = cmp->m_part;
416 
417  if( ( cmp->m_unit == next_cmp->m_unit ) && ( cmp->m_convert == next_cmp->m_convert ) )
418  // Propagate the pin cache vector as well
419  next_cmp->m_Pins = cmp->m_Pins;
420  else
421  next_cmp->UpdatePinCache();
422 
423  ii = jj;
424  }
425  }
426 }
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:114
bool Resolve(PART_LIBS *aLibs)
Assigns the current LIB_PART from aLibs which this symbol is based on.
static bool sort_by_libid(const SCH_COMPONENT *ref, SCH_COMPONENT *cmp)
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
std::vector< wxPoint > m_Pins
Definition: sch_component.h:94
void UpdatePinCache()
Updates the local cache of pin positions.
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
size_t i
Definition: json11.cpp:597
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
void SCH_COMPONENT::ResolveAll ( const SCH_COLLECTOR aComponents,
SYMBOL_LIB_TABLE aLibTable,
PART_LIB aCacheLib = NULL 
)
static

Definition at line 429 of file sch_component.cpp.

References COLLECTOR::GetCount(), i, m_convert, m_lib_id, m_part, m_Pins, m_unit, Resolve(), sort_by_libid(), and UpdatePinCache().

431 {
432  std::vector<SCH_COMPONENT*> cmp_list;
433 
434  for( int i = 0; i < aComponents.GetCount(); ++i )
435  {
436  SCH_COMPONENT* cmp = dynamic_cast<SCH_COMPONENT*>( aComponents[i] );
437 
438  wxCHECK2_MSG( cmp, continue, "Invalid SCH_COMPONENT pointer in list." );
439 
440  cmp_list.push_back( cmp );
441  }
442 
443  // sort it by lib part. Cmp will be grouped by same lib part.
444  std::sort( cmp_list.begin(), cmp_list.end(), sort_by_libid );
445 
446  LIB_ID curr_libid;
447 
448  for( unsigned ii = 0; ii < cmp_list.size (); ++ii )
449  {
450  SCH_COMPONENT* cmp = cmp_list[ii];
451  curr_libid = cmp->m_lib_id;
452  cmp->Resolve( aLibTable, aCacheLib );
453  cmp->UpdatePinCache();
454 
455  // Propagate the m_part pointer to other members using the same lib_id
456  for( unsigned jj = ii+1; jj < cmp_list.size (); ++jj )
457  {
458  SCH_COMPONENT* next_cmp = cmp_list[jj];
459 
460  if( curr_libid != next_cmp->m_lib_id )
461  break;
462 
463  next_cmp->m_part = cmp->m_part;
464 
465  if( ( cmp->m_unit == next_cmp->m_unit ) && ( cmp->m_convert == next_cmp->m_convert ) )
466  // Propagate the pin cache vector as well
467  next_cmp->m_Pins = cmp->m_Pins;
468  else
469  next_cmp->UpdatePinCache();
470 
471  ii = jj;
472  }
473  }
474 }
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:114
bool Resolve(PART_LIBS *aLibs)
Assigns the current LIB_PART from aLibs which this symbol is based on.
static bool sort_by_libid(const SCH_COMPONENT *ref, SCH_COMPONENT *cmp)
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
std::vector< wxPoint > m_Pins
Definition: sch_component.h:94
void UpdatePinCache()
Updates the local cache of pin positions.
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
size_t i
Definition: json11.cpp:597
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
void SCH_COMPONENT::Rotate ( wxPoint  aPosition)
overridevirtual

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

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

Implements SCH_ITEM.

Definition at line 1548 of file sch_component.cpp.

References CMP_ROTATE_COUNTERCLOCKWISE, GetField(), GetFieldCount(), EDA_TEXT::GetTextPos(), m_Pos, RotatePoint(), SetOrientation(), EDA_TEXT::SetTextPos(), wxPoint::x, and wxPoint::y.

Referenced by Move().

1549 {
1550  wxPoint prev = m_Pos;
1551 
1552  RotatePoint( &m_Pos, aPosition, 900 );
1553 
1555 
1556  for( int ii = 0; ii < GetFieldCount(); ii++ )
1557  {
1558  // Move the fields to the new position because the component itself has moved.
1559  wxPoint pos = GetField( ii )->GetTextPos();
1560  pos.x -= prev.x - m_Pos.x;
1561  pos.y -= prev.y - m_Pos.y;
1562  GetField( ii )->SetTextPos( pos );
1563  }
1564 }
const wxPoint & GetTextPos() const
Definition: eda_text.h:237
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:236
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
int GetFieldCount() const
Return the number of fields in this symbol.
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 215 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

215 { Pback = aBack; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:168
void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 232 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::highlight().

232 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:138
void SCH_COMPONENT::SetConvert ( int  aConvert)

Definition at line 561 of file sch_component.cpp.

References m_convert, and EDA_ITEM::SetModified().

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

562 {
563  if( m_convert != aConvert )
564  {
565  m_convert = aConvert;
566  SetModified();
567  }
568 }
void SetModified()
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
void SCH_COMPONENT::SetCurrentSheetPath ( const SCH_SHEET_PATH aSheetPath)
inline

Definition at line 502 of file sch_component.h.

References AddHierarchicalReference(), GetRef(), GetUnitSelection(), SetRef(), and SetUnitSelection().

Referenced by SCH_EDIT_FRAME::Load_Component().

503  {
504  m_currentSheetPath = aSheetPath;
505  }
const SCH_SHEET_PATH * m_currentSheetPath
A temporary sheet path is required to generate the correct reference designator string in complex hie...
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 389 of file sch_component.h.

References UpdateFields().

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_UPDATE_FIELDS::updateFields(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary().

390  {
391  m_Fields = aFields; // vector copying, length is changed possibly
392  }
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 256 of file base_struct.h.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_SCREEN::addConnectedItemsToBlock(), PCB_BASE_FRAME::AddModuleToBoard(), AddSegmentToDragList(), PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::BeginMoveDimensionText(), PCB_EDIT_FRAME::BeginMoveTarget(), SCH_EDIT_FRAME::BeginSegment(), LIB_EDIT_FRAME::BlockCopySelectedItems(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), LIB_EDIT_FRAME::copySelectedItems(), SCH_EDIT_FRAME::CreateBusBusEntry(), SCH_EDIT_FRAME::CreateBusWireEntry(), SCH_EDIT_FRAME::CreateNewImage(), SCH_EDIT_FRAME::CreateNewText(), LIB_EDIT_FRAME::CreatePin(), SCH_EDIT_FRAME::CreateSheet(), SCH_EDIT_FRAME::CreateSheetPin(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), SCH_EDIT_FRAME::DeleteItem(), DrawMovingBlockOutlines(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_SCREEN::GetConnection(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), SCH_EDIT_FRAME::HandleBlockPlace(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), IsSelectStateChanged(), SCH_EDIT_FRAME::Load_Component(), SCH_SCREEN::MarkConnections(), MarkItemsInBloc(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnSelectUnit(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), PCB_EDIT_FRAME::Other_Layer_Route(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PrepareMoveItem(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_EDIT_FRAME::ReSizeSheet(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_SCREEN::SelectBlockItems(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), BLOCK_SELECTOR::SetFlags(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::Start_Move_DrawItem(), FOOTPRINT_EDIT_FRAME::Start_Move_EdgeMod(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), PCB_EDIT_FRAME::Start_Move_Zone_Drag_Outline_Edge(), PCB_EDIT_FRAME::Start_Move_Zone_Outlines(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), PCB_BASE_FRAME::StartMovePad(), LIB_EDIT_FRAME::StartMovePin(), PCB_BASE_FRAME::StartMoveTexteModule(), PCB_EDIT_FRAME::StartMoveTextePcb(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

256 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

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

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

Definition at line 285 of file base_struct.h.

Referenced by SCH_EDIT_FRAME::OnFindSchematicItem(), and SCH_EDIT_FRAME::updateFindReplaceView().

285 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:175
void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 231 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

231 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:137
void SCH_ITEM::SetLayer ( SCH_LAYER_ID  aLayer)
inlineinherited

Function SetLayer sets the layer this item is on.

Parameters
aLayerThe layer number.

Definition at line 170 of file sch_item_struct.h.

Referenced by Init(), SCH_FIELD::SCH_FIELD(), and SCH_NO_CONNECT::SCH_NO_CONNECT().

170 { m_Layer = aLayer; }
SCH_LAYER_ID m_Layer
void SCH_COMPONENT::SetLibId ( const LIB_ID aName,
PART_LIBS aLibs = NULL 
)

Definition at line 244 of file sch_component.cpp.

References m_lib_id, m_part, Resolve(), and EDA_ITEM::SetModified().

Referenced by SCH_SCREENS::ChangeSymbolLibNickname(), IsMovableFromAnchorPoint(), SCH_EDIT_FRAME::Load_Component(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow().

245 {
246  if( m_lib_id != aLibId )
247  {
248  m_lib_id = aLibId;
249  SetModified();
250 
251  if( aLibs )
252  Resolve( aLibs );
253  else
254  m_part.reset();
255  }
256 }
void SetModified()
bool Resolve(PART_LIBS *aLibs)
Assigns the current LIB_PART from aLibs which this symbol is based on.
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
void SCH_COMPONENT::SetLibId ( const LIB_ID aLibId,
SYMBOL_LIB_TABLE aSymLibTable,
PART_LIB aCacheLib 
)

Definition at line 259 of file sch_component.cpp.

References PART_LIB::FindAlias(), LIB_ID::Format(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ALIAS::GetPart(), LIB_TABLE::HasLibrary(), SYMBOL_LIB_TABLE::LoadSymbol(), m_lib_id, m_part, EDA_ITEM::SetModified(), LIB_PART::SharedPtr(), and UTF8::wx_str().

261 {
262  if( m_lib_id == aLibId )
263  return;
264 
265  m_lib_id = aLibId;
266  SetModified();
267 
268  LIB_ALIAS* alias = nullptr;
269 
270  if( aSymLibTable && aSymLibTable->HasLibrary( m_lib_id.GetLibNickname() ) )
271  alias = aSymLibTable->LoadSymbol( m_lib_id.GetLibNickname(), m_lib_id.GetLibItemName() );
272 
273  if( !alias && aCacheLib )
274  alias = aCacheLib->FindAlias( m_lib_id.Format().wx_str() );
275 
276  if( alias && alias->GetPart() )
277  m_part = alias->GetPart()->SharedPtr();
278  else
279  m_part.reset();
280 }
LIB_ALIAS * LoadSymbol(const wxString &aNickname, const wxString &aAliasName)
Load a LIB_ALIAS having aAliasName from the library given by aNickname.
void SetModified()
Part library alias object definition.
wxString wx_str() const
Definition: utf8.cpp:51
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
PART_SPTR SharedPtr()
LIB_ALIAS * FindAlias(const wxString &aName) const
Find LIB_ALIAS by aName.
LIB_PART * GetPart() const
Get the shared LIB_PART.
UTF8 Format() const
Definition: lib_id.cpp:237
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 217 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), DHEAD::remove(), and SwapItemData().

217 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:169
void EDA_ITEM::SetModified ( )
inherited

Definition at line 100 of file base_struct.cpp.

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

Referenced by ClearAnnotation(), EDA_ITEM::ClearBrightened(), SCH_LINE::Move(), LIB_PIN::Move(), Move(), LIB_PART::RemoveDrawItem(), SetConvert(), LIB_PIN::SetLength(), SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumber(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), SetTransform(), LIB_PIN::SetType(), SetUnit(), LIB_PIN::SetVisible(), and LIB_PIN::SetWidth().

101 {
102  SetFlags( IS_CHANGED );
103 
104  // If this a child object, then the parent modification state also needs to be set.
105  if( m_Parent )
107 }
void SetModified()
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:171
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:110
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 214 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

214 { Pnext = aNext; }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:167
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 1163 of file sch_component.cpp.

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(), GetTransform(), MirrorX(), MirrorY(), SCH_EDIT_FRAME::OrientComponent(), Rotate(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow().

1164 {
1165  TRANSFORM temp = TRANSFORM();
1166  bool transform = false;
1167 
1168  switch( aOrientation )
1169  {
1170  case CMP_ORIENT_0:
1171  case CMP_NORMAL: // default transform matrix
1172  m_transform.x1 = 1;
1173  m_transform.y2 = -1;
1174  m_transform.x2 = m_transform.y1 = 0;
1175  break;
1176 
1177  case CMP_ROTATE_COUNTERCLOCKWISE: // Rotate + (incremental rotation)
1178  temp.x1 = temp.y2 = 0;
1179  temp.y1 = 1;
1180  temp.x2 = -1;
1181  transform = true;
1182  break;
1183 
1184  case CMP_ROTATE_CLOCKWISE: // Rotate - (incremental rotation)
1185  temp.x1 = temp.y2 = 0;
1186  temp.y1 = -1;
1187  temp.x2 = 1;
1188  transform = true;
1189  break;
1190 
1191  case CMP_MIRROR_Y: // Mirror Y (incremental rotation)
1192  temp.x1 = -1;
1193  temp.y2 = 1;
1194  temp.y1 = temp.x2 = 0;
1195  transform = true;
1196  break;
1197 
1198  case CMP_MIRROR_X: // Mirror X (incremental rotation)
1199  temp.x1 = 1;
1200  temp.y2 = -1;
1201  temp.y1 = temp.x2 = 0;
1202  transform = true;
1203  break;
1204 
1205  case CMP_ORIENT_90:
1208  break;
1209 
1210  case CMP_ORIENT_180:
1214  break;
1215 
1216  case CMP_ORIENT_270:
1219  break;
1220 
1221  case ( CMP_ORIENT_0 + CMP_MIRROR_X ):
1224  break;
1225 
1226  case ( CMP_ORIENT_0 + CMP_MIRROR_Y ):
1229  break;
1230 
1231  case ( CMP_ORIENT_90 + CMP_MIRROR_X ):
1234  break;
1235 
1236  case ( CMP_ORIENT_90 + CMP_MIRROR_Y ):
1239  break;
1240 
1241  case ( CMP_ORIENT_180 + CMP_MIRROR_X ):
1244  break;
1245 
1246  case ( CMP_ORIENT_180 + CMP_MIRROR_Y ):
1249  break;
1250 
1251  case ( CMP_ORIENT_270 + CMP_MIRROR_X ):
1254  break;
1255 
1256  case ( CMP_ORIENT_270 + CMP_MIRROR_Y ):
1259  break;
1260 
1261  default:
1262  transform = false;
1263  wxMessageBox( wxT( "SetRotateMiroir() error: ill value" ) );
1264  break;
1265  }
1266 
1267  if( transform )
1268  {
1269  /* The new matrix transform is the old matrix transform modified by the
1270  * requested transformation, which is the temp transform (rot,
1271  * mirror ..) in order to have (in term of matrix transform):
1272  * transform coord = new_m_transform * coord
1273  * where transform coord is the coord modified by new_m_transform from
1274  * the initial value coord.
1275  * new_m_transform is computed (from old_m_transform and temp) to
1276  * have:
1277  * transform coord = old_m_transform * temp
1278  */
1279  TRANSFORM newTransform;
1280 
1281  newTransform.x1 = m_transform.x1 * temp.x1 + m_transform.x2 * temp.y1;
1282  newTransform.y1 = m_transform.y1 * temp.x1 + m_transform.y2 * temp.y1;
1283  newTransform.x2 = m_transform.x1 * temp.x2 + m_transform.x2 * temp.y2;
1284  newTransform.y2 = m_transform.y1 * temp.x2 + m_transform.y2 * temp.y2;
1285  m_transform = newTransform;
1286  }
1287 }
int y2
Definition: transform.h:51
int x2
Definition: transform.h:50
int x1
Definition: transform.h:48
int y1
Definition: transform.h:49
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
void SCH_COMPONENT::SetPosition ( const wxPoint aPosition)
inlineoverridevirtual

Function SetPosition set the schematic item position to aPosition.

Parameters
aPositionA reference to a wxPoint object containing the new position.

Implements SCH_ITEM.

Definition at line 630 of file sch_component.h.

References Clone(), doIsConnected(), HitTest(), Move(), and Plot().

630 { Move( aPosition - m_Pos ); }
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
void Move(const wxPoint &aMoveVector) override
Function Move moves the item by aMoveVector to a new position.
void SCH_COMPONENT::SetPrefix ( const wxString &  aPrefix)
inline

Definition at line 241 of file sch_component.h.

241 { m_prefix = aPrefix; }
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:84
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 756 of file sch_component.cpp.

References abs, AddHierarchicalReference(), GetField(), GetPath(), EDA_TEXT::GetText(), EDA_TEXT::GetTextPos(), IsReferenceStringValid(), m_PathsAndReferences, m_Pos, m_prefix, m_unit, REFERENCE, EDA_TEXT::SetText(), EDA_TEXT::SetTextPos(), wxPoint::x, and wxPoint::y.

Referenced by GetRef(), SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SetCurrentSheetPath(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

757 {
758  wxString path = GetPath( sheet );
759 
760  bool notInArray = true;
761 
762  wxString h_path, h_ref;
763  wxStringTokenizer tokenizer;
764  wxString separators( wxT( " " ) );
765 
766  // check to see if it is already there before inserting it
767  for( unsigned ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
768  {
769  tokenizer.SetString( m_PathsAndReferences[ii], separators );
770  h_path = tokenizer.GetNextToken();
771 
772  if( h_path.Cmp( path ) == 0 )
773  {
774  // just update the reference text, not the timestamp.
775  h_ref = h_path + wxT( " " ) + ref;
776  h_ref += wxT( " " );
777  tokenizer.GetNextToken(); // Skip old reference
778  h_ref += tokenizer.GetNextToken(); // Add part selection
779 
780  // Add the part selection
781  m_PathsAndReferences[ii] = h_ref;
782  notInArray = false;
783  }
784  }
785 
786  if( notInArray )
787  AddHierarchicalReference( path, ref, m_unit );
788 
789  SCH_FIELD* rf = GetField( REFERENCE );
790 
791  if( rf->GetText().IsEmpty()
792  || ( abs( rf->GetTextPos().x - m_Pos.x ) +
793  abs( rf->GetTextPos().y - m_Pos.y ) > 10000 ) )
794  {
795  // move it to a reasonable position
796  rf->SetTextPos( m_Pos + wxPoint( 50, 50 ) );
797  }
798 
799  rf->SetText( ref ); // for drawing.
800 
801  // Reinit the m_prefix member if needed
802  wxString prefix = ref;
803 
804  if( IsReferenceStringValid( prefix ) )
805  {
806  while( prefix.Last() == '?' || std::isdigit( prefix.Last().GetValue() ) )
807  prefix.RemoveLast();
808  }
809  else
810  {
811  prefix = wxT( "U" ); // Set to default ref prefix
812  }
813 
814  if( m_prefix != prefix )
815  m_prefix = prefix;
816 }
Class SCH_FIELD instances are attached to a component and provide a place for the component&#39;s value...
Definition: sch_field.h:56
wxString GetPath(const SCH_SHEET_PATH *sheet) const
const wxPoint & GetTextPos() const
Definition: eda_text.h:237
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:236
#define abs(a)
Definition: auxiliary.h:84
Field Reference of part, i.e. "IC21".
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:143
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
void AddHierarchicalReference(const wxString &aPath, const wxString &aRef, int aMulti)
Add a full hierarchical reference to this symbol.
static bool IsReferenceStringValid(const wxString &aReferenceString)
Tests for an acceptable reference string.
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:84
virtual void SetText(const wxString &aText)
Definition: eda_text.h:154
void EDA_ITEM::SetSelected ( )
inlineinherited

Definition at line 230 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by SELECTION_TOOL::highlight(), LIB_EDIT_FRAME::pasteClipboard(), and GERBVIEW_SELECTION_TOOL::selectVisually().

230 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:121
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited
void SCH_ITEM::SetStoredPos ( wxPoint  aPos)
inlineinherited

Definition at line 156 of file sch_item_struct.h.

Referenced by SCH_EDIT_FRAME::PrepareMoveItem().

156 { m_storedPos = aPos; }
wxPoint m_storedPos
a temporary variable used in some move commands to store a initial pos (of the item or mouse cursor) ...
void SCH_COMPONENT::SetTimeStamp ( timestamp_t  aNewTimeStamp)

Change the time stamp to aNewTimeStamp and updates the reference path.

See also
m_PathsAndReferences
Parameters
aNewTimeStamp= new time stamp

Definition at line 819 of file sch_component.cpp.

References m_PathsAndReferences, EDA_ITEM::m_TimeStamp, and EDA_ITEM::SetTimeStamp().

Referenced by GetTransform(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::PasteListOfItems(), and SCH_COMPONENT().

820 {
821  wxString string_timestamp, string_oldtimestamp;
822 
823  string_timestamp.Printf( wxT( "%08lX" ), (long unsigned) aNewTimeStamp );
824  string_oldtimestamp.Printf( wxT( "%08lX" ), (long unsigned) m_TimeStamp );
825  EDA_ITEM::SetTimeStamp( aNewTimeStamp );
826 
827  for( unsigned ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
828  {
829  m_PathsAndReferences[ii].Replace( string_oldtimestamp.GetData(),
830  string_timestamp.GetData() );
831  }
832 }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:172
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
void SetTimeStamp(timestamp_t aNewTimeStamp)
Definition: base_struct.h:206
void SCH_COMPONENT::SetTransform ( const TRANSFORM aTransform)

Definition at line 571 of file sch_component.cpp.

References m_transform, and EDA_ITEM::SetModified().

Referenced by GetTransform().

572 {
573  if( m_transform != aTransform )
574  {
575  m_transform = aTransform;
576  SetModified();
577  }
578 }
void SetModified()
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
void SCH_COMPONENT::SetUnit ( int  aUnit)

Change the unit number to aUnit.

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

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

Definition at line 545 of file sch_component.cpp.

References m_unit, and EDA_ITEM::SetModified().

Referenced by GetUnit(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_EDIT_FRAME::PasteListOfItems(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow().

546 {
547  if( m_unit != aUnit )
548  {
549  m_unit = aUnit;
550  SetModified();
551  }
552 }
void SetModified()
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
void SCH_COMPONENT::SetUnitSelection ( SCH_SHEET_PATH aSheet,
int  aUnitSelection 
)

Definition at line 863 of file sch_component.cpp.

References AddHierarchicalReference(), GetPath(), m_PathsAndReferences, and m_prefix.

Referenced by SCH_EDIT_FRAME::OnSelectUnit(), SetCurrentSheetPath(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow().

864 {
865  wxString path = GetPath( aSheet );
866 
867  bool notInArray = true;
868 
869  wxString h_path, h_ref;
870  wxStringTokenizer tokenizer;
871  wxString separators( wxT( " " ) );
872 
873  //check to see if it is already there before inserting it
874  for( unsigned ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
875  {
876  tokenizer.SetString( m_PathsAndReferences[ii], separators );
877  h_path = tokenizer.GetNextToken();
878 
879  if( h_path.Cmp( path ) == 0 )
880  {
881  //just update the unit selection.
882  h_ref = h_path + wxT( " " );
883  h_ref += tokenizer.GetNextToken(); // Add reference
884  h_ref += wxT( " " );
885  h_ref << aUnitSelection; // Add part selection
886 
887  // Ann the part selection
888  m_PathsAndReferences[ii] = h_ref;
889  notInArray = false;
890  }
891  }
892 
893  if( notInArray )
894  AddHierarchicalReference( path, m_prefix, aUnitSelection );
895 }
wxString GetPath(const SCH_SHEET_PATH *sheet) const
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
void AddHierarchicalReference(const wxString &aPath, const wxString &aRef, int aMulti)
Add a full hierarchical reference to this symbol.
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:84
void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 229 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

229 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:118
static bool EDA_ITEM::Sort ( const EDA_ITEM aLeft,
const EDA_ITEM aRight 
)
inlinestaticinherited

Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters
aLeftThe left hand item to compare.
aRightThe right hand item to compare.
Returns
True if aLeft is less than aRight.

Definition at line 483 of file base_struct.h.

References EDA_ITEM::Matches(), EDA_ITEM::operator=(), EDA_ITEM::ViewBBox(), and EDA_ITEM::ViewGetLayers().

Referenced by PART_LIB::GetEntryTypePowerNames().

483 { return *aLeft < *aRight; }
void SCH_COMPONENT::SwapData ( SCH_ITEM aItem)
overridevirtual

Function SwapData swap the internal data structures aItem with the schematic item.

Obviously, aItem must have the same type than me

Parameters
aItemThe item to swap the data structures with.

Reimplemented from SCH_ITEM.

Definition at line 1046 of file sch_component.cpp.

References GetField(), GetFieldCount(), m_convert, m_Fields, m_isDangling, m_lib_id, m_part, m_PathsAndReferences, m_Pins, m_Pos, m_transform, m_unit, SCH_COMPONENT_T, EDA_ITEM::SetParent(), and EDA_ITEM::Type().

Referenced by Draw().

1047 {
1048  wxCHECK_RET( (aItem != NULL) && (aItem->Type() == SCH_COMPONENT_T),
1049  wxT( "Cannot swap data with invalid component." ) );
1050 
1051  SCH_COMPONENT* component = (SCH_COMPONENT*) aItem;
1052 
1053  std::swap( m_lib_id, component->m_lib_id );
1054  std::swap( m_part, component->m_part );
1055  std::swap( m_Pos, component->m_Pos );
1056  std::swap( m_unit, component->m_unit );
1057  std::swap( m_convert, component->m_convert );
1058 
1059  std::swap( m_Pins, component->m_Pins );
1060  std::swap( m_isDangling, component->m_isDangling );
1061 
1062  TRANSFORM tmp = m_transform;
1063 
1064  m_transform = component->m_transform;
1065  component->m_transform = tmp;
1066 
1067  m_Fields.swap( component->m_Fields ); // std::vector's swap()
1068 
1069  // Reparent items after copying data
1070  // (after swap(), m_Parent member does not point to the right parent):
1071  for( int ii = 0; ii < component->GetFieldCount(); ++ii )
1072  {
1073  component->GetField( ii )->SetParent( component );
1074  }
1075 
1076  for( int ii = 0; ii < GetFieldCount(); ++ii )
1077  {
1078  GetField( ii )->SetParent( this );
1079  }
1080 
1081  std::swap( m_PathsAndReferences, component->m_PathsAndReferences );
1082 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:89
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:75
std::vector< bool > m_isDangling
One isDangling per pin.
Definition: sch_component.h:93
std::vector< wxPoint > m_Pins
Definition: sch_component.h:94
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
PART_REF m_part
points into the PROJECT&#39;s libraries to the LIB_PART for this component
Definition: sch_component.h:91
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:216
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:80
int GetFieldCount() const
Return the number of fields in this symbol.
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:81
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:88
KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

returns the type of object. This attribute should never be changed after a constructor sets it, so there is no public "setter" method.

Returns
KICAD_T - the type of object.

Definition at line 201 of file base_struct.h.

References EDA_ITEM::m_StructType.

Referenced by Abort_Move_ModuleOutline(), abortMoveItem(), AbortPinMove(), MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), SCH_SCREEN::addConnectedItemsToBlock(), POINT_EDITOR::addCorner(), SCH_EDIT_FRAME::addCurrentItemToScreen(), AddMenusForComponent(), AddMenusForEditComponent(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), PCB_EDIT_FRAME::Attribut_Track(), PCB_EDIT_FRAME::Begin_Route(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Duplicate(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Block_Rotate(), LIB_EDIT_FRAME::BlockCopySelectedItems(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), calcArea(), calcMaxArea(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_SCREENS::ChangeSymbolLibNickname(), SCH_EDIT_FRAME::CheckListConnections(), CN_VISITOR::checkZoneItemConnection(), TEXTE_PCB::ClassOf(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), PCB_TARGET::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), ZONE_CONTAINER::ClassOf(), MARKER_PCB::ClassOf(), TRACK::ClassOf(), DIMENSION::ClassOf(), NETINFO_ITEM::ClassOf(), MODULE::ClassOf(), D_PAD::ClassOf(), BOARD::ClassOf(), VIA::ClassOf(), SCH_SHEET::CleanupSheet(), Collect_TrackSegmentsToDrag(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), SCH_SHEET::ComponentCount(), GRID_HELPER::computeAnchors(), SCH_SCREEN::CountConnectedItems(), SCH_SHEET::CountSheets(), MODULE::CoverageRatio(), LIB_EDIT_FRAME::CreateGraphicItem(), CINFO3D_VISU::createLayers(), BOARD::CreateLockPoint(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), PCB_EDIT_FRAME::createPopupMenuForTracks(), CreateRoutesSection(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), D_PAD::D_PAD(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), SCH_SCREENS::DeleteAllMarkers(), SCH_SCREEN::DeleteItem(), LIB_EDIT_FRAME::deleteItem(), SCH_EDIT_FRAME::DeleteItem(), DeleteNullTrackSegments(), PYTHON_ACTION_PLUGINS::deregister_action(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_ERC::DisplayERC_MarkersList(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DrawMovePin(), DrawMovingBlockOutlines(), drawPickedItems(), CN_ITEM::Dump(), BOARD::Duplicate(), MODULE::Duplicate(), PCB_EDIT_FRAME::duplicateItems(), SCH_EDIT_FRAME::DuplicateItemsInList(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditSymbolText(), EditToolSelectionFilter(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::EraseRedundantTrack(), ExitSheet(), find_vias_and_tracks_at(), SCH_EDIT_FRAME::FindComponentAndItem(), NETLIST_EXPORTER::findNextComponent(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), SCH_SHEET_PATH::FindNextItem(), SCH_SHEET_LIST::FindNextItem(), SCH_SHEET_PATH::FindPreviousItem(), SCH_SHEET_LIST::FindPreviousItem(), EDIT_TOOL::FootprintFilter(), FootprintWriteShape(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), TRACK::GetBestInsertPoint(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_SCREEN::GetConnection(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstTrack(), GetFirstVia(), SCH_SCREEN::GetHierarchicalItems(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), BOARD_CONNECTED_ITEM::GetNetClass(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), SCH_SCREEN::GetPin(), LIB_PART::GetPin(), GetPinPhysicalPosition(), getRect(), SELECTION::GetTopLeftItem(), LIB_EDIT_FRAME::GlobalSetPins(), SELECTION_TOOL::guessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), SELECTION_TOOL::highlight(), SCH_EDIT_FRAME::ImportSheetPin(), ROUTER_TOOL::InlineDrag(), SCH_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), SCH_FIND_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), CN_ANCHOR::IsDangling(), SCH_COLLECTOR::IsNode(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_EDIT_FRAME::LocateAndShowItem(), SCH_EDIT_FRAME::LocateItem(), SCH_SHEET::LocatePathOfScreen(), Magnetize(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), MarkItemsInBloc(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), TRACKS_CLEANER::MergeCollinearTracks(), SCH_LINE::MergeOverlap(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), moveItemWithMouseCursor(), MoveMarkedItems(), MoveMarkedItemsExactly(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), LIB_EDIT_FRAME::OnEditComponentProperties(), SCH_EDIT_FRAME::OnEditItem(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDuplicateItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItemExact(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyRotateItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), POINT_EDITOR::OnSelectionChange(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), operator=(), LIB_ITEM::operator==(), OrCell_Trace(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::PasteItemsFromClipboard(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), LIB_EDIT_FRAME::PlacePin(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_EDIT_FRAME::PrepareMoveItem(), GAL_ARRAY_CREATOR::prePushAction(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingModules(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_BASE_FRAME::RefreshItem(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), SCH_SHEET::RemovePin(), FOOTPRINT_EDIT_FRAME::RemoveStruct(), PCB_EDIT_FRAME::RemoveStruct(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SCREEN::ReplaceWires(), PCB_BASE_FRAME::ResetTextSize(), SCH_EDIT_FRAME::ReSizeSheet(), BOARD_COMMIT::Revert(), SCH_TEXT::Rotate(), SCH_EDIT_FRAME::RotateField(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), SCH_EDIT_FRAME::SaveWireImage(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SHEET::SearchHierarchy(), SELECTION_TOOL::select(), SELECTION_TOOL::selectable(), SCH_SCREEN::SelectBlockItems(), PCB_EDIT_FRAME::SelectHighLight(), ITEM_PICKER::SetItem(), SetSchItemParent(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Show_1_Ratsnest(), Show_MoveNode(), ShowClearance(), ShowNewTrackWhenMovingCursor(), SortByTimeStamp(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), LIB_EDIT_FRAME::StartMoveDrawSymbol(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), PCB_TARGET::SwapData(), SCH_BITMAP::SwapData(), SCH_FIELD::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), DIMENSION::SwapData(), DRAWSEGMENT::SwapData(), TRACK::SwapData(), SCH_SHEET::SwapData(), SwapData(),