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
 
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)
 
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)
 
int GetUnit () const
 
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...
 
bool Save (FILE *aFile) const override
 Function Save writes the data structures for this object out to a FILE in "*.sch" format. More...
 
bool Load (LINE_READER &aLine, wxString &aErrorMsg) override
 Function Load reads a schematic item from aLine in a .sch file. 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 (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...
 
void SetTimeStamp (time_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 (wxString aFieldName, bool aIncludeDefaultFields=true) 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...
 
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...
 
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...
 
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 IsPinDanglingStateChanged (std::vector< DANGLING_END_ITEM > &aItemList, LIB_PINS &aLibPins, unsigned aPin)
 Test if the symbol's dangling state has changed for one given pin index. More...
 
bool IsDanglingStateChanged (std::vector< DANGLING_END_ITEM > &aItemList) override
 Test if the component's dangling state has changed for all pins. More...
 
bool IsDangling () const override
 Return whether any pin in this symbol is dangling. More...
 
wxPoint GetPinPhysicalPosition (LIB_PIN *Pin)
 
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 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 () 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...
 
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...
 
time_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
 
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 ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. 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 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)
 
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...
 
time_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...
 
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...
 

Friends

class DIALOG_EDIT_COMPONENT_IN_SCHEMATIC
 

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

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

Referenced by Clone().

119  :
120  SCH_ITEM( aParent, SCH_COMPONENT_T )
121 {
122  Init( aPos );
123  m_currentSheetPath = NULL;
125 }
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:97
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 128 of file sch_component.cpp.

References AddField(), AUTOPLACED_NO, FindField(), FROM_UTF8(), GetField(), GetFieldCount(), LIB_PART::GetFields(), GetLibId(), LIB_PART::GetName(), GetNewTimeStamp(), LIB_PART::GetReferenceField(), EDA_TEXT::GetText(), SCH_FIELD::ImportValues(), Init(), IS_MOVED, IS_NEW, m_convert, m_currentSheetPath, m_fieldsAutoplaced, EDA_ITEM::m_Flags, m_lib_id, m_part, m_Pos, m_prefix, m_unit, MANDATORY_FIELDS, LIB_ID::SetLibItemName(), SetRef(), EDA_TEXT::SetText(), EDA_TEXT::SetTextPos(), SetTimeStamp(), LIB_PART::SharedPtr(), TO_UTF8, and VALUE.

129  :
130  SCH_ITEM( NULL, SCH_COMPONENT_T )
131 {
132  Init( pos );
133 
134  m_unit = unit;
135  m_convert = convert;
136  m_lib_id.SetLibItemName( TO_UTF8( aPart.GetName() ), false );
137  m_part = aPart.SharedPtr();
138  m_currentSheetPath = NULL;
140 
142 
143  if( setNewItemFlag )
144  m_Flags = IS_NEW | IS_MOVED;
145 
146  // Import user defined fields from the library component:
147  LIB_FIELDS libFields;
148 
149  aPart.GetFields( libFields );
150 
151  for( LIB_FIELDS::iterator it = libFields.begin(); it!=libFields.end(); ++it )
152  {
153  // Can no longer insert an empty name, since names are now keys. The
154  // field index is not used beyond the first MANDATORY_FIELDS
155  if( it->GetName().IsEmpty() )
156  continue;
157 
158  // See if field already exists (mandatory fields always exist).
159  // for mandatory fields, the name and field id are fixed, so we use the
160  // known and fixed id to get them (more reliable than names, which can be translated)
161  // for other fields (custom fields), locate the field by same name
162  // (field id has no known meaning for custom fields)
163  int idx = it->GetId();
164  SCH_FIELD* schField;
165 
166  if( idx < MANDATORY_FIELDS )
167  schField = GetField( idx );
168  else
169  schField = FindField( it->GetName() );
170 
171  if( !schField )
172  {
173  SCH_FIELD fld( wxPoint( 0, 0 ), GetFieldCount(), this, it->GetName() );
174  schField = AddField( fld );
175  }
176 
177  schField->ImportValues( *it );
178  schField->SetText( it->GetText() );
179 
180  // Now the field is initialized, place it to the right position:
181  schField->SetTextPos( m_Pos + it->GetTextPos() );
182  }
183 
184  wxString msg = aPart.GetReferenceField().GetText();
185 
186  if( msg.IsEmpty() )
187  msg = wxT( "U" );
188 
189  m_prefix = msg;
190 
191  // update the reference -- just the prefix for now.
192  msg += wxT( "?" );
193  SetRef( sheet, msg );
194 
195  // Use the schematic component name instead of the library value field name.
196  GetField( VALUE )->SetText( FROM_UTF8( GetLibId().GetLibItemName() ) );
197 }
Class SCH_FIELD instances are attached to a component and provide a place for the component's value...
Definition: sch_field.h:56
SCH_FIELD * FindField(const wxString &aFieldName, bool aIncludeDefaultFields=true)
Search for a SCH_FIELD with aFieldName.
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
const SCH_SHEET_PATH * m_currentSheetPath
A temporary sheet path is required to generate the correct reference designator string in complex hie...
void ImportValues(const LIB_FIELD &aSource)
Function ImportValues copy parameters from a LIB_FIELD source.
Definition: sch_field.cpp:221
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:223
time_t GetNewTimeStamp()
Definition: common.cpp:166
#define IS_NEW
New item, just created.
Definition: base_struct.h:113
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
void SetTimeStamp(time_t aNewTimeStamp)
Change the time stamp to aNewTimeStamp and updates the reference path.
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
LIB_FIELD & GetReferenceField()
Return reference to the reference designator field.
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
const wxString & GetName() const
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:130
PART_SPTR SharedPtr()
SCH_FIELD * AddField(const SCH_FIELD &aField)
Add a field to the symbol.
int SetLibItemName(const UTF8 &aLibItemName, bool aTestForRev=true)
Function SetLibItemName.
Definition: lib_id.cpp:232
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:82
Field Value of part, i.e. "3.3K".
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.
int GetFieldCount() const
Return the number of fields in this symbol.
std::vector< LIB_FIELD > LIB_FIELDS
Definition: lib_field.h:261
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
const LIB_ID & GetLibId() const
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
AUTOPLACED m_fieldsAutoplaced
indicates status of field autoplacement
Definition: sch_component.h:97
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:86
void GetFields(LIB_FIELDS &aList)
Function GetFields returns a list of fields withing this part.
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
virtual void SetText(const wxString &aText)
Definition: eda_text.h:141
#define IS_MOVED
Item being moved.
Definition: base_struct.h:112
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 200 of file sch_component.cpp.

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

200  :
201  SCH_ITEM( aComponent )
202 {
203  m_currentSheetPath = NULL;
204  m_Parent = aComponent.m_Parent;
205  m_Pos = aComponent.m_Pos;
206  m_unit = aComponent.m_unit;
207  m_convert = aComponent.m_convert;
208  m_lib_id = aComponent.m_lib_id;
209  m_part = aComponent.m_part;
210 
211  SetTimeStamp( aComponent.m_TimeStamp );
212 
213  m_transform = aComponent.m_transform;
214  m_prefix = aComponent.m_prefix;
216  m_Fields = aComponent.m_Fields;
217 
218  // Re-parent the fields, which before this had aComponent as parent
219  for( int i = 0; i<GetFieldCount(); ++i )
220  {
221  GetField( i )->SetParent( this );
222  }
223 
224  m_isDangling = aComponent.m_isDangling;
226 }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:168
time_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:169
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:91
const SCH_SHEET_PATH * m_currentSheetPath
A temporary sheet path is required to generate the correct reference designator string in complex hie...
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:77
std::vector< bool > m_isDangling
One isDangling per pin.
Definition: sch_component.h:95
void SetTimeStamp(time_t aNewTimeStamp)
Change the time stamp to aNewTimeStamp and updates the reference path.
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:213
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:82
int GetFieldCount() const
Return the number of fields in this symbol.
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
AUTOPLACED m_fieldsAutoplaced
indicates status of field autoplacement
Definition: sch_component.h:97
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:86
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:90
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
SCH_COMPONENT::~SCH_COMPONENT ( )
inline

Definition at line 148 of file sch_component.h.

148 { }

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

References m_Fields.

Referenced by Init(), Load(), and SCH_COMPONENT().

864 {
865  int newNdx = m_Fields.size();
866 
867  m_Fields.push_back( aField );
868  return &m_Fields[newNdx];
869 }
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:91
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 565 of file sch_component.cpp.

References m_PathsAndReferences.

Referenced by Load(), SetRef(), and SetUnitSelection().

568 {
569  wxString h_path, h_ref;
570  wxStringTokenizer tokenizer;
571  wxString separators( wxT( " " ) );
572 
573  // Search for an existing path and remove it if found (should not occur)
574  for( unsigned ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
575  {
576  tokenizer.SetString( m_PathsAndReferences[ii], separators );
577  h_path = tokenizer.GetNextToken();
578 
579  if( h_path.Cmp( aPath ) == 0 )
580  {
581  m_PathsAndReferences.RemoveAt( ii );
582  ii--;
583  }
584  }
585 
586  h_ref = aPath + wxT( " " ) + aRef;
587  h_ref << wxT( " " ) << aMulti;
588  m_PathsAndReferences.Add( h_ref );
589 }
wxArrayString m_PathsAndReferences
Defines the hierarchical path and reference of the component.
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 400 of file sch_component.h.

References AUTOPLACED_MANUAL, AutoplaceFields(), and GetFieldsAutoplaced().

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

401  {
402  if( GetFieldsAutoplaced() )
404  }
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 AUTOPLACED_AUTO, AUTOPLACED_MANUAL, AUTOPLACER::DoAutoplace(), and m_fieldsAutoplaced.

Referenced by AutoAutoplaceFields(), 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:97
SCH_ITEM* SCH_ITEM::Back ( ) const
inlineinherited

Definition at line 145 of file sch_item_struct.h.

References EDA_ITEM::Pback.

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

145 { return static_cast<SCH_ITEM*>( Pback ); }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:165
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
virtual bool SCH_ITEM::CanIncrementLabel ( ) const
inlinevirtualinherited

Reimplemented in SCH_TEXT.

Definition at line 345 of file sch_item_struct.h.

Referenced by SCH_EDIT_FRAME::RepeatDrawItem().

345 { 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 945 of file sch_component.cpp.

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

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

946 {
947  bool keepMulti = false;
948  wxArrayString reference_fields;
949 
950  static const wxChar separators[] = wxT( " " );
951 
952  PART_SPTR part = m_part.lock();
953 
954  if( part && part->UnitsLocked() )
955  keepMulti = true;
956 
957  // Build a reference with no annotation,
958  // i.e. a reference ended by only one '?'
959  wxString defRef = m_prefix;
960 
961  if( IsReferenceStringValid( defRef ) )
962  {
963  while( defRef.Last() == '?' )
964  defRef.RemoveLast();
965  }
966  else
967  { // This is a malformed reference: reinit this reference
968  m_prefix = defRef = wxT("U"); // Set to default ref prefix
969  }
970 
971  defRef.Append( wxT( "?" ) );
972 
973  wxString multi = wxT( "1" );
974 
975  // For components with units locked,
976  // we cannot remove all annotations: part selection must be kept
977  // For all components: if aSheetPath is not NULL,
978  // remove annotation only for the given path
979  if( keepMulti || aSheetPath )
980  {
981  wxString NewHref;
982  wxString path;
983 
984  if( aSheetPath )
985  path = GetPath( aSheetPath );
986 
987  for( unsigned int ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
988  {
989  // Break hierarchical reference in path, ref and multi selection:
990  reference_fields = wxStringTokenize( m_PathsAndReferences[ii], separators );
991 
992  if( aSheetPath == NULL || reference_fields[0].Cmp( path ) == 0 )
993  {
994  if( keepMulti ) // Get and keep part selection
995  multi = reference_fields[2];
996 
997  NewHref = reference_fields[0];
998  NewHref << wxT( " " ) << defRef << wxT( " " ) << multi;
999  m_PathsAndReferences[ii] = NewHref;
1000  }
1001  }
1002  }
1003  else
1004  {
1005  // Clear reference strings, but does not free memory because a new annotation
1006  // will reuse it
1007  m_PathsAndReferences.Empty();
1008  m_unit = 1;
1009  }
1010 
1011  // These 2 changes do not work in complex hierarchy.
1012  // When a clear annotation is made, the calling function must call a
1013  // UpdateAllScreenReferences for the active sheet.
1014  // But this call cannot made here.
1015  m_Fields[REFERENCE].SetText( defRef ); //for drawing.
1016 
1017  SetModified();
1018 }
void SetModified()
wxString GetPath(const SCH_SHEET_PATH *sheet) const
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:91
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's libraries to the LIB_PART for this component
Definition: sch_component.h:93
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:82
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:86
void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 233 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by SELECTION_TOOL::disambiguationMenu().

233 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:137
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
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 305 of file sch_item_struct.h.

305 { 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 379 of file sch_component.h.

References AUTOPLACED_NO.

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

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

Definition at line 254 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(), abortMoveBitmap(), AbortMoveDimensionText(), abortMoveItem(), AbortMoveTextModule(), AbortPinMove(), SCH_SCREEN::addConnectedItemsToBlock(), SCH_EDIT_FRAME::addCurrentItemToList(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::AppendBoardFile(), SCH_EDIT_FRAME::AppendOneEEProject(), 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(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearHighlighted(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_PART::CopySelectedItems(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), LIB_PART::DeleteSelectedItems(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), 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_Zone(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::Exchange_Module(), ExitSheet(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), IsSelectStateChanged(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), MarkItemsInBloc(), MirrorX(), MirrorY(), moveBitmap(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnRotateItem(), SCH_EDIT_FRAME::OnSelectUnit(), 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(), EDIT_TOOL::Properties(), 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(), LIB_PIN::Save(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), SCH_EDIT_FRAME::SetRepeatItem(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

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

Definition at line 232 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

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

Definition at line 231 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::unselectVisually(), and PCB_EDITOR_CONTROL::ZoneDuplicate().

231 { ClearFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:120
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
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 258 of file sch_component.cpp.

References SCH_COMPONENT().

259 {
260  return new SCH_COMPONENT( *this );
261 }
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 2234 of file sch_component.cpp.

References GetConnectionPoints().

2235 {
2236  std::vector< wxPoint > pts;
2237 
2238  GetConnectionPoints( pts );
2239 
2240  for( size_t i = 0; i < pts.size(); i++ )
2241  {
2242  if( pts[i] == aPosition )
2243  return true;
2244  }
2245 
2246  return false;
2247 }
void GetConnectionPoints(std::vector< wxPoint > &aPoints) const override
Function GetConnectionPoints add all the connection points for this item to aPoints.
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 426 of file sch_component.h.

Referenced by SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::Load_Component(), moveItemWithMouseCursor(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnSelectUnit(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp().

428  {
429  Draw( aPanel, aDC, aOffset, aDrawMode, aColor, true );
430  }
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 496 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.

499 {
500  auto opts = PART_DRAW_OPTIONS::Default();
501  opts.draw_mode = aDrawMode;
502  opts.color = aColor;
503  opts.transform = m_transform;
504  opts.show_pin_text = aDrawPinText;
505  opts.draw_visible_fields = false;
506  opts.draw_hidden_fields = false;
507 
508  if( PART_SPTR part = m_part.lock() )
509  {
510  // Draw pin targets if part is being dragged
511  bool dragging = aPanel->GetScreen()->GetCurItem() == this && aPanel->IsMouseCaptured();
512 
513  if( !dragging )
514  {
515  opts.dangling = m_isDangling;
516  }
517 
518  part->Draw( aPanel, aDC, m_Pos + aOffset, m_unit, m_convert, opts );
519  }
520  else // Use dummy() part if the actual cannot be found.
521  {
522  dummy()->Draw( aPanel, aDC, m_Pos + aOffset, 0, 0, opts );
523  }
524 
525  SCH_FIELD* field = GetField( REFERENCE );
526 
527  if( field->IsVisible() && !field->IsMoving() )
528  {
529  field->Draw( aPanel, aDC, aOffset, aDrawMode );
530  }
531 
532  for( int ii = VALUE; ii < GetFieldCount(); ii++ )
533  {
534  field = GetField( ii );
535 
536  if( field->IsMoving() )
537  continue;
538 
539  field->Draw( aPanel, aDC, aOffset, aDrawMode );
540  }
541 
542 #if 0
543  // Only for testing purposes, draw the component bounding box
544  {
546  GRRect( aPanel->GetClipBox(), aDC, boundingBox, 0, BROWN );
547 #if 1
548  if( GetField( REFERENCE )->IsVisible() )
549  {
550  boundingBox = GetField( REFERENCE )->GetBoundingBox();
551  GRRect( aPanel->GetClipBox(), aDC, boundingBox, 0, BROWN );
552  }
553 
554  if( GetField( VALUE )->IsVisible() )
555  {
556  boundingBox = GetField( VALUE )->GetBoundingBox();
557  GRRect( aPanel->GetClipBox(), aDC, boundingBox, 0, BROWN );
558  }
559 #endif
560  }
561 #endif
562 }
Class SCH_FIELD instances are attached to a component and provide a place for the component'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:218
EDA_ITEM * GetCurItem() const
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
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:118
std::vector< bool > m_isDangling
One isDangling per pin.
Definition: sch_component.h:95
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:1077
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
bool IsMouseCaptured() const
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
EDA_RECT * GetClipBox()
static PART_DRAW_OPTIONS Default()
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:82
Field Value of part, i.e. "3.3K".
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:251
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:176
Class EDA_RECT handles the component boundary box.
BASE_SCREEN * GetScreen()
Definition: draw_panel.cpp:188
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:90
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 872 of file sch_component.cpp.

References m_Fields, and MANDATORY_FIELDS.

Referenced by NETLIST_EXPORTER_PSPICE::GetSpiceField(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::InitBuffers(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), and SCH_COMPONENT().

873 {
874  unsigned start = aIncludeDefaultFields ? 0 : MANDATORY_FIELDS;
875 
876  for( unsigned i = start; i<m_Fields.size(); ++i )
877  {
878  if( aFieldName == m_Fields[i].GetName( false ) )
879  {
880  return &m_Fields[i];
881  }
882  }
883 
884  return NULL;
885 }
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:91
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
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 299 of file sch_component.cpp.

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

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->GetDescription();
309  }
310 
311  return wxEmptyString;
312 }
Part library alias object definition.
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
wxString GetDescription() const
const LIB_ID & GetLibId() const
wxString SCH_COMPONENT::GetAliasDocumentation ( ) const

Return the documentation text for the given part alias.

Definition at line 315 of file sch_component.cpp.

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

316 {
317  if( PART_SPTR part = m_part.lock() )
318  {
319  LIB_ALIAS* alias = part->GetAlias( GetLibId().GetLibItemName() );
320 
321  if( !alias )
322  return wxEmptyString;
323 
324  return alias->GetDocFileName();
325  }
326 
327  return wxEmptyString;
328 }
Part library alias object definition.
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
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 1661 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(), HitTest(), and operator<().

1662 {
1663  EDA_RECT bBox;
1664 
1665  if( PART_SPTR part = m_part.lock() )
1666  {
1667  bBox = part->GetBodyBoundingBox( m_unit, m_convert );
1668  }
1669  else
1670  {
1671  bBox = dummy()->GetBodyBoundingBox( m_unit, m_convert );
1672  }
1673 
1674  int x0 = bBox.GetX();
1675  int xm = bBox.GetRight();
1676 
1677  // We must reverse Y values, because matrix orientation
1678  // suppose Y axis normal for the library items coordinates,
1679  // m_transform reverse Y values, but bBox is already reversed!
1680  int y0 = -bBox.GetY();
1681  int ym = -bBox.GetBottom();
1682 
1683  // Compute the real Boundary box (rotated, mirrored ...)
1684  int x1 = m_transform.x1 * x0 + m_transform.y1 * y0;
1685  int y1 = m_transform.x2 * x0 + m_transform.y2 * y0;
1686  int x2 = m_transform.x1 * xm + m_transform.y1 * ym;
1687  int y2 = m_transform.x2 * xm + m_transform.y2 * ym;
1688 
1689  // H and W must be > 0:
1690  if( x2 < x1 )
1691  std::swap( x2, x1 );
1692 
1693  if( y2 < y1 )
1694  std::swap( y2, y1 );
1695 
1696  bBox.SetX( x1 );
1697  bBox.SetY( y1 );
1698  bBox.SetWidth( x2 - x1 );
1699  bBox.SetHeight( y2 - y1 );
1700 
1701  bBox.Offset( m_Pos );
1702  return bBox;
1703 }
void Offset(int dx, int dy)
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:77
const EDA_RECT GetBodyBoundingBox(int aUnit, int aConvert) const
Function GetBodyBoundingBox.
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's libraries to the LIB_PART for this component
Definition: sch_component.h:93
void SetHeight(int val)
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
void SetX(int val)
int GetBottom() const
int GetRight() const
void SetWidth(int val)
void SetY(int val)
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:82
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.
int GetX() const
int GetY() const
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:90
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 1706 of file sch_component.cpp.

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

Referenced by Draw(), and IsSelectStateChanged().

1707 {
1708  EDA_RECT bbox = GetBodyBoundingBox();
1709 
1710  for( size_t i = 0; i < m_Fields.size(); i++ )
1711  {
1712  bbox.Merge( m_Fields[i].GetBoundingBox() );
1713  }
1714 
1715  return bbox;
1716 }
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:91
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...
Class EDA_RECT handles the component boundary box.
wxString SCH_COMPONENT::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from SCH_ITEM.

Definition at line 150 of file sch_component.h.

Referenced by operator=().

151  {
152  return wxT( "SCH_COMPONENT" );
153  }
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 1961 of file sch_component.cpp.

References FROM_UTF8(), GetLibId(), LIB_PIN_T, m_convert, m_part, m_Pos, m_transform, m_unit, and TRANSFORM::TransformCoordinate().

Referenced by doIsConnected().

1962 {
1963  if( PART_SPTR part = m_part.lock() )
1964  {
1965  for( LIB_PIN* pin = part->GetNextPin(); pin; pin = part->GetNextPin( pin ) )
1966  {
1967  wxCHECK_RET( pin->Type() == LIB_PIN_T,
1968  wxT( "GetNextPin() did not return a pin object. Bad programmer!" ) );
1969 
1970  // Skip items not used for this part.
1971  if( m_unit && pin->GetUnit() && ( pin->GetUnit() != m_unit ) )
1972  continue;
1973 
1974  if( m_convert && pin->GetConvert() && ( pin->GetConvert() != m_convert ) )
1975  continue;
1976 
1977  // Calculate the pin position relative to the component position and orientation.
1978  aPoints.push_back( m_transform.TransformCoordinate( pin->GetPosition() ) + m_Pos );
1979  }
1980  }
1981  else
1982  {
1983  wxCHECK_RET( 0,
1984  wxT( "Cannot add connection points to list. Cannot find component <" ) +
1985  FROM_UTF8( GetLibId().GetLibItemName() ) +
1986  wxT( "> in any of the loaded libraries." ) );
1987  }
1988 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
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:82
const LIB_ID & GetLibId() const
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:90
int SCH_COMPONENT::GetConvert ( ) const
inline
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 1991 of file sch_component.cpp.

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

Referenced by SCH_SCREEN::GetPin().

1992 {
1993  if( PART_SPTR part = m_part.lock() )
1994  {
1995  // Calculate the position relative to the component.
1996  wxPoint libPosition = aPosition - m_Pos;
1997 
1998  return part->LocateDrawItem( m_unit, m_convert, aType, libPosition, m_transform );
1999  }
2000 
2001  return NULL;
2002 }
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
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:82
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:90
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 1833 of file sch_component.cpp.

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

1834 {
1835  if( PART_SPTR part = m_part.lock() )
1836  {
1837  for( LIB_PIN* pin = part->GetNextPin(); pin; pin = part->GetNextPin( pin ) )
1838  {
1839  wxASSERT( pin->Type() == LIB_PIN_T );
1840 
1841  if( pin->GetUnit() && m_unit && ( m_unit != pin->GetUnit() ) )
1842  continue;
1843 
1844  if( pin->GetConvert() && m_convert && ( m_convert != pin->GetConvert() ) )
1845  continue;
1846 
1847  DANGLING_END_ITEM item( PIN_END, pin, GetPinPhysicalPosition( pin ) );
1848  aItemList.push_back( item );
1849  }
1850  }
1851 }
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
wxPoint GetPinPhysicalPosition(LIB_PIN *Pin)
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:82
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
Class DANGLING_END_ITEM is a helper class used to store the state of schematic items that can be conn...
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 802 of file sch_component.cpp.

References m_Fields.

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), AddMenusForComponent(), SIM_PLOT_FRAME::AddTuner(), SCH_EDIT_FRAME::backAnnotateFootprints(), SCH_SHEET::ComponentCount(), Draw(), SCH_EDIT_FRAME::FindComponentAndItem(), FormatProbeItem(), SCH_SCREEN::GetItem(), LIB_PIN::GetMsgPanelInfo(), GetMsgPanelInfo(), GetRef(), GetSelectMenuText(), NETLIST_EXPORTER_PSPICE::GetSpiceFieldDefVal(), IsInNetlist(), Load(), SCH_EDIT_FRAME::Load_Component(), MirrorX(), MirrorY(), Move(), TUNER_SLIDER::onSave(), operator=(), operator==(), SCH_EDIT_FRAME::ProcessCmpToFootprintLinkFile(), Rotate(), Save(), SCH_LEGACY_PLUGIN::saveComponent(), SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SCREEN::SetComponentFootprint(), BOM_TABLE_MODEL::SetComponents(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), SetRef(), SCH_REFERENCE_LIST::sortByReferenceOnly(), SwapData(), TUNER_SLIDER::TUNER_SLIDER(), SCH_SHEET_PATH::UpdateAllScreenReferences(), Visit(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

803 {
804  const SCH_FIELD* field;
805 
806  if( (unsigned) aFieldNdx < m_Fields.size() )
807  field = &m_Fields[aFieldNdx];
808  else
809  field = NULL;
810 
811  wxASSERT( field );
812 
813  // use cast to remove const-ness
814  return (SCH_FIELD*) field;
815 }
Class SCH_FIELD instances are attached to a component and provide a place for the component's value...
Definition: sch_field.h:56
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:91
int SCH_COMPONENT::GetFieldCount ( ) const
inline

Return the number of fields in this symbol.

Definition at line 369 of file sch_component.h.

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), Draw(), SCH_SCREEN::GetItem(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::InitBuffers(), Load(), MirrorX(), MirrorY(), Move(), operator=(), operator==(), Rotate(), SCH_LEGACY_PLUGIN::saveComponent(), SCH_COMPONENT(), SwapData(), and Visit().

369 { return (int)m_Fields.size(); }
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:91
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 853 of file sch_component.cpp.

References m_Fields.

Referenced by BOM_TABLE_MODEL::AddComponentFields(), and AUTOPLACER::AUTOPLACER().

854 {
855  for( SCH_FIELD& each_field : m_Fields )
856  {
857  if( !aVisibleOnly || ( each_field.IsVisible() && !each_field.IsVoid() ) )
858  aVector.push_back( &each_field );
859  }
860 }
Class SCH_FIELD instances are attached to a component and provide a place for the component's value...
Definition: sch_field.h:56
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:91
AUTOPLACED SCH_COMPONENT::GetFieldsAutoplaced ( ) const
inline

Return whether the fields have been automatically placed.

Definition at line 374 of file sch_component.h.

References m_fieldsAutoplaced.

Referenced by AutoAutoplaceFields().

374 { return m_fieldsAutoplaced; }
AUTOPLACED m_fieldsAutoplaced
indicates status of field autoplacement
Definition: sch_component.h:97
wxString SCH_COMPONENT::GetFieldText ( wxString  aFieldName,
bool  aIncludeDefaultFields = true 
) const

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

Parameters
aFieldNameis the name of the field
aIncludeDefaultFieldsis used to search the default library symbol fields in the search.

Definition at line 818 of file sch_component.cpp.

References TEMPLATE_FIELDNAME::GetDefaultFieldName(), m_Fields, and MANDATORY_FIELDS.

819 {
820  // Field name for comparison
821  wxString cmpFieldName;
822 
823  if( aIncludeDefaultFields )
824  {
825 
826  // Default field names
827  for ( unsigned int i=0; i<MANDATORY_FIELDS; i++)
828  {
829  cmpFieldName = TEMPLATE_FIELDNAME::GetDefaultFieldName( i );
830 
831  if( cmpFieldName.Cmp( aFieldName ) == 0 )
832  {
833  return m_Fields[i].GetText();
834  }
835  }
836  }
837 
838  // Search custom fields
839  for( unsigned int ii=MANDATORY_FIELDS; ii<m_Fields.size(); ii++ )
840  {
841  cmpFieldName = m_Fields[ii].GetName();
842 
843  if( cmpFieldName.Cmp( aFieldName ) == 0 )
844  {
845  return m_Fields[ii].GetText();
846  }
847  }
848 
849  return wxEmptyString;
850 }
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:91
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...
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 255 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(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), 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(), 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(), SCH_SCREEN::GetConnection(), InitialiseDragParameters(), LIB_EDIT_FRAME::LoadOneSymbol(), Magnetize(), SCH_EDIT_FRAME::MirrorImage(), SCH_EDIT_FRAME::MirrorSheet(), moveBitmap(), 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(), SCH_EDIT_FRAME::OnMoveItem(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), 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(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), 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(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_SCREEN::SelectBlockItems(), SCH_EDIT_FRAME::SetBusEntryShape(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_MODULE_BOARD_EDITOR::TransferDataFromWindow().

255 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
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 1762 of file sch_component.cpp.

1763 {
1764  return add_component_xpm;
1765 }
void SCH_COMPONENT::GetMsgPanelInfo ( 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 1719 of file sch_component.cpp.

References BROWN, DARKCYAN, DARKRED, FOOTPRINT, FROM_UTF8(), LIB_ALIAS::GetDescription(), GetField(), LIB_ALIAS::GetKeyWords(), GetLibId(), LIB_ALIAS::GetLibraryName(), LIB_ALIAS::GetName(), GetRef(), EDA_TEXT::GetShownText(), SCH_FIELD::IsVoid(), m_currentSheetPath, m_part, and VALUE.

Referenced by SCH_EDIT_FRAME::Load_Component().

1720 {
1721  // part and alias can differ if alias is not the root
1722  if( PART_SPTR part = m_part.lock() )
1723  {
1724  LIB_ALIAS* alias = part->GetAlias( FROM_UTF8( GetLibId().GetLibItemName() ) );
1725 
1726  if( !alias )
1727  return;
1728 
1729  if( m_currentSheetPath )
1730  aList.push_back( MSG_PANEL_ITEM( _( "Reference" ),
1732  DARKCYAN ) );
1733 
1734  wxString msg = part->IsPower() ? _( "Power symbol" ) : _( "Value" );
1735 
1736  aList.push_back( MSG_PANEL_ITEM( msg, GetField( VALUE )->GetShownText(), DARKCYAN ) );
1737 
1738  // Display component reference in library and library
1739  aList.push_back( MSG_PANEL_ITEM( _( "Component" ), FROM_UTF8( GetLibId().GetLibItemName() ),
1740  BROWN ) );
1741 
1742  if( alias->GetName() != part->GetName() )
1743  aList.push_back( MSG_PANEL_ITEM( _( "Alias of" ), part->GetName(), BROWN ) );
1744 
1745  aList.push_back( MSG_PANEL_ITEM( _( "Library" ), alias->GetLibraryName(), BROWN ) );
1746 
1747  // Display the current associated footprint, if exists.
1748  if( !GetField( FOOTPRINT )->IsVoid() )
1749  msg = GetField( FOOTPRINT )->GetShownText();
1750  else
1751  msg = _( "<Unknown>" );
1752 
1753  aList.push_back( MSG_PANEL_ITEM( _( "Footprint" ), msg, DARKRED ) );
1754 
1755  // Display description of the component, and keywords found in lib
1756  aList.push_back( MSG_PANEL_ITEM( _( "Description" ), alias->GetDescription(), DARKCYAN ) );
1757  aList.push_back( MSG_PANEL_ITEM( _( "Key Words" ), alias->GetKeyWords(), DARKCYAN ) );
1758  }
1759 }
Part library alias object definition.
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
const SCH_SHEET_PATH * m_currentSheetPath
A temporary sheet path is required to generate the correct reference designator string in complex hie...
const wxString GetLibraryName()
bool IsVoid() const
Function IsVoid returns true if the field is either empty or holds "~".
Definition: sch_field.h:116
Field Name Module PCB, i.e. "16DIP300".
Definition: colors.h:54
virtual wxString GetShownText() const
Returns the string actually shown after processing of the base text.
Definition: eda_text.h:135
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
wxString GetDescription() const
const wxString GetRef(const SCH_SHEET_PATH *aSheet)
Return the reference for the given sheet path.
Field Value of part, i.e. "3.3K".
const wxString & GetName() const
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
wxString GetKeyWords() const
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 2080 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().

2082 {
2083  if( PART_SPTR part = m_part.lock() )
2084  {
2085  for( LIB_PIN* pin = part->GetNextPin(); pin; pin = part->GetNextPin( pin ) )
2086  {
2087  wxASSERT( pin->Type() == LIB_PIN_T );
2088 
2089  if( pin->GetUnit() && ( pin->GetUnit() != GetUnitSelection( aSheetPath ) ) )
2090  continue;
2091 
2092  if( pin->GetConvert() && ( pin->GetConvert() != GetConvert() ) )
2093  continue;
2094 
2095  wxPoint pos = GetTransform().TransformCoordinate( pin->GetPosition() ) + m_Pos;
2096 
2097  NETLIST_OBJECT* item = new NETLIST_OBJECT();
2098  item->m_SheetPathInclude = *aSheetPath;
2099  item->m_Comp = (SCH_ITEM*) pin;
2100  item->m_SheetPath = *aSheetPath;
2101  item->m_Type = NET_PIN;
2102  item->m_Link = (SCH_ITEM*) this;
2103  item->m_ElectricalPinType = pin->GetType();
2104  item->m_PinNum = pin->GetNumber();
2105  item->m_Label = pin->GetName();
2106  item->m_Start = item->m_End = pos;
2107 
2108  aNetListItems.push_back( item );
2109 
2110  if( pin->IsPowerConnection() )
2111  {
2112  // There is an associated PIN_LABEL.
2113  item = new NETLIST_OBJECT();
2114  item->m_SheetPathInclude = *aSheetPath;
2115  item->m_Comp = NULL;
2116  item->m_SheetPath = *aSheetPath;
2117  item->m_Type = NET_PINLABEL;
2118  item->m_Label = pin->GetName();
2119  item->m_Start = pos;
2120  item->m_End = item->m_Start;
2121 
2122  aNetListItems.push_back( item );
2123  }
2124  }
2125  }
2126 }
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:77
int GetUnitSelection(SCH_SHEET_PATH *aSheet)
SCH_SHEET_PATH m_SheetPath
ELECTRICAL_PINTYPE m_ElectricalPinType
NETLIST_ITEM_T m_Type
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's libraries to the LIB_PART for this component
Definition: sch_component.h:93
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
int SCH_COMPONENT::GetOrientation ( void  )

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 1148 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, ROTATE_VALUES_COUNT, and SetOrientation().

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyOptionsToPanel(), and AUTOPLACER::get_preferred_sides().

1149 {
1150  int type_rotate = CMP_ORIENT_0;
1151  TRANSFORM transform;
1152  int ii;
1153 
1154  #define ROTATE_VALUES_COUNT 12
1155 
1156  // list of all possibilities, but only the first 8 are actually used
1157  int rotate_value[ROTATE_VALUES_COUNT] =
1158  {
1164  CMP_MIRROR_Y + CMP_ORIENT_180, CMP_MIRROR_Y + CMP_ORIENT_270
1165  };
1166 
1167  // Try to find the current transform option:
1168  transform = m_transform;
1169 
1170  for( ii = 0; ii < ROTATE_VALUES_COUNT; ii++ )
1171  {
1172  type_rotate = rotate_value[ii];
1173  SetOrientation( type_rotate );
1174 
1175  if( transform == m_transform )
1176  return type_rotate;
1177  }
1178 
1179  // Error: orientation not found in list (should not happen)
1180  wxMessageBox( wxT( "Component orientation matrix internal error" ) );
1181  m_transform = transform;
1182 
1183  return CMP_NORMAL;
1184 }
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
#define ROTATE_VALUES_COUNT
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:90
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
PART_REF& SCH_COMPONENT::GetPartRef ( )
inline
wxString SCH_COMPONENT::GetPath ( const SCH_SHEET_PATH sheet) const

Definition at line 592 of file sch_component.cpp.

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

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

593 {
594  wxCHECK_MSG( sheet != NULL, wxEmptyString,
595  wxT( "Cannot get component path with invalid sheet object." ) );
596 
597  wxString str;
598 
599  str.Printf( wxT( "%8.8lX" ), (long unsigned) m_TimeStamp );
600  return sheet->Path() + str;
601 }
time_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:169
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 155 of file sch_component.h.

References m_PathsAndReferences.

Referenced by SCH_LEGACY_PLUGIN::saveComponent().

155 { 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 177 of file sch_item_struct.h.

Referenced by SCH_BUS_ENTRY_BASE::Draw(), SCH_JUNCTION::GetBoundingBox(), SCH_BUS_ENTRY_BASE::GetBoundingBox(), SCH_BUS_ENTRY_BASE::Plot(), and SCH_BITMAP::Plot().

177 { 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 888 of file sch_component.cpp.

References m_convert, m_part, and m_unit.

Referenced by SCH_EDIT_FRAME::FindComponentAndItem().

889 {
890  if( PART_SPTR part = m_part.lock() )
891  {
892  return part->GetPin( number, m_unit, m_convert );
893  }
894  return NULL;
895 }
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
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:82
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
wxPoint SCH_COMPONENT::GetPinPhysicalPosition ( LIB_PIN Pin)

Definition at line 1937 of file sch_component.cpp.

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

Referenced by GetEndPoints(), SCH_SCREEN::GetPin(), and IsPinDanglingStateChanged().

1938 {
1939  wxCHECK_MSG( Pin != NULL && Pin->Type() == LIB_PIN_T, wxPoint( 0, 0 ),
1940  wxT( "Cannot get physical position of pin." ) );
1941 
1942  return m_transform.TransformCoordinate( Pin->GetPosition() ) + m_Pos;
1943 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
wxPoint GetPosition() const override
Function GetPosition returns the current draw object position.
Definition: lib_pin.h:472
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:90
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 898 of file sch_component.cpp.

References m_convert, m_part, and m_unit.

Referenced by NETLIST_EXPORTER_PSPICE::GetSpiceFieldDefVal(), and AUTOPLACER::pins_on_side().

899 {
900  if( PART_SPTR part = m_part.lock() )
901  {
902  part->GetPins( aPinsList, m_unit, m_convert );
903  }
904  else
905  wxFAIL_MSG( "Could not obtain PART_SPTR lock" );
906 }
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
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:82
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
wxPoint SCH_COMPONENT::GetPosition ( ) const
inlineoverridevirtual

Function GetPosition.

Returns
A wxPoint object containing the schematic item position.

Implements SCH_ITEM.

Definition at line 606 of file sch_component.h.

References m_Pos.

Referenced by SCH_FIELD::Draw(), SCH_EDIT_FRAME::FindComponentAndItem(), SCH_FIELD::GetBoundingBox(), LIB_PIN::GetMsgPanelInfo(), SCH_FIELD::GetPosition(), SCH_COLLECTOR::Inspect(), SCH_FIND_COLLECTOR::Inspect(), SCH_LEGACY_PLUGIN::saveComponent(), SCH_REFERENCE::SCH_REFERENCE(), and SCH_SCREEN::SetComponentFootprint().

606 { return m_Pos; }
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
wxString SCH_COMPONENT::GetPrefix ( ) const
inline

Definition at line 225 of file sch_component.h.

References m_prefix.

Referenced by SCH_LEGACY_PLUGIN::saveComponent().

225 { 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:86
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 604 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(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::InitBuffers(), NETLIST_EXPORTER_GENERIC::makeComponents(), NETLIST_EXPORTER_GENERIC::makeListOfNets(), SCH_FIELD::Matches(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SCREEN::SetComponentFootprint(), SCH_SHEET_PATH::UpdateAllScreenReferences(), NETLIST_EXPORTER_CADSTAR::writeListOfNets(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

605 {
606  wxString path = GetPath( sheet );
607  wxString h_path, h_ref;
608  wxStringTokenizer tokenizer;
609  wxString separators( wxT( " " ) );
610 
611  for( unsigned ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
612  {
613  tokenizer.SetString( m_PathsAndReferences[ii], separators );
614  h_path = tokenizer.GetNextToken();
615 
616  if( h_path.Cmp( path ) == 0 )
617  {
618  h_ref = tokenizer.GetNextToken();
619 
620  /* printf( "GetRef hpath: %s\n",
621  * TO_UTF8( m_PathsAndReferences[ii] ) ); */
622  return h_ref;
623  }
624  }
625 
626  // if it was not found in m_Paths array, then see if it is in
627  // m_Field[REFERENCE] -- if so, use this as a default for this path.
628  // this will happen if we load a version 1 schematic file.
629  // it will also mean that multiple instances of the same sheet by default
630  // all have the same component references, but perhaps this is best.
631  if( !GetField( REFERENCE )->GetText().IsEmpty() )
632  {
633  SetRef( sheet, GetField( REFERENCE )->GetText() );
634  return GetField( REFERENCE )->GetText();
635  }
636 
637  return m_prefix;
638 }
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:130
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:86
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 1187 of file sch_component.cpp.

References m_transform, and TRANSFORM::TransformCoordinate().

Referenced by SCH_FIELD::Draw().

1188 {
1189  return m_transform.TransformCoordinate( aPoint );
1190 }
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:90
wxString SCH_COMPONENT::GetSelectMenuText ( ) 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 2005 of file sch_component.cpp.

References FROM_UTF8(), GetChars(), GetField(), GetLibId(), and REFERENCE.

Referenced by Matches().

2006 {
2007  wxString tmp;
2008  tmp.Printf( _( "Component %s, %s" ),
2009  FROM_UTF8( GetLibId().GetLibItemName() ),
2010  GetChars( GetField( REFERENCE )->GetShownText() ) );
2011  return tmp;
2012 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
Field Reference of part, i.e. "IC21".
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
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
const LIB_ID & GetLibId() const
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 250 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

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

Definition at line 156 of file sch_item_struct.h.

References SCH_ITEM::m_storedPos.

Referenced by moveItemWithMouseCursor().

156 { 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) ...
TRANSFORM& SCH_COMPONENT::GetTransform ( ) const
inline
int SCH_COMPONENT::GetUnit ( ) const
inline
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 485 of file sch_component.cpp.

References m_part.

Referenced by NETLIST_EXPORTER_GENERIC::addComponentFields(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyOptionsToPanel(), SCH_FIELD::GetFullyQualifiedText(), and SCH_FIELD::Matches().

486 {
487  if( PART_SPTR part = m_part.lock() )
488  {
489  return part->GetUnitCount();
490  }
491 
492  return 0;
493 }
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
int SCH_COMPONENT::GetUnitSelection ( SCH_SHEET_PATH aSheet)

Definition at line 739 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(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

740 {
741  wxString path = GetPath( aSheet );
742  wxString h_path, h_multi;
743  wxStringTokenizer tokenizer;
744  wxString separators( wxT( " " ) );
745 
746  for( unsigned ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
747  {
748  tokenizer.SetString( m_PathsAndReferences[ii], separators );
749  h_path = tokenizer.GetNextToken();
750 
751  if( h_path.Cmp( path ) == 0 )
752  {
753  tokenizer.GetNextToken(); // Skip reference
754  h_multi = tokenizer.GetNextToken();
755  long imulti = 1;
756  h_multi.ToLong( &imulti );
757  return imulti;
758  }
759  }
760 
761  // if it was not found in m_Paths array, then use m_unit.
762  // this will happen if we load a version 1 schematic file.
763  return m_unit;
764 }
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:82
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 316 of file sch_item_struct.h.

317  {
318  return HitTest( aPosition, 0 );
319  }
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 2206 of file sch_component.cpp.

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

2207 {
2208  EDA_RECT bBox = GetBodyBoundingBox();
2209  bBox.Inflate( aAccuracy );
2210 
2211  if( bBox.Contains( aPosition ) )
2212  return true;
2213 
2214  return false;
2215 }
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.
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 2218 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.

2219 {
2221  return false;
2222 
2223  EDA_RECT rect = aRect;
2224 
2225  rect.Inflate( aAccuracy );
2226 
2227  if( aContained )
2228  return rect.Contains( GetBodyBoundingBox() );
2229 
2230  return rect.Intersects( GetBodyBoundingBox() );
2231 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:124
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:122
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:175
Class EDA_RECT handles the component boundary box.
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 229 of file sch_component.cpp.

References AddField(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), 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().

230 {
231  m_Pos = pos;
232  m_unit = 0; // In multi unit chip - which unit to draw.
233  m_convert = 0; // De Morgan Handling
234 
235  // The rotation/mirror transformation matrix. pos normal
237 
238  // construct only the mandatory fields, which are the first 4 only.
239  for( int i = 0; i < MANDATORY_FIELDS; ++i )
240  {
241  SCH_FIELD field( pos, i, this, TEMPLATE_FIELDNAME::GetDefaultFieldName( i ) );
242 
243  if( i == REFERENCE )
244  field.SetLayer( LAYER_REFERENCEPART );
245  else if( i == VALUE )
246  field.SetLayer( LAYER_VALUEPART );
247 
248  // else keep LAYER_FIELDS from SCH_FIELD constructor
249 
250  // SCH_FIELD's implicitly created copy constructor is called in here
251  AddField( field );
252  }
253 
254  m_prefix = wxString( wxT( "U" ) );
255 }
Class SCH_FIELD instances are attached to a component and provide a place for the component'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:77
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:82
Field Value of part, i.e. "3.3K".
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:86
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:90
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 224 of file base_struct.h.

References BRIGHTENED.

Referenced by SELECTION_TOOL::disambiguationMenu().

224 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:137
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
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 567 of file sch_component.h.

567 { 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:124
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:122
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
bool SCH_COMPONENT::IsDangling ( ) const
overridevirtual

Return whether any pin in this symbol is dangling.

Note
This does not update the internal status. It only checks the existing status.
Returns
true if any pins of this symbol are not connect otherwise false.

Reimplemented from SCH_ITEM.

Definition at line 1926 of file sch_component.cpp.

References m_isDangling.

1927 {
1928  for( bool each : m_isDangling )
1929  {
1930  if( each )
1931  return true;
1932  }
1933  return false;
1934 }
std::vector< bool > m_isDangling
One isDangling per pin.
Definition: sch_component.h:95
bool SCH_COMPONENT::IsDanglingStateChanged ( std::vector< DANGLING_END_ITEM > &  aItemList)
overridevirtual

Test if the component's dangling state has changed for all pins.

As a side effect, actually update the dangling status for all pins.

Note
This does not test for short circuits.
Parameters
aItemListis list of all DANGLING_END_ITEM items to be tested.
Returns
true if any pin's state has changed.

Reimplemented from SCH_ITEM.

Definition at line 1911 of file sch_component.cpp.

References IsPinDanglingStateChanged(), m_convert, m_part, and m_unit.

1912 {
1913  bool changed = false;
1914  LIB_PINS libPins;
1915  if( PART_SPTR part = m_part.lock() )
1916  part->GetPins( libPins, m_unit, m_convert );
1917  for( size_t i = 0; i < libPins.size(); ++i )
1918  {
1919  if( IsPinDanglingStateChanged( aItemList, libPins, i ) )
1920  changed = true;
1921  }
1922  return changed;
1923 }
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
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:82
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_draw_item.h:70
bool IsPinDanglingStateChanged(std::vector< DANGLING_END_ITEM > &aItemList, LIB_PINS &aLibPins, unsigned aPin)
Test if the symbol's dangling state has changed for one given pin index.
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
bool EDA_ITEM::IsDragging ( ) const
inlineinherited
bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 223 of file base_struct.h.

References HIGHLIGHTED.

223 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:136
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
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 2250 of file sch_component.cpp.

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

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

2251 {
2252  SCH_FIELD* rf = GetField( REFERENCE );
2253  return ! rf->GetText().StartsWith( wxT( "#" ) );
2254 }
Class SCH_FIELD instances are attached to a component and provide a place for the component'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:130
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 217 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

217 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:109
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
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 166 of file sch_component.h.

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

Definition at line 216 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(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), AbortSymbolTraceOn(), SCH_EDIT_FRAME::addCurrentItemToList(), 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(), DrawMovePin(), SCH_EDIT_FRAME::EditSheetPin(), LIB_PIN::EnableEditMode(), LIB_EDIT_FRAME::EndDrawGraphicItem(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), 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(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_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(), and DIALOG_LABEL_EDITOR::TextPropertiesAccept().

216 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:113
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
bool SCH_COMPONENT::IsPinDanglingStateChanged ( std::vector< DANGLING_END_ITEM > &  aItemList,
LIB_PINS aLibPins,
unsigned  aPin 
)

Test if the symbol's dangling state has changed for one given pin index.

As a side effect, it actually updates the dangling status for that pin.

Parameters
aItemListis list of all DANGLING_END_ITEM items to be tested.
aLibPinsis list of all the LIB_PIN items in this symbol
aPinis the index into aLibPins that identifies the pin to test
Returns
true if the pin's state has changed.

Definition at line 1854 of file sch_component.cpp.

References GetPinPhysicalPosition(), IsInNetlist(), LIB_PIN::IsPowerConnection(), JUNCTION_END, LABEL_END, m_isDangling, NO_CONNECT_END, PIN_END, SHEET_LABEL_END, WIRE_END_END, and WIRE_START_END.

Referenced by IsDanglingStateChanged().

1856 {
1857  bool previousState;
1858 
1859  if( aPin < m_isDangling.size() )
1860  {
1861  previousState = m_isDangling[aPin];
1862  m_isDangling[aPin] = true;
1863  }
1864  else
1865  {
1866  previousState = true;
1867  m_isDangling.push_back( true );
1868  }
1869 
1870  wxPoint pin_position = GetPinPhysicalPosition( aLibPins[aPin] );
1871 
1872  for( DANGLING_END_ITEM& each_item : aItemList )
1873  {
1874  // Some people like to stack pins on top of each other in a symbol to indicate
1875  // internal connection. While technically connected, it is not particularly useful
1876  // to display them that way, so skip any pins that are in the same symbol as this
1877  // one.
1878  //
1879  // Do not make this exception for hidden pins, because those actually make internal
1880  // connections to a power net.
1881  const LIB_PIN* item_pin = dynamic_cast<const LIB_PIN*>( each_item.GetItem() );
1882 
1883  if( item_pin
1884  && ( !item_pin->IsPowerConnection() || !IsInNetlist() )
1885  && std::find( aLibPins.begin(), aLibPins.end(), item_pin) != aLibPins.end() )
1886  continue;
1887 
1888  switch( each_item.GetType() )
1889  {
1890  case PIN_END:
1891  case LABEL_END:
1892  case SHEET_LABEL_END:
1893  case WIRE_START_END:
1894  case WIRE_END_END:
1895  case NO_CONNECT_END:
1896  case JUNCTION_END:
1897  if( pin_position == each_item.GetPosition() )
1898  m_isDangling[aPin] = false;
1899  break;
1900  default:
1901  break;
1902  }
1903  if( !m_isDangling[aPin] )
1904  break;
1905  }
1906 
1907  return previousState != m_isDangling[aPin];
1908 }
std::vector< bool > m_isDangling
One isDangling per pin.
Definition: sch_component.h:95
wxPoint GetPinPhysicalPosition(LIB_PIN *Pin)
bool IsInNetlist() const
bool IsPowerConnection() const
Return whether this pin forms an implicit power connection: i.e., is hidden and of type POWER_IN...
Definition: lib_pin.h:379
Class DANGLING_END_ITEM is a helper class used to store the state of schematic items that can be conn...
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 641 of file sch_component.cpp.

Referenced by ClearAnnotation(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), SetRef(), and DIALOG_EDIT_ONE_FIELD::TransferDataFromWindow().

642 {
643  wxString text = aReferenceString;
644  bool ok = true;
645 
646  // Try to unannotate this reference
647  while( !text.IsEmpty() && ( text.Last() == '?' || isdigit( text.Last() ) ) )
648  text.RemoveLast();
649 
650  if( text.IsEmpty() )
651  ok = false;
652 
653  // Add here other constraints
654  // Currently:no other constraint
655 
656  return ok;
657 }
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 604 of file sch_component.h.

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

Definition at line 222 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

222 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:114
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 1946 of file sch_component.cpp.

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

1947 {
1948  bool previousState = IsSelected();
1949 
1951 
1952  if( aRect.Intersects( boundingBox ) )
1953  SetFlags( SELECTED );
1954  else
1955  ClearFlags( SELECTED );
1956 
1957  return previousState != IsSelected();
1958 }
bool IsSelected() const
Definition: base_struct.h:221
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:120
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
Class EDA_RECT handles the component boundary box.
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 220 of file base_struct.h.

References IS_WIRE_IMAGE.

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

220 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:117
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
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 132 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(), MODULE::Visit(), and BOARD::Visit().

136 {
137  EDA_ITEM* p = listStart;
138 
139  for( ; p; p = p->Pnext )
140  {
141  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
142  return SEARCH_QUIT;
143  }
144 
145  return SEARCH_CONTINUE;
146 }
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:151
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:164
bool SCH_COMPONENT::Load ( LINE_READER aLine,
wxString &  aErrorMsg 
)
overridevirtual

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.

Reimplemented from SCH_ITEM.

Definition at line 1346 of file sch_component.cpp.

References AddField(), AddHierarchicalReference(), LIB_ID::clear(), EDA_TEXT::Empty(), FROM_UTF8(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), GetDefaultTextSize(), GetField(), GetFieldCount(), GetText(), EDA_TEXT::GetText(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, LINE_READER::Line(), LINE_READER::LineNumber(), m_convert, EDA_ITEM::m_Flags, m_lib_id, m_Pos, m_prefix, EDA_ITEM::m_TimeStamp, m_transform, m_unit, MANDATORY_FIELDS, MAX_UNIT_COUNT_PER_PACKAGE, NULL_STRING, ReadDelimitedText(), LINE_READER::ReadLine(), REFERENCE, EDA_TEXT::SetBold(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), LIB_ID::SetLibItemName(), SCH_FIELD::SetName(), EDA_TEXT::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), TEXT_ANGLE_HORIZ, TEXT_ANGLE_VERT, timeStamp(), TO_UTF8, VALUE, wxPoint::x, TRANSFORM::x1, TRANSFORM::x2, wxPoint::y, TRANSFORM::y1, and TRANSFORM::y2.

1347 {
1348  // Remark: avoid using sscanf to read texts entered by user
1349  // which are UTF8 encoded, because sscanf does not work well on Windows
1350  // with some UTF8 values.
1351  char name1[256], char1[256], char2[256], char3[256];
1352  int newfmt = 0;
1353  char* ptcar;
1354  wxString fieldName;
1355  char* line = aLine.Line();
1356  unsigned long timeStamp;
1357 
1358  m_convert = 1;
1359 
1360  if( line[0] == '$' )
1361  {
1362  newfmt = 1;
1363 
1364  if( !(line = aLine.ReadLine()) )
1365  return true;
1366  }
1367 
1368  // Parse the first line of description:
1369  // like "L partname ref" (for instance "L 74LS00 U4"
1370  // They are UTF8 texts, so do not use sscanf
1371 
1372  line += 1;
1373 
1374  if( *line == ' ' )
1375  line++;
1376 
1377  // line points the first parameter
1378  wxString buffer( FROM_UTF8( line ) );
1379  wxStringTokenizer tokenizer( buffer, wxT( " \r\n" ) );
1380 
1381  if( tokenizer.CountTokens() < 2 )
1382  {
1383  aErrorMsg.Printf( wxT( "Eeschema component description error at line %d, aborted" ),
1384  aLine.LineNumber() );
1385  aErrorMsg << wxT( "\n" ) << FROM_UTF8( line );
1386  return false;
1387  }
1388 
1389  wxString partname = tokenizer.NextToken();
1390  partname.Replace( wxT("~"), wxT(" ") ); // all spaces were replaced by ~ in files.
1391 
1392  if( partname != NULL_STRING )
1393  {
1394  m_lib_id.SetLibItemName( TO_UTF8( partname ), false );
1395 
1396  if( !newfmt )
1397  GetField( VALUE )->SetText( partname );
1398  }
1399  else
1400  {
1401  m_lib_id.clear();
1402  GetField( VALUE )->Empty();
1404  GetField( VALUE )->SetVisible( false );
1405  }
1406 
1407  wxString reference = tokenizer.NextToken();
1408  reference.Replace( wxT("~"), wxT(" ") ); // all spaces were replaced by ~ in files.
1409  reference.Trim( true );
1410  reference.Trim( false );
1411 
1412  if( reference != NULL_STRING )
1413  {
1414  wxString prefix = reference;
1415  // Build reference prefix from the actual reference by removing trailing digits
1416  // (Perhaps outdated code, only for very old schematic files)
1417  while( prefix.Length() )
1418  {
1419  if( ( prefix.Last() < '0' || prefix.Last() > '9') && prefix.Last() != '?' )
1420  break;
1421 
1422  prefix.RemoveLast();
1423  }
1424 
1425  // Avoid a prefix containing trailing/leading spaces
1426  prefix.Trim( true );
1427  prefix.Trim( false );
1428 
1429  if( prefix.IsEmpty() )
1430  m_prefix = wxT( "U" );
1431  else
1432  m_prefix = prefix;
1433 
1434  if( !newfmt )
1435  GetField( REFERENCE )->SetText( reference );
1436  }
1437  else
1438  {
1439  GetField( REFERENCE )->SetVisible( false );
1440  }
1441 
1442  /* Parse component description
1443  * These lines begin with:
1444  * "P" = Position
1445  * U = Num Unit and Conversion
1446  * "Fn" = Fields (0 .. n = = number of field)
1447  * "Ar" = Alternate reference in the case of multiple sheets referring to
1448  * one schematic file.
1449  */
1450  for( ; ; )
1451  {
1452  if( !(line = aLine.ReadLine()) )
1453  return false;
1454 
1455  if( line[0] == 'U' )
1456  {
1457  sscanf( line + 1, "%d %d %lX", &m_unit, &m_convert, &timeStamp );
1458  m_TimeStamp = (time_t)timeStamp;
1459  }
1460  else if( line[0] == 'P' )
1461  {
1462  sscanf( line + 1, "%d %d", &m_Pos.x, &m_Pos.y );
1463 
1464  // Set fields position to a default position (that is the
1465  // component position. For existing fields, the real position
1466  // will be set later
1467  for( int i = 0; i<GetFieldCount(); i++ )
1468  {
1469  if( GetField( i )->GetText().IsEmpty() )
1470  GetField( i )->SetTextPos( m_Pos );
1471  }
1472  }
1473  else if( line[0] == 'A' && line[1] == 'R' )
1474  {
1475  /* format:
1476  * AR Path="/9086AF6E/67452AA0" Ref="C99" Part="1"
1477  * where 9086AF6E is the unique timestamp of the containing sheet
1478  * and 67452AA0 is the timestamp of this component.
1479  * C99 is the reference given this path.
1480  */
1481  int ii;
1482  ptcar = line + 2;
1483 
1484  //copy the path.
1485  ii = ReadDelimitedText( name1, ptcar, 255 );
1486  ptcar += ii + 1;
1487  wxString path = FROM_UTF8( name1 );
1488 
1489  // copy the reference
1490  ii = ReadDelimitedText( name1, ptcar, 255 );
1491  ptcar += ii + 1;
1492  wxString ref = FROM_UTF8( name1 );
1493 
1494  // copy the multi, if exists
1495  ii = ReadDelimitedText( name1, ptcar, 255 );
1496 
1497  if( name1[0] == 0 ) // Nothing read, put a default value
1498  sprintf( name1, "%d", m_unit );
1499 
1500  int multi = atoi( name1 );
1501 
1502  // Avoid out of range multi id:
1503  if( multi < 0 || multi > MAX_UNIT_COUNT_PER_PACKAGE )
1504  multi = 1;
1505 
1506  AddHierarchicalReference( path, ref, multi );
1507  GetField( REFERENCE )->SetText( ref );
1508  }
1509  else if( line[0] == 'F' )
1510  {
1511  int fieldNdx;
1512 
1513  wxString fieldText;
1516 
1517  ptcar = (char*) aLine;
1518 
1519  while( *ptcar && (*ptcar != '"') )
1520  ptcar++;
1521 
1522  if( *ptcar != '"' )
1523  {
1524  aErrorMsg.Printf( wxT( "Eeschema file library field F at line %d, aborted" ),
1525  aLine.LineNumber() );
1526  return false;
1527  }
1528 
1529  ptcar += ReadDelimitedText( &fieldText, ptcar );
1530 
1531  if( *ptcar == 0 )
1532  {
1533  aErrorMsg.Printf( wxT( "Component field F at line %d, aborted" ),
1534  aLine.LineNumber() );
1535  return false;
1536  }
1537 
1538  fieldNdx = atoi( line + 2 );
1539 
1540  ReadDelimitedText( &fieldName, ptcar );
1541 
1542  if( fieldName.IsEmpty() )
1543  fieldName = TEMPLATE_FIELDNAME::GetDefaultFieldName( fieldNdx );
1544 
1545  if( fieldNdx >= GetFieldCount() )
1546  {
1547  // The first MANDATOR_FIELDS _must_ be constructed within
1548  // the SCH_COMPONENT constructor. This assert is simply here
1549  // to guard against a change in that constructor.
1550  wxASSERT( GetFieldCount() >= MANDATORY_FIELDS );
1551 
1552  // Ignore the _supplied_ fieldNdx. It is not important anymore
1553  // if within the user defined fields region (i.e. >= MANDATORY_FIELDS).
1554  // We freely renumber the index to fit the next available field slot.
1555 
1556  fieldNdx = GetFieldCount(); // new has this index after insertion
1557 
1558  SCH_FIELD field( wxPoint( 0, 0 ),
1559  -1, // field id is not relavant for user defined fields
1560  this, fieldName );
1561 
1562  AddField( field );
1563  }
1564  else
1565  {
1566  GetField( fieldNdx )->SetName( fieldName );
1567  }
1568 
1569  GetField( fieldNdx )->SetText( fieldText );
1570  memset( char3, 0, sizeof(char3) );
1571  int ii, x, y, w, attr;
1572 
1573  if( ( ii = sscanf( ptcar, "%255s %d %d %d %X %255s %255s", char1, &x, &y, &w, &attr,
1574  char2, char3 ) ) < 4 )
1575  {
1576  aErrorMsg.Printf( wxT( "Component Field error line %d, aborted" ),
1577  aLine.LineNumber() );
1578  continue;
1579  }
1580 
1581  GetField( fieldNdx )->SetTextPos( wxPoint( x, y ) );
1582  GetField( fieldNdx )->SetVisible( !attr );
1583 
1584  if( (w == 0 ) || (ii == 4) )
1585  w = GetDefaultTextSize();
1586 
1587  GetField( fieldNdx )->SetTextSize( wxSize( w, w ) );
1588  GetField( fieldNdx )->SetTextAngle( TEXT_ANGLE_HORIZ );
1589 
1590  if( char1[0] == 'V' )
1591  GetField( fieldNdx )->SetTextAngle( TEXT_ANGLE_VERT );
1592 
1593  if( ii >= 7 )
1594  {
1595  if( *char2 == 'L' )
1596  hjustify = GR_TEXT_HJUSTIFY_LEFT;
1597  else if( *char2 == 'R' )
1598  hjustify = GR_TEXT_HJUSTIFY_RIGHT;
1599 
1600  if( char3[0] == 'B' )
1601  vjustify = GR_TEXT_VJUSTIFY_BOTTOM;
1602  else if( char3[0] == 'T' )
1603  vjustify = GR_TEXT_VJUSTIFY_TOP;
1604 
1605  GetField( fieldNdx )->SetItalic( char3[1] == 'I' );
1606  GetField( fieldNdx )->SetBold( char3[2] == 'B' );
1607  GetField( fieldNdx )->SetHorizJustify( hjustify );
1608  GetField( fieldNdx )->SetVertJustify( vjustify );
1609  }
1610 
1611  if( fieldNdx == REFERENCE )
1612  if( GetField( fieldNdx )->GetText()[0] == '#' )
1613  GetField( fieldNdx )->SetVisible( false );
1614  }
1615  else
1616  {
1617  break;
1618  }
1619  }
1620 
1621  if( sscanf( line, "%d %d %d", &m_unit, &m_Pos.x, &m_Pos.y ) != 3 )
1622  {
1623  aErrorMsg.Printf( wxT( "Component unit & pos error at line %d, aborted" ),
1624  aLine.LineNumber() );
1625  return false;
1626  }
1627 
1628  if( !(line = aLine.ReadLine()) ||
1629  sscanf( line, "%d %d %d %d",
1630  &m_transform.x1,
1631  &m_transform.y1,
1632  &m_transform.x2,
1633  &m_transform.y2 ) != 4 )
1634  {
1635  aErrorMsg.Printf( wxT( "Component orient error at line %d, aborted" ),
1636  aLine.LineNumber() );
1637  return false;
1638  }
1639 
1640  if( newfmt )
1641  {
1642  if( !(line = aLine.ReadLine()) )
1643  return false;
1644 
1645  if( strncasecmp( "$End", line, 4 ) != 0 )
1646  {
1647  aErrorMsg.Printf( wxT( "Component End expected at line %d, aborted" ),
1648  aLine.LineNumber() );
1649  return false;
1650  }
1651  }
1652 
1653  // ensure flags (mainly used in edit) are cleared.
1654  // some changes have set the modified flag
1655  m_Flags = 0;
1656 
1657  return true;
1658 }
void SetTextAngle(double aAngle)
Definition: eda_text.h:156
#define TEXT_ANGLE_HORIZ
Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to...
Definition: common.h:91
Class SCH_FIELD instances are attached to a component and provide a place for the component's value...
Definition: sch_field.h:56
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:47
virtual unsigned LineNumber() const
Function Line Number returns the line number of the last line read from this LINE_READER.
Definition: richio.h:159
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
int y2
Definition: transform.h:51
time_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:169
unsigned long timeStamp(wxXmlNode *aTree)
Make a unique time stamp.
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
void SetItalic(bool isItalic)
Definition: eda_text.h:169
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:223
void SetVisible(bool aVisible)
Definition: eda_text.h:175
int x2
Definition: transform.h:50
int x1
Definition: transform.h:48
static const wxString GetDefaultFieldName(int aFieldNdx)
Function GetDefaultFieldName returns a default symbol field name for field aFieldNdx for all componen...
#define MAX_UNIT_COUNT_PER_PACKAGE
The maximum number of units per package.
Definition: eeschema_id.h:48
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:214
#define TEXT_ANGLE_VERT
Definition: common.h:92
Field Reference of part, i.e. "IC21".
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
int y1
Definition: transform.h:49
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:130
void SetVertJustify(EDA_TEXT_VJUSTIFY_T aType)
Definition: eda_text.h:194
void Empty()
Definition: eda_text.h:231
SCH_FIELD * AddField(const SCH_FIELD &aField)
Add a field to the symbol.
wxString GetText(GRAPHIC_PINSHAPE shape)
Definition: pin_shape.cpp:33
void clear()
Function clear.
Definition: lib_id.cpp:114
int SetLibItemName(const UTF8 &aLibItemName, bool aTestForRev=true)
Function SetLibItemName.
Definition: lib_id.cpp:232
EDA_TEXT_VJUSTIFY_T
Definition: eda_text.h:54
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:82
Field Value of part, i.e. "3.3K".
#define NULL_STRING
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter...
int GetFieldCount() const
Return the number of fields in this symbol.
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:193
void AddHierarchicalReference(const wxString &aPath, const wxString &aRef, int aMulti)
Add a full hierarchical reference to this symbol.
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
void SetName(const wxString &aName)
Definition: sch_field.h:85
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
int ReadDelimitedText(wxString *aDest, const char *aSource)
Function ReadDelimitedText copies bytes from aSource delimited string segment to aDest wxString...
Definition: string.cpp:43
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:86
void SetBold(bool aBold)
Definition: eda_text.h:172
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:90
int GetDefaultTextSize()
Default size for text in general.
virtual void SetText(const wxString &aText)
Definition: eda_text.h:141
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 184 of file base_struct.cpp.

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

185 {
186  wxString text = aText;
187  wxString searchText = aSearchData.GetFindString();
188 
189  // Don't match if searching for replaceable item and the item doesn't support text replace.
190  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
191  return false;
192 
193  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
194  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
195 
196  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
197  {
198  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
199  return text.Matches( searchText );
200 
201  return text.MakeUpper().Matches( searchText.MakeUpper() );
202  }
203 
204  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
205  return aText.Find( searchText ) != wxNOT_FOUND;
206 
207  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
208 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:444
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 1823 of file sch_component.cpp.

References GetSelectMenuText(), and traceFindItem.

1825 {
1826  wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText() );
1827 
1828  // Components are searchable via the child field and pin item text.
1829  return false;
1830 }
const wxString traceFindItem
Flag to enable find item tracing using the WXTRACE environment variable.
wxString GetSelectMenuText() const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
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 1786 of file sch_component.cpp.

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

1787 {
1788  int dy = m_Pos.y;
1789 
1791  MIRROR( m_Pos.y, aXaxis_position );
1792  dy -= m_Pos.y; // dy,0 is the move vector for this transform
1793 
1794  for( int ii = 0; ii < GetFieldCount(); ii++ )
1795  {
1796  // Move the fields to the new position because the component itself has moved.
1797  wxPoint pos = GetField( ii )->GetTextPos();
1798  pos.y -= dy;
1799  GetField( ii )->SetTextPos( pos );
1800  }
1801 }
const wxPoint & GetTextPos() const
Definition: eda_text.h:224
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:223
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 1768 of file sch_component.cpp.

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

1769 {
1770  int dx = m_Pos.x;
1771 
1773  MIRROR( m_Pos.x, aYaxis_position );
1774  dx -= m_Pos.x; // dx,0 is the move vector for this transform
1775 
1776  for( int ii = 0; ii < GetFieldCount(); ii++ )
1777  {
1778  // Move the fields to the new position because the component itself has moved.
1779  wxPoint pos = GetField( ii )->GetTextPos();
1780  pos.x -= dx;
1781  GetField( ii )->SetTextPos( pos );
1782  }
1783 }
const wxPoint & GetTextPos() const
Definition: eda_text.h:224
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:223
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 505 of file sch_component.h.

References GetField(), GetFieldCount(), SCH_FIELD::Move(), and EDA_ITEM::SetModified().

Referenced by SetPosition().

506  {
507  if( aMoveVector == wxPoint( 0, 0 ) )
508  return;
509 
510  m_Pos += aMoveVector;
511 
512  for( int ii = 0; ii < GetFieldCount(); ii++ )
513  GetField( ii )->Move( aMoveVector );
514 
515  SetModified();
516  }
void Move(const wxPoint &aMoveVector) override
Function Move moves the item by aMoveVector to a new position.
Definition: sch_field.h:150
void SetModified()
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
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 144 of file sch_item_struct.h.

References EDA_ITEM::Pnext.

Referenced by SCH_SCREEN::addConnectedItemsToBlock(), SCH_SHEET_LIST::AnnotatePowerSymbols(), SCH_EDIT_FRAME::AppendOneEEProject(), SCH_SCREEN::BreakSegment(), SCH_SCREEN::BreakSegmentsOnJunctions(), NETLIST_OBJECT_LIST::BuildNetListInfo(), HIERARCHY_NAVIG_DLG::BuildSheetsTree(), SCH_SCREEN::CheckIfOnDrawList(), SCH_SCREEN::ClearAnnotation(), SCH_SCREEN::ClearDrawingState(), SCH_SCREEN::CountConnectedItems(), SCH_EDIT_FRAME::CreateArchiveLibrary(), SCH_SCREENS::DeleteAllMarkers(), DIALOG_ERC::DisplayERC_MarkersList(), SCH_SCREEN::Draw(), SCH_EDIT_FRAME::EndSegment(), SCH_SCREEN::ExtractWires(), 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_SCREEN::GetLine(), SCH_SCREENS::GetMarkerCount(), SCH_SHEET_PATH::GetMultiUnitComponents(), SCH_SCREEN::GetNode(), SCH_SCREEN::GetPin(), SCH_SCREEN::GetSheet(), SCH_SCREEN::GetSheetLabel(), SCH_SCREEN::GetWireOrBus(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SCREEN::MarkConnections(), SCH_EDIT_FRAME::OnConvertTextType(), DIALOG_ERC::OnLeftClickMarkersList(), SCH_SCREEN::Plot(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), SCH_SCREEN::ReplaceWires(), SCH_SCREEN::Save(), SCH_SCREEN::SchematicCleanUp(), SCH_SCREEN::SetComponentFootprint(), SCH_EDIT_FRAME::SetCurrentSheetHighlightFlags(), SCH_SCREEN::TestDanglingEnds(), TestDuplicateSheetNames(), and SCH_SCREEN::UpdatePickList().

144 { 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:164
bool SCH_COMPONENT::operator!= ( const SCH_COMPONENT aComponent) const

Definition at line 2166 of file sch_component.cpp.

2167 {
2168  return !( *this == aComponent );
2169 }
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 241 of file base_struct.cpp.

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

242 {
243  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
244  GetChars( GetClass() ) ) );
245 
246  return false;
247 }
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 2129 of file sch_component.cpp.

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

2130 {
2131  if( Type() != aItem.Type() )
2132  return Type() < aItem.Type();
2133 
2134  SCH_COMPONENT* component = (SCH_COMPONENT*) &aItem;
2135 
2136  EDA_RECT rect = GetBodyBoundingBox();
2137 
2138  if( rect.GetArea() != component->GetBodyBoundingBox().GetArea() )
2139  return rect.GetArea() < component->GetBodyBoundingBox().GetArea();
2140 
2141  if( m_Pos.x != component->m_Pos.x )
2142  return m_Pos.x < component->m_Pos.x;
2143 
2144  if( m_Pos.y != component->m_Pos.y )
2145  return m_Pos.y < component->m_Pos.y;
2146 
2147  return false;
2148 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
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.
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 2172 of file sch_component.cpp.

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

2173 {
2174  wxCHECK_MSG( Type() == aItem.Type(), *this,
2175  wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
2176  GetClass() );
2177 
2178  if( &aItem != this )
2179  {
2180  SCH_ITEM::operator=( aItem );
2181 
2182  SCH_COMPONENT* c = (SCH_COMPONENT*) &aItem;
2183 
2184  m_lib_id = c->m_lib_id;
2185  m_part = c->m_part;
2186  m_Pos = c->m_Pos;
2187  m_unit = c->m_unit;
2188  m_convert = c->m_convert;
2189  m_transform = c->m_transform;
2190 
2192 
2193  m_Fields = c->m_Fields; // std::vector's assignment operator.
2194 
2195  // Reparent fields after assignment to new component.
2196  for( int ii = 0; ii < GetFieldCount(); ++ii )
2197  {
2198  GetField( ii )->SetParent( this );
2199  }
2200  }
2201 
2202  return *this;
2203 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:91
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:77
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:213
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:82
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:83
wxString GetClass() const override
Function GetClass returns the class name.
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:90
bool SCH_COMPONENT::operator== ( const SCH_COMPONENT aComponent) const

Definition at line 2151 of file sch_component.cpp.

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

2152 {
2153  if( GetFieldCount() != aComponent.GetFieldCount() )
2154  return false;
2155 
2156  for( int i = VALUE; i < GetFieldCount(); i++ )
2157  {
2158  if( GetField( i )->GetText().Cmp( aComponent.GetField( i )->GetText() ) != 0 )
2159  return false;
2160  }
2161 
2162  return true;
2163 }
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:130
Field Value of part, i.e. "3.3K".
int GetFieldCount() const
Return the number of fields in this symbol.
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 2257 of file sch_component.cpp.

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

2258 {
2259  TRANSFORM temp;
2260 
2261  if( PART_SPTR part = m_part.lock() )
2262  {
2263  temp = GetTransform();
2264 
2265  part->Plot( aPlotter, GetUnit(), GetConvert(), m_Pos, temp );
2266 
2267  for( size_t i = 0; i < m_Fields.size(); i++ )
2268  {
2269  m_Fields[i].Plot( aPlotter );
2270  }
2271  }
2272 }
TRANSFORM & GetTransform() const
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:91
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
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's libraries to the LIB_PART for this component
Definition: sch_component.h:93
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
int GetUnit() const
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 211 of file base_struct.cpp.

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

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

212 {
213  wxCHECK_MSG( IsReplaceable(), false,
214  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
215 
216  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
217 
218  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
219  aSearchData.GetFindString() :
220  aSearchData.GetFindString().Upper() );
221 
222  if( result == wxNOT_FOUND )
223  return false;
224 
225  wxString prefix = aText.Left( result );
226  wxString suffix;
227 
228  if( aSearchData.GetFindString().length() + result < aText.length() )
229  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
230 
231  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
232  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
233  GetChars( suffix ) );
234 
235  aText = prefix + aSearchData.GetReplaceString() + suffix;
236 
237  return true;
238 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:444
const wxString traceFindReplace(wxT("KicadFindReplace"))
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 432 of file base_struct.h.

432 { 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 331 of file sch_component.cpp.

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

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

332 {
333  // I've never been happy that the actual individual PART_LIB is left up to
334  // flimsy search path ordering. None-the-less find a part based on that design:
335  if( LIB_PART* part = aLibs->FindLibPart( m_lib_id ) )
336  {
337  m_part = part->SharedPtr();
338  return true;
339  }
340 
341  return false;
342 }
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
Class LIB_PART defines a library part object.
LIB_PART * FindLibPart(const LIB_ID &aLibId, const wxString &aLibraryName=wxEmptyString)
Function FindLibPart searches all libraries in the list for a part.
bool SCH_COMPONENT::Resolve ( SYMBOL_LIB_TABLE aLibTable)

Definition at line 345 of file sch_component.cpp.

References LIB_ALIAS::GetPart(), SYMBOL_LIB_TABLE::LoadSymbol(), m_lib_id, m_part, and LIB_PART::SharedPtr().

346 {
347  LIB_ALIAS* alias = aLibTable.LoadSymbol( m_lib_id );
348 
349  if( alias && alias->GetPart() )
350  {
351  m_part = alias->GetPart()->SharedPtr();
352  return true;
353  }
354 
355  return false;
356 }
LIB_ALIAS * LoadSymbol(const wxString &aNickname, const wxString &aAliasName)
Load a LIB_ALIAS having aAliasName from the library given by aNickname.
Part library alias object definition.
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
PART_SPTR SharedPtr()
LIB_PART * GetPart() const
Function GetPart gets the shared LIB_PART.
void SCH_COMPONENT::ResolveAll ( const SCH_COLLECTOR aComponents,
PART_LIBS aLibs 
)
static

Definition at line 367 of file sch_component.cpp.

References COLLECTOR::GetCount(), m_lib_id, m_part, Resolve(), and sort_by_libid().

Referenced by SCH_SCREEN::CheckComponentsToPartsLinks().

368 {
369  // Usually, many components use the same part lib.
370  // to avoid too long calculation time the list of components is grouped
371  // and once the lib part is found for one member of a group, it is also
372  // set for all other members of this group
373  std::vector<SCH_COMPONENT*> cmp_list;
374 
375  // build the cmp list.
376  for( int i = 0; i < aComponents.GetCount(); ++i )
377  {
378  SCH_COMPONENT* cmp = dynamic_cast<SCH_COMPONENT*>( aComponents[i] );
379  wxASSERT( cmp );
380 
381  if( cmp ) // cmp == NULL should not occur.
382  cmp_list.push_back( cmp );
383  }
384 
385  // sort it by lib part. Cmp will be grouped by same lib part.
386  std::sort( cmp_list.begin(), cmp_list.end(), sort_by_libid );
387 
388  LIB_ID curr_libid;
389 
390  for( unsigned ii = 0; ii < cmp_list.size (); ++ii )
391  {
392  SCH_COMPONENT* cmp = cmp_list[ii];
393  curr_libid = cmp->m_lib_id;
394  cmp->Resolve( aLibs );
395 
396  // Propagate the m_part pointer to other members using the same lib_id
397  for( unsigned jj = ii+1; jj < cmp_list.size (); ++jj )
398  {
399  SCH_COMPONENT* next_cmp = cmp_list[jj];
400 
401  if( curr_libid != next_cmp->m_lib_id )
402  break;
403 
404  next_cmp->m_part = cmp->m_part;
405  ii = jj;
406  }
407  }
408 }
int GetCount() const
Function GetCount returns the number of objects in the list.
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)
Class LIB_ID.
Definition: lib_id.h:56
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
void SCH_COMPONENT::ResolveAll ( const SCH_COLLECTOR aComponents,
SYMBOL_LIB_TABLE aLibTable 
)
static

Definition at line 411 of file sch_component.cpp.

References COLLECTOR::GetCount(), m_lib_id, m_part, Resolve(), and sort_by_libid().

412 {
413  std::vector<SCH_COMPONENT*> cmp_list;
414 
415  for( int i = 0; i < aComponents.GetCount(); ++i )
416  {
417  SCH_COMPONENT* cmp = dynamic_cast<SCH_COMPONENT*>( aComponents[i] );
418 
419  wxCHECK2_MSG( cmp, continue, "Invalid SCH_COMPONENT pointer in list." );
420 
421  cmp_list.push_back( cmp );
422  }
423 
424  // sort it by lib part. Cmp will be grouped by same lib part.
425  std::sort( cmp_list.begin(), cmp_list.end(), sort_by_libid );
426 
427  LIB_ID curr_libid;
428 
429  for( unsigned ii = 0; ii < cmp_list.size (); ++ii )
430  {
431  SCH_COMPONENT* cmp = cmp_list[ii];
432  cmp->Resolve( aLibTable );
433 
434  // Propagate the m_part pointer to other members using the same lib_id
435  for( unsigned jj = ii+1; jj < cmp_list.size (); ++jj )
436  {
437  SCH_COMPONENT* next_cmp = cmp_list[jj];
438 
439  if( curr_libid != next_cmp->m_lib_id )
440  break;
441 
442  next_cmp->m_part = cmp->m_part;
443  ii = jj;
444  }
445  }
446 }
int GetCount() const
Function GetCount returns the number of objects in the list.
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)
Class LIB_ID.
Definition: lib_id.h:56
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
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 1804 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.

1805 {
1806  wxPoint prev = m_Pos;
1807 
1808  RotatePoint( &m_Pos, aPosition, 900 );
1809 
1811 
1812  for( int ii = 0; ii < GetFieldCount(); ii++ )
1813  {
1814  // Move the fields to the new position because the component itself has moved.
1815  wxPoint pos = GetField( ii )->GetTextPos();
1816  pos.x -= prev.x - m_Pos.x;
1817  pos.y -= prev.y - m_Pos.y;
1818  GetField( ii )->SetTextPos( pos );
1819  }
1820 }
const wxPoint & GetTextPos() const
Definition: eda_text.h:224
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:223
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
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...
bool SCH_COMPONENT::Save ( FILE *  aFile) const
overridevirtual

Function Save writes the data structures for this object out to a FILE in "*.sch" format.

Parameters
aFileThe FILE to write to.
Returns
bool - true if success writing else false.

Implements SCH_ITEM.

Definition at line 1225 of file sch_component.cpp.

References FROM_UTF8(), GetField(), GetLibId(), GetText(), m_convert, m_Fields, m_PathsAndReferences, m_Pos, m_prefix, EDA_ITEM::m_TimeStamp, m_transform, m_unit, MANDATORY_FIELDS, NULL_STRING, REFERENCE, SCH_FIELD::Save(), SCH_FIELD::SetId(), TO_UTF8, toUTFTildaText(), wxPoint::x, TRANSFORM::x1, TRANSFORM::x2, wxPoint::y, TRANSFORM::y1, and TRANSFORM::y2.

1226 {
1227  std::string name1;
1228  std::string name2;
1229  wxArrayString reference_fields;
1230 
1231  static wxString delimiters( wxT( " " ) );
1232 
1233  // this is redundant with the AR entries below, but it makes the
1234  // files backwards-compatible.
1235  if( m_PathsAndReferences.GetCount() > 0 )
1236  {
1237  reference_fields = wxStringTokenize( m_PathsAndReferences[0], delimiters );
1238 
1239  name1 = toUTFTildaText( reference_fields[1] );
1240  }
1241  else
1242  {
1243  if( GetField( REFERENCE )->GetText().IsEmpty() )
1244  name1 = toUTFTildaText( m_prefix );
1245  else
1246  name1 = toUTFTildaText( GetField( REFERENCE )->GetText() );
1247  }
1248 
1249  wxString part_name = FROM_UTF8( GetLibId().GetLibItemName() );
1250 
1251  if( part_name.size() )
1252  {
1253  name2 = toUTFTildaText( part_name );
1254  }
1255  else
1256  {
1257  name2 = NULL_STRING;
1258  }
1259 
1260  if( fprintf( f, "$Comp\n" ) == EOF )
1261  return false;
1262 
1263  if( fprintf( f, "L %s %s\n", name2.c_str(), name1.c_str() ) == EOF )
1264  return false;
1265 
1266  // Generate unit number, convert and time stamp
1267  if( fprintf( f, "U %d %d %8.8lX\n", m_unit, m_convert, (unsigned long)m_TimeStamp ) == EOF )
1268  return false;
1269 
1270  // Save the position
1271  if( fprintf( f, "P %d %d\n", m_Pos.x, m_Pos.y ) == EOF )
1272  return false;
1273 
1274  /* If this is a complex hierarchy; save hierarchical references.
1275  * but for simple hierarchies it is not necessary.
1276  * the reference inf is already saved
1277  * this is useful for old Eeschema version compatibility
1278  */
1279  if( m_PathsAndReferences.GetCount() > 1 )
1280  {
1281  for( unsigned int ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
1282  {
1283  /*format:
1284  * AR Path="/140/2" Ref="C99" Part="1"
1285  * where 140 is the uid of the containing sheet
1286  * and 2 is the timestamp of this component.
1287  * (timestamps are actually 8 hex chars)
1288  * Ref is the conventional component reference for this 'path'
1289  * Part is the conventional component part selection for this 'path'
1290  */
1291  reference_fields = wxStringTokenize( m_PathsAndReferences[ii], delimiters );
1292 
1293  if( fprintf( f, "AR Path=\"%s\" Ref=\"%s\" Part=\"%s\" \n",
1294  TO_UTF8( reference_fields[0] ),
1295  TO_UTF8( reference_fields[1] ),
1296  TO_UTF8( reference_fields[2] ) ) == EOF )
1297  return false;
1298  }
1299  }
1300 
1301  // update the ugly field index, which I would like to see go away someday soon.
1302  for( unsigned i = 0; i<m_Fields.size(); ++i )
1303  {
1304  SCH_FIELD* fld = GetField( i );
1305  fld->SetId( i ); // we don't need field Ids, please be gone.
1306  }
1307 
1308  // Fixed fields:
1309  // Save mandatory fields even if they are blank,
1310  // because the visibility, size and orientation are set from libary editor.
1311  for( unsigned i = 0; i<MANDATORY_FIELDS; ++i )
1312  {
1313  SCH_FIELD* fld = GetField( i );
1314  if( !fld->Save( f ) )
1315  return false;
1316  }
1317 
1318  // User defined fields:
1319  // The *policy* about which user defined fields are part of a symbol is now
1320  // only in the dialog editors. No policy should be enforced here, simply
1321  // save all the user defined fields, they are present because a dialog editor
1322  // thought they should be. If you disagree, go fix the dialog editors.
1323  for( unsigned i = MANDATORY_FIELDS; i<m_Fields.size(); ++i )
1324  {
1325  SCH_FIELD* fld = GetField( i );
1326 
1327  if( !fld->Save( f ) )
1328  return false;
1329  }
1330 
1331  // Unit number, position, box ( old standard )
1332  if( fprintf( f, "\t%-4d %-4d %-4d\n", m_unit, m_Pos.x, m_Pos.y ) == EOF )
1333  return false;
1334 
1335  if( fprintf( f, "\t%-4d %-4d %-4d %-4d\n",
1337  return false;
1338 
1339  if( fprintf( f, "$EndComp\n" ) == EOF )
1340  return false;
1341 
1342  return true;
1343 }
Class SCH_FIELD instances are attached to a component and provide a place for the component's value...
Definition: sch_field.h:56
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
int y2
Definition: transform.h:51
time_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:169
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:91
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:77
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
int x2
Definition: transform.h:50
bool Save(FILE *aFile) const override
Function Save writes the data structures for this object out to a FILE in "*.sch" format...
Definition: sch_field.cpp:314
int x1
Definition: transform.h:48
Field Reference of part, i.e. "IC21".
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
int y1
Definition: transform.h:49
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
std::string toUTFTildaText(const wxString &txt)
Function toUTFTildaText convert a wxString to UTF8 and replace any control characters with a ~...
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:82
#define NULL_STRING
const LIB_ID & GetLibId() const
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
void SetId(int aId)
Definition: sch_field.h:89
wxString m_prefix
C, R, U, Q etc - the first character which typically indicates what the component is...
Definition: sch_component.h:86
TRANSFORM m_transform
The rotation/mirror transformation matrix.
Definition: sch_component.h:90
void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 212 of file base_struct.h.

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

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

Definition at line 229 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by SELECTION_TOOL::disambiguationMenu().

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

Definition at line 465 of file sch_component.cpp.

References m_convert, and EDA_ITEM::SetModified().

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

466 {
467  if( m_convert != aConvert )
468  {
469  m_convert = aConvert;
470  SetModified();
471  }
472 }
void SetModified()
int m_convert
The alternate body style for components that have more than one body style defined.
Definition: sch_component.h:83
void SCH_COMPONENT::SetCurrentSheetPath ( const SCH_SHEET_PATH aSheetPath)
inline

Definition at line 465 of file sch_component.h.

Referenced by SCH_EDIT_FRAME::Load_Component().

466  {
467  m_currentSheetPath = aSheetPath;
468  }
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 361 of file sch_component.h.

Referenced by DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::EditSpiceModel(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick().

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

Definition at line 253 of file base_struct.h.

Referenced by SCH_SCREEN::addConnectedItemsToBlock(), 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(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_PART::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(), PCB_EDIT_FRAME::EditDimension(), LIB_PIN::EnableEditMode(), PCB_EDIT_FRAME::FlipTextePcb(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), 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_LINE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_EDIT_FRAME::Load_Component(), PCB_BASE_FRAME::LoadModuleFromLibrary(), SCH_SCREEN::MarkConnections(), MarkItemsInBloc(), moveBitmap(), SCH_EDIT_FRAME::MoveImage(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::OnEditPin(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnSelectUnit(), PCB_EDIT_FRAME::Other_Layer_Route(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PrepareMoveItem(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), 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(), SCH_SCREEN::SchematicCleanUp(), SCH_SCREEN::SelectBlockItems(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), LIB_PIN::SetNumber(), 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_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

253 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
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 265 of file base_struct.h.

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

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

Definition at line 228 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

228 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:136
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 171 of file sch_item_struct.h.

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

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

Definition at line 264 of file sch_component.cpp.

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

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), SCH_EDIT_FRAME::Load_Component(), and DIALOG_SYMBOL_REMAP::remapSymbolToLibTable().

265 {
266  if( m_lib_id != aLibId )
267  {
268  m_lib_id = aLibId;
269  SetModified();
270 
271  if( aLibs )
272  Resolve( aLibs );
273  else
274  m_part.reset();
275  }
276 }
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's libraries to the LIB_PART for this component
Definition: sch_component.h:93
void SCH_COMPONENT::SetLibId ( const LIB_ID aLibId,
SYMBOL_LIB_TABLE aSymLibTable 
)

Definition at line 279 of file sch_component.cpp.

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ALIAS::GetPart(), SYMBOL_LIB_TABLE::LoadSymbol(), m_lib_id, m_part, EDA_ITEM::SetModified(), and LIB_PART::SharedPtr().

280 {
281  if( m_lib_id != aLibId )
282  {
283  wxCHECK_RET( aSymLibTable, "No symbol library table provided." );
284 
285  m_lib_id = aLibId;
286  SetModified();
287 
288  LIB_ALIAS* alias = aSymLibTable->LoadSymbol( m_lib_id.GetLibNickname(),
290 
291  if( alias && alias->GetPart() )
292  m_part = alias->GetPart()->SharedPtr();
293  else
294  m_part.reset();
295  }
296 }
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.
PART_REF m_part
points into the PROJECT's libraries to the LIB_PART for this component
Definition: sch_component.h:93
const UTF8 & GetLibItemName() const
Function GetLibItemName.
Definition: lib_id.h:129
PART_SPTR SharedPtr()
LIB_PART * GetPart() const
Function GetPart gets the shared LIB_PART.
const UTF8 & GetLibNickname() const
Function GetLibNickname.
Definition: lib_id.h:108
void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 214 of file base_struct.h.

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

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

Definition at line 102 of file base_struct.cpp.

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

Referenced by ClearAnnotation(), 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::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().

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

Definition at line 211 of file base_struct.h.

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

211 { Pnext = aNext; }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:164
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 1021 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 DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), GetOrientation(), MirrorX(), MirrorY(), Rotate(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp().

1022 {
1023  TRANSFORM temp = TRANSFORM();
1024  bool transform = false;
1025 
1026  switch( aOrientation )
1027  {
1028  case CMP_ORIENT_0:
1029  case CMP_NORMAL: // default transform matrix
1030  m_transform.x1 = 1;
1031  m_transform.y2 = -1;
1032  m_transform.x2 = m_transform.y1 = 0;
1033  break;
1034 
1035  case CMP_ROTATE_COUNTERCLOCKWISE: // Rotate + (incremental rotation)
1036  temp.x1 = temp.y2 = 0;
1037  temp.y1 = 1;
1038  temp.x2 = -1;
1039  transform = true;
1040  break;
1041 
1042  case CMP_ROTATE_CLOCKWISE: // Rotate - (incremental rotation)
1043  temp.x1 = temp.y2 = 0;
1044  temp.y1 = -1;
1045  temp.x2 = 1;
1046  transform = true;
1047  break;
1048 
1049  case CMP_MIRROR_Y: // Mirror Y (incremental rotation)
1050  temp.x1 = -1;
1051  temp.y2 = 1;
1052  temp.y1 = temp.x2 = 0;
1053  transform = true;
1054  break;
1055 
1056  case CMP_MIRROR_X: // Mirror X (incremental rotation)
1057  temp.x1 = 1;
1058  temp.y2 = -1;
1059  temp.y1 = temp.x2 = 0;
1060  transform = true;
1061  break;
1062 
1063  case CMP_ORIENT_90:
1066  break;
1067 
1068  case CMP_ORIENT_180:
1072  break;
1073 
1074  case CMP_ORIENT_270:
1077  break;
1078 
1079  case ( CMP_ORIENT_0 + CMP_MIRROR_X ):
1082  break;
1083 
1084  case ( CMP_ORIENT_0 + CMP_MIRROR_Y ):
1087  break;
1088 
1089  case ( CMP_ORIENT_90 + CMP_MIRROR_X ):
1092  break;
1093 
1094  case ( CMP_ORIENT_90 + CMP_MIRROR_Y ):
1097  break;
1098 
1099  case ( CMP_ORIENT_180 + CMP_MIRROR_X ):
1102  break;
1103 
1104  case ( CMP_ORIENT_180 + CMP_MIRROR_Y ):
1107  break;
1108 
1109  case ( CMP_ORIENT_270 + CMP_MIRROR_X ):
1112  break;
1113 
1114  case ( CMP_ORIENT_270 + CMP_MIRROR_Y ):
1117  break;
1118 
1119  default:
1120  transform = false;
1121  wxMessageBox( wxT( "SetRotateMiroir() error: ill value" ) );
1122  break;
1123  }
1124 
1125  if( transform )
1126  {
1127  /* The new matrix transform is the old matrix transform modified by the
1128  * requested transformation, which is the temp transform (rot,
1129  * mirror ..) in order to have (in term of matrix transform):
1130  * transform coord = new_m_transform * coord
1131  * where transform coord is the coord modified by new_m_transform from
1132  * the initial value coord.
1133  * new_m_transform is computed (from old_m_transform and temp) to
1134  * have:
1135  * transform coord = old_m_transform * temp
1136  */
1137  TRANSFORM newTransform;
1138 
1139  newTransform.x1 = m_transform.x1 * temp.x1 + m_transform.x2 * temp.y1;
1140  newTransform.y1 = m_transform.y1 * temp.x1 + m_transform.y2 * temp.y1;
1141  newTransform.x2 = m_transform.x1 * temp.x2 + m_transform.x2 * temp.y2;
1142  newTransform.y2 = m_transform.y1 * temp.x2 + m_transform.y2 * temp.y2;
1143  m_transform = newTransform;
1144  }
1145 }
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:90
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlineinherited

Definition at line 213 of file base_struct.h.

Referenced by MODULE::Add(), BOARD::Add(), BOARD_NETLIST_UPDATER::addNewComponent(), LIB_FIELD::Copy(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), SCH_EDIT_FRAME::CreateSheet(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), LIB_PART::LIB_PART(), SCH_SHEET::Load(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), DIALOG_MODULE_BOARD_EDITOR::OnEditReference(), DIALOG_MODULE_BOARD_EDITOR::OnEditValue(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), MODULE::operator=(), operator=(), PCB_PARSER::parseMODULE_unchecked(), MODULE_EDITOR_TOOLS::PasteItems(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), BOARD_NETLIST_UPDATER::replaceComponent(), BOARD::ReplaceNetlist(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), SCH_COMPONENT(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), SetSchItemParent(), PCB_EDIT_FRAME::StartMoveModule(), BOARD_ITEM::SwapData(), SCH_SHEET::SwapData(), and SwapData().

213 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:168
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 608 of file sch_component.h.

References Move().

608 { Move( aPosition - m_Pos ); }
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
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 227 of file sch_component.h.

227 { 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:86
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 660 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 SCH_REFERENCE::Annotate(), GetRef(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

661 {
662  wxString path = GetPath( sheet );
663 
664  bool notInArray = true;
665 
666  wxString h_path, h_ref;
667  wxStringTokenizer tokenizer;
668  wxString separators( wxT( " " ) );
669 
670  // check to see if it is already there before inserting it
671  for( unsigned ii = 0; ii < m_PathsAndReferences.GetCount(); ii++ )
672  {
673  tokenizer.SetString( m_PathsAndReferences[ii], separators );
674  h_path = tokenizer.GetNextToken();
675 
676  if( h_path.Cmp( path ) == 0 )
677  {
678  // just update the reference text, not the timestamp.
679  h_ref = h_path + wxT( " " ) + ref;
680  h_ref += wxT( " " );
681  tokenizer.GetNextToken(); // Skip old reference
682  h_ref += tokenizer.GetNextToken(); // Add part selection
683 
684  // Add the part selection
685  m_PathsAndReferences[ii] = h_ref;
686  notInArray = false;
687  }
688  }
689 
690  if( notInArray )
691  AddHierarchicalReference( path, ref, m_unit );
692 
693  SCH_FIELD* rf = GetField( REFERENCE );
694 
695  if( rf->GetText().IsEmpty()
696  || ( abs( rf->GetTextPos().x - m_Pos.x ) +
697  abs( rf->GetTextPos().y - m_Pos.y ) > 10000 ) )
698  {
699  // move it to a reasonable position
700  rf->SetTextPos( m_Pos + wxPoint( 50, 50 ) );
701  }
702 
703  rf->SetText( ref ); // for drawing.
704 
705  // Reinit the m_prefix member if needed
706  wxString prefix = ref;
707 
708  if( IsReferenceStringValid( prefix ) )
709  {
710  while( prefix.Last() == '?' || isdigit( prefix.Last() ) )
711  prefix.RemoveLast();
712  }
713  else
714  {
715  prefix = wxT( "U" ); // Set to default ref prefix
716  }
717 
718  if( m_prefix != prefix )
719  m_prefix = prefix;
720 }
Class SCH_FIELD instances are attached to a component and provide a place for the component's value...
Definition: sch_field.h:56
wxString GetPath(const SCH_SHEET_PATH *sheet) const
const wxPoint & GetTextPos() const
Definition: eda_text.h:224
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:77
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:223
#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:130
int m_unit
The unit for multiple part per package components.
Definition: sch_component.h:82
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:86
virtual void SetText(const wxString &aText)
Definition: eda_text.h:141
void EDA_ITEM::SetSelected ( )
inlineinherited

Definition at line 227 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().