KiCad PCB EDA Suite
LIB_PART Class Reference

Define a library symbol object. More...

#include <class_libentry.h>

Inheritance diagram for LIB_PART:
EDA_ITEM KIGFX::VIEW_ITEM

Public Member Functions

 LIB_PART (const wxString &aName, PART_LIB *aLibrary=NULL)
 
 LIB_PART (LIB_PART &aPart, PART_LIB *aLibrary=NULL)
 
virtual ~LIB_PART ()
 
PART_SPTR SharedPtr ()
 
virtual wxString GetClass () const override
 Function GetClass returns the class name. More...
 
virtual void SetName (const wxString &aName)
 
const wxString & GetName () const
 
const LIB_IDGetLibId () const
 
void SetLibId (const LIB_ID &aLibId)
 
const wxString GetLibraryName ()
 
PART_LIBGetLib ()
 
void SetLib (PART_LIB *aLibrary)
 
wxArrayString GetAliasNames (bool aIncludeRoot=true) const
 
LIB_ALIASES GetAliases () const
 
size_t GetAliasCount () const
 
LIB_ALIASGetAlias (size_t aIndex)
 
LIB_ALIASGetAlias (const wxString &aName)
 
timestamp_t GetDateLastEdition () const
 
void AddAlias (const wxString &aName)
 Add an alias aName to the part. More...
 
void AddAlias (LIB_ALIAS *aAlias)
 
bool HasAlias (const wxString &aName) const
 Test if alias aName is in part alias list. More...
 
void RemoveAlias (const wxString &aName)
 
LIB_ALIASRemoveAlias (LIB_ALIAS *aAlias)
 
void RemoveAllAliases ()
 
wxArrayString & GetFootprints ()
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
const EDA_RECT GetUnitBoundingBox (int aUnit, int aConvert) const
 Get the bounding box for the symbol. More...
 
const EDA_RECT GetBodyBoundingBox (int aUnit, int aConvert) const
 Get the symbol bounding box excluding fields. More...
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
bool SaveDateAndTime (OUTPUTFORMATTER &aFormatter)
 Write the date and time of part to aFile in the format: "Ti yy/mm/jj hh:mm:ss". More...
 
bool LoadDateAndTime (char *aLine)
 
bool Save (OUTPUTFORMATTER &aFormatter)
 Write the data structures out to aFormatter in the part library "*.lib" format. More...
 
bool IsPower () const
 
bool IsNormal () const
 
void SetPower ()
 
void SetNormal ()
 
void LockUnits (bool aLockUnits)
 Set interchangeable the property for part units. More...
 
bool UnitsLocked () const
 Check whether part units are interchangeable. More...
 
void SetFields (const std::vector< LIB_FIELD > &aFieldsList)
 Overwrite all the existing fields in this symbol with fields supplied in aFieldsList. More...
 
void GetFields (LIB_FIELDS &aList)
 Return a list of fields within this part. More...
 
LIB_FIELDFindField (const wxString &aFieldName)
 Findd a field within this part matching aFieldName and returns it or NULL if not found. More...
 
LIB_FIELDGetField (int aId)
 Return pointer to the requested field. More...
 
LIB_FIELDGetValueField ()
 Return reference to the value field. More...
 
LIB_FIELDGetReferenceField ()
 Return reference to the reference designator field. More...
 
LIB_FIELDGetFootprintField ()
 Return reference to the footprint field. More...
 
void Draw (EDA_DRAW_PANEL *aPanel, wxDC *aDc, const wxPoint &aOffset, int aMulti, int aConvert, const PART_DRAW_OPTIONS &aOpts)
 Draw part. More...
 
void Plot (PLOTTER *aPlotter, int aUnit, int aConvert, const wxPoint &aOffset, const TRANSFORM &aTransform)
 Plot lib part to plotter. More...
 
void PlotLibFields (PLOTTER *aPlotter, int aUnit, int aConvert, const wxPoint &aOffset, const TRANSFORM &aTransform)
 Plot Lib Fields only of the part to plotter. More...
 
void AddDrawItem (LIB_ITEM *aItem)
 Add a new draw aItem to the draw object list. More...
 
void RemoveDrawItem (LIB_ITEM *aItem, EDA_DRAW_PANEL *aPanel=NULL, wxDC *aDc=NULL)
 Remove draw aItem from list. More...
 
LIB_ITEMGetNextDrawItem (LIB_ITEM *aItem=NULL, KICAD_T aType=TYPE_NOT_INIT)
 Return the next draw object pointer. More...
 
LIB_PINGetNextPin (LIB_PIN *aItem=NULL)
 Return the next pin object from the draw list. More...
 
void GetPins (LIB_PINS &aList, int aUnit=0, int aConvert=0)
 Return a list of pin object pointers from the draw item list. More...
 
LIB_PINGetPin (const wxString &aNumber, int aUnit=0, int aConvert=0)
 Return pin object with the requested pin aNumber. More...
 
bool PinsConflictWith (LIB_PART &aOtherPart, bool aTestNums, bool aTestNames, bool aTestType, bool aTestOrientation, bool aTestLength)
 Return true if this part's pins do not match another part's pins. More...
 
void SetOffset (const wxPoint &aOffset)
 Move the part aOffset. More...
 
void RemoveDuplicateDrawItems ()
 Remove duplicate draw items from list. More...
 
bool HasConversion () const
 Test if part has more than one body conversion type (DeMorgan). More...
 
void ClearStatus ()
 Clears the status flag all draw objects in this part. More...
 
LIB_ITEMLocateDrawItem (int aUnit, int aConvert, KICAD_T aType, const wxPoint &aPoint)
 Locate a draw object. More...
 
LIB_ITEMLocateDrawItem (int aUnit, int aConvert, KICAD_T aType, const wxPoint &aPoint, const TRANSFORM &aTransform)
 Locate a draw object (overlaid) More...
 
LIB_ITEMS_CONTAINERGetDrawItems ()
 Return a reference to the draw item list. More...
 
void SetUnitCount (int count)
 Set the units per part count. More...
 
int GetUnitCount () const
 
bool IsMulti () const
 
void SetConversion (bool aSetConvert)
 Set or clear the alternate body style (DeMorgan) for the part. More...
 
void SetPinNameOffset (int aOffset)
 Set the offset in mils of the pin name text from the pin symbol. More...
 
int GetPinNameOffset ()
 
void SetShowPinNames (bool aShow)
 Set or clear the pin name visibility flag. More...
 
bool ShowPinNames ()
 
void SetShowPinNumbers (bool aShow)
 Set or clear the pin number visibility flag. More...
 
bool ShowPinNumbers ()
 
bool operator== (const LIB_PART *aPart) const
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (timestamp_t aNewTimeStamp)
 
timestamp_t GetTimeStamp () const
 
EDA_ITEMNext () const
 
EDA_ITEMBack () const
 
EDA_ITEMGetParent () const
 
DHEADGetList () const
 
void SetNext (EDA_ITEM *aNext)
 
void SetBack (EDA_ITEM *aBack)
 
void SetParent (EDA_ITEM *aParent)
 
void SetList (DHEAD *aList)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool IsType (const KICAD_T aScanTypes[])
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
virtual void GetMsgPanelInfo (EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList)
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
virtual bool HitTest (const wxPoint &aPosition) const
 Function HitTest tests if aPosition is contained within or on the bounding area of an item. More...
 
virtual EDA_ITEMClone () const
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
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 its member data. More...
 
virtual wxString GetSelectMenuText (EDA_UNITS_T aUnits) const
 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...
 
virtual BITMAP_DEF GetMenuImage () const
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
 Function Matches compares the item against the search criteria in aSearchData. 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 bool IsReplaceable () const
 Function IsReplaceable. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 

Static Public Member Functions

static wxString SubReference (int aUnit, bool aAddSeparator=true)
 
static int GetSubpartIdSeparator ()
 
static int * SubpartIdSeparatorPtr ()
 return a reference to m_subpartIdSeparator, only for read/save setting functions More...
 
static int GetSubpartFirstId ()
 
static int * SubpartFirstIdPtr ()
 return a reference to m_subpartFirstId, only for read/save setting functions More...
 
static void SetSubpartIdNotation (int aSep, int aFirstId)
 Set the separator char between the subpart id and the reference 0 (no separator) or '. 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

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

Private Member Functions

void deleteAllFields ()
 

Private Attributes

PART_SPTR m_me
 http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared More...
 
LIB_ID m_libId
 
int m_pinNameOffset
 The offset in mils to draw the pin name. More...
 
bool m_unitsLocked
 True if part has multiple units and changing one unit does not automatically change another unit. More...
 
bool m_showPinNames
 Determines if part pin names are visible. More...
 
bool m_showPinNumbers
 Determines if part pin numbers are visible. More...
 
timestamp_t m_dateLastEdition
 Date of the last modification. More...
 
LIBRENTRYOPTIONS m_options
 Special part features such as POWER or NORMAL.) More...
 
int m_unitCount
 Number of units (parts) per package. More...
 
LIB_ITEMS_CONTAINER m_drawings
 Drawing items of this part. More...
 
wxArrayString m_FootprintList
 List of suitable footprint names for the part (wild card names accepted). More...
 
LIB_ALIASES m_aliases
 List of alias object pointers associated with the part. More...
 
PART_LIBm_library
 Library the part belongs to if any. More...
 

Static Private Attributes

static int m_subpartIdSeparator = 0
 the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or U1.A or U1-A More...
 
static int m_subpartFirstId = 'A'
 the ascii char value to calculate the subpart symbol id from the part number: only 'A', 'a' or '1' can be used, other values have no sense. More...
 

Detailed Description

Define a library symbol object.

A library symbol object is typically saved and loaded in a part library file (.lib). Library symbols are different from schematic symbols.

Definition at line 236 of file class_libentry.h.

Constructor & Destructor Documentation

LIB_PART::LIB_PART ( const wxString &  aName,
PART_LIB aLibrary = NULL 
)

Definition at line 215 of file class_libentry.cpp.

References DATASHEET, ENTRY_NORMAL, FOOTPRINT, LIB_FIELD_T, m_dateLastEdition, m_drawings, m_options, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), REFERENCE, SetLib(), SetName(), and VALUE.

Referenced by LIB_EDIT_FRAME::TempCopyComponent().

215  :
216  EDA_ITEM( LIB_PART_T ),
217  m_me( this, null_deleter() )
218 {
219  m_dateLastEdition = 0;
220  m_unitCount = 1;
221  m_pinNameOffset = 40;
223  m_unitsLocked = false;
224  m_showPinNumbers = true;
225  m_showPinNames = true;
226 
227  // Add the MANDATORY_FIELDS in RAM only. These are assumed to be present
228  // when the field editors are invoked.
229  m_drawings[LIB_FIELD_T].reserve( 4 );
234 
235  SetLib( aLibrary );
236  SetName( aName );
237 }
timestamp_t m_dateLastEdition
Date of the last modification.
void SetLib(PART_LIB *aLibrary)
name of datasheet
bool m_showPinNumbers
Determines if part pin numbers are visible.
int m_unitCount
Number of units (parts) per package.
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
int m_pinNameOffset
The offset in mils to draw the pin name.
void push_back(T *aItem)
Definition: multivector.h:169
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType)
Definition: base_struct.cpp:64
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
virtual void SetName(const wxString &aName)
bool m_showPinNames
Determines if part pin names are visible.
#define VALUE
PART_SPTR m_me
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
LIB_PART::LIB_PART ( LIB_PART aPart,
PART_LIB aLibrary = NULL 
)

Definition at line 240 of file class_libentry.cpp.

References EDA_ITEM::Clone(), i, EDA_ITEM::IsNew(), m_aliases, m_dateLastEdition, m_drawings, m_FootprintList, m_libId, m_library, m_options, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), and EDA_ITEM::SetParent().

240  :
241  EDA_ITEM( aPart ),
242  m_me( this, null_deleter() )
243 {
244  LIB_ITEM* newItem;
245 
246  m_library = aLibrary;
248  m_unitCount = aPart.m_unitCount;
254  m_options = aPart.m_options;
255  m_libId = aPart.m_libId;
256 
257  for( LIB_ITEM& oldItem : aPart.m_drawings )
258  {
259  if( oldItem.IsNew() )
260  continue;
261 
262  newItem = (LIB_ITEM*) oldItem.Clone();
263  newItem->SetParent( this );
264  m_drawings.push_back( newItem );
265  }
266 
267  for( size_t i = 0; i < aPart.m_aliases.size(); i++ )
268  {
269  LIB_ALIAS* alias = new LIB_ALIAS( *aPart.m_aliases[i], this );
270  m_aliases.push_back( alias );
271  }
272 }
timestamp_t m_dateLastEdition
Date of the last modification.
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
bool m_showPinNumbers
Determines if part pin numbers are visible.
bool IsNew() const
Definition: base_struct.h:219
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
int m_unitCount
Number of units (parts) per package.
PART_LIB * m_library
Library the part belongs to if any.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
int m_pinNameOffset
The offset in mils to draw the pin name.
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:216
void push_back(T *aItem)
Definition: multivector.h:169
wxArrayString m_FootprintList
List of suitable footprint names for the part (wild card names accepted).
LIB_ID m_libId
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType)
Definition: base_struct.cpp:64
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
size_t i
Definition: json11.cpp:597
bool m_showPinNames
Determines if part pin names are visible.
PART_SPTR m_me
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
LIB_PART::~LIB_PART ( )
virtual

Definition at line 275 of file class_libentry.cpp.

References GetChars(), m_aliases, and traceSchLibMem.

276 {
277  wxLogTrace( traceSchLibMem,
278  wxT( "%s: destroying symbol with alias list count of %llu" ),
279  GetChars( wxString::FromAscii( __WXFUNCTION__ ) ),
280  (long long unsigned) m_aliases.size() );
281 
282  // If the part is being deleted directly rather than through the library,
283  // delete all of the aliases.
284  while( m_aliases.size() )
285  {
286  LIB_ALIAS* alias = m_aliases.back();
287  m_aliases.pop_back();
288  delete alias;
289  }
290 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
const wxChar *const traceSchLibMem
Flag to enable schematic library memory deletion debug output.
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

Member Function Documentation

void LIB_PART::AddAlias ( const wxString &  aName)

Add an alias aName to the part.

Duplicate alias names are not added to the alias list. Debug builds will raise an assertion. Release builds will fail silently.

Parameters
aName- Name of alias to add.

Definition at line 1236 of file class_libentry.cpp.

References m_aliases.

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

1237 {
1238  m_aliases.push_back( new LIB_ALIAS( aName, this ) );
1239 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
void LIB_PART::AddAlias ( LIB_ALIAS aAlias)

Definition at line 1242 of file class_libentry.cpp.

References m_aliases.

1243 {
1244  m_aliases.push_back( aAlias );
1245 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
void LIB_PART::AddDrawItem ( LIB_ITEM aItem)

Add a new draw aItem to the draw object list.

Parameters
aItem- New draw object to add to part.

Definition at line 616 of file class_libentry.cpp.

References m_drawings, and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back().

Referenced by LIB_EDIT_FRAME::CreateImagePins(), dummy(), KIGFX::dummy(), LIB_EDIT_FRAME::LoadOneSymbol(), LIB_EDIT_FRAME::pasteClipboard(), LIB_EDIT_FRAME::PlacePin(), and DIALOG_LIB_EDIT_PIN_TABLE::TransferDataFromWindow().

617 {
618  wxASSERT( aItem != NULL );
619 
620  m_drawings.push_back( aItem );
621 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
void push_back(T *aItem)
Definition: multivector.h:169
EDA_ITEM* EDA_ITEM::Back ( ) const
inlineinherited

Definition at line 210 of file base_struct.h.

References EDA_ITEM::Pback.

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

210 { return Pback; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:168
void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 236 of file base_struct.h.

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

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

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

Definition at line 257 of file base_struct.h.

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

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

Definition at line 235 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

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

Definition at line 234 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

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

234 { ClearFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:121
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
void LIB_PART::ClearStatus ( )

Clears the status flag all draw objects in this part.

Definition at line 985 of file class_libentry.cpp.

References m_drawings.

Referenced by LIB_EDIT_FRAME::CreatePin(), and LIB_EDIT_FRAME::SaveCopyInUndoList().

986 {
987  for( LIB_ITEM& item : m_drawings )
988  {
989  item.m_Flags = 0;
990  }
991 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
EDA_ITEM * EDA_ITEM::Clone ( ) const
virtualinherited

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 in D_PAD, SCH_COMPONENT, ZONE_CONTAINER, MODULE, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, TRACK, SCH_GLOBALLABEL, DRAWSEGMENT, SCH_LABEL, DIMENSION, LIB_FIELD, TEXTE_MODULE, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, SCH_LINE, SCH_BUS_BUS_ENTRY, SCH_BITMAP, LIB_ARC, SCH_BUS_WIRE_ENTRY, LIB_TEXT, EDGE_MODULE, TEXTE_PCB, LIB_POLYLINE, SCH_NO_CONNECT, LIB_RECTANGLE, SCH_JUNCTION, SCH_MARKER, LIB_BEZIER, PCB_TARGET, LIB_CIRCLE, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 123 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by PCB_EDIT_FRAME::Block_Duplicate(), LIB_EDIT_FRAME::BlockCopySelectedItems(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), CopyMarkedItems(), LIB_EDIT_FRAME::copySelectedItems(), DrawMovingBlockOutlines(), BOARD::Duplicate(), DuplicateStruct(), EDA_ITEM::HitTest(), LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), moveItemWithMouseCursor(), new_clone(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::pasteClipboard(), RedrawWhileMovingCursor(), SCH_EDIT_FRAME::RepeatDrawItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveWireImage(), SetConversion(), SCH_EDIT_FRAME::SetRepeatItem(), SCH_EDIT_FRAME::SetUndoItem(), SetUnitCount(), and COMMIT::Stage().

124 {
125  wxCHECK_MSG( false, NULL, wxT( "Clone not implemented in derived class " ) + GetClass() +
126  wxT( ". Bad programmer!" ) );
127 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void LIB_PART::deleteAllFields ( )
private

Definition at line 820 of file class_libentry.cpp.

References LIB_FIELD_T, and m_drawings.

Referenced by SetFields().

821 {
822  m_drawings[ LIB_FIELD_T ].clear();
823 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
void LIB_PART::Draw ( EDA_DRAW_PANEL aPanel,
wxDC *  aDc,
const wxPoint aOffset,
int  aMulti,
int  aConvert,
const PART_DRAW_OPTIONS aOpts 
)

Draw part.

Parameters
aPanel- Window to draw on. Can be NULL if not available.
aDc- Device context to draw on.
aOffset- Position of part.
aMulti- unit if multiple units per part.
aConvert- Component conversion (DeMorgan) if available.
aOpts- Drawing options

Definition at line 359 of file class_libentry.cpp.

References PART_DRAW_OPTIONS::color, PART_DRAW_OPTIONS::draw_hidden_fields, PART_DRAW_OPTIONS::draw_mode, PART_DRAW_OPTIONS::draw_visible_fields, FILLED_WITH_BG_BODYCOLOR, EDA_DRAW_PANEL::GetClipBox(), GetGRForceBlackPenState(), EDA_DRAW_PANEL::GetScreen(), GetUnitBoundingBox(), GRLine(), GRRect(), GRSetDrawMode(), IS_MOVED, IsPower(), LIB_PIN::IsPowerConnection(), LIB_FIELD::IsVisible(), LIB_FIELD_T, LIB_PIN_T, LIGHTMAGENTA, m_drawings, BASE_SCREEN::m_IsPrinting, EDA_RECT::Move(), PART_DRAW_OPTIONS::only_selected, PIN_DANGLING_HIDDEN, PIN_DRAW_DANGLING, PIN_DRAW_ELECTRICAL_TYPE_NAME, PIN_DRAW_TEXTS, PART_DRAW_OPTIONS::PinIsDangling(), EDA_RECT::RevertYAxis(), PART_DRAW_OPTIONS::show_elec_type, PART_DRAW_OPTIONS::show_pin_text, PART_DRAW_OPTIONS::transform, TRANSFORM::TransformCoordinate(), wxPoint::x, and wxPoint::y.

Referenced by SCH_COMPONENT::Draw(), LIB_EDIT_FRAME::PrintPage(), and LIB_EDIT_FRAME::RedrawComponent().

361 {
362  BASE_SCREEN* screen = aPanel ? aPanel->GetScreen() : NULL;
363  GRSetDrawMode( aDc, aOpts.draw_mode );
364 
365  /* draw background for filled items using background option
366  * Solid lines will be drawn after the background
367  * Note also, background is not drawn when:
368  * printing in black and white
369  * If the color is not the default color (aColor != -1 )
370  */
371  if( ! ( screen && screen->m_IsPrinting && GetGRForceBlackPenState() )
372  && ( aOpts.color == COLOR4D::UNSPECIFIED ) )
373  {
374  for( LIB_ITEM& drawItem : m_drawings )
375  {
376  if( drawItem.m_Fill != FILLED_WITH_BG_BODYCOLOR )
377  continue;
378 
379  if( aOpts.only_selected && !drawItem.IsSelected() )
380  continue;
381 
382  // Do not draw an item while moving (the cursor handler does that)
383  if( drawItem.m_Flags & IS_MOVED )
384  continue;
385 
386  // Do not draw items not attached to the current part
387  if( aMulti && drawItem.m_Unit && ( drawItem.m_Unit != aMulti ) )
388  continue;
389 
390  if( aConvert && drawItem.m_Convert && ( drawItem.m_Convert != aConvert ) )
391  continue;
392 
393  if( drawItem.Type() == LIB_FIELD_T )
394  continue;
395 
396  if( drawItem.Type() == LIB_FIELD_T ) // TODO dead code?
397  {
398  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
399  aOpts.draw_mode, (void*) NULL, aOpts.transform );
400  }
401 
402  // Now, draw only the background for items with
403  // m_Fill == FILLED_WITH_BG_BODYCOLOR:
404  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
405  aOpts.draw_mode, (void*) false, aOpts.transform );
406  }
407  }
408 
409  // Track the index into the dangling pins list
410  size_t pin_index = 0;
411 
412  for( LIB_ITEM& drawItem : m_drawings )
413  {
414  if( aOpts.only_selected && !drawItem.IsSelected() )
415  continue;
416 
417  // Do not draw an item while moving (the cursor handler does that)
418  if( drawItem.m_Flags & IS_MOVED )
419  continue;
420 
421  // Do not draw items not attached to the current part
422  if( aMulti && drawItem.m_Unit && ( drawItem.m_Unit != aMulti ) )
423  continue;
424 
425  if( aConvert && drawItem.m_Convert && ( drawItem.m_Convert != aConvert ) )
426  continue;
427 
428  if( drawItem.Type() == LIB_FIELD_T )
429  {
430  LIB_FIELD& field = static_cast<LIB_FIELD&>( drawItem );
431 
432  if( field.IsVisible() && !aOpts.draw_visible_fields )
433  continue;
434 
435  if( !field.IsVisible() && !aOpts.draw_hidden_fields )
436  continue;
437  }
438 
439  if( drawItem.Type() == LIB_PIN_T )
440  {
441  LIB_PIN& pin = static_cast<LIB_PIN&>( drawItem );
442 
443  uintptr_t flags = 0;
444  if( aOpts.show_pin_text )
445  flags |= PIN_DRAW_TEXTS;
446 
447  if( aOpts.show_elec_type )
449 
450  if( aOpts.PinIsDangling( pin_index ) )
451  flags |= PIN_DRAW_DANGLING;
452 
453  if( pin.IsPowerConnection() && IsPower() )
454  flags |= PIN_DANGLING_HIDDEN;
455 
456  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
457  aOpts.draw_mode, (void*) flags, aOpts.transform );
458 
459  ++pin_index;
460  }
461  else if( drawItem.Type() == LIB_FIELD_T )
462  {
463  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
464  aOpts.draw_mode, (void*) NULL, aOpts.transform );
465  }
466  else
467  {
468  bool forceNoFill = drawItem.m_Fill == FILLED_WITH_BG_BODYCOLOR;
469  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
470  aOpts.draw_mode, (void*) forceNoFill,
471  aOpts.transform );
472  }
473  }
474 
475  // Enable this to draw the anchor of the component.
476 #if 0
477  int len = aDc->DeviceToLogicalXRel( 3 );
478  EDA_RECT* const clipbox = aPanel ? aPanel->GetClipBox() : NULL;
479 
480  GRLine( clipbox, aDc, aOffset.x, aOffset.y - len, aOffset.x,
481  aOffset.y + len, 0, aOpts.color );
482  GRLine( clipbox, aDc, aOffset.x - len, aOffset.y, aOffset.x + len,
483  aOffset.y, 0, aOpts.color );
484 #endif
485 
486  /* Enable this to draw the bounding box around the component to validate
487  * the bounding box calculations. */
488 #if 0
489  EDA_RECT bBox = GetUnitBoundingBox( aMulti, aConvert );
490  bBox.RevertYAxis();
491  bBox = aOpts.transform.TransformCoordinate( bBox );
492  bBox.Move( aOffset );
493  GRRect( aPanel ? aPanel->GetClipBox() : NULL, aDc, bBox, 0, LIGHTMAGENTA );
494 #endif
495 }
virtual BASE_SCREEN * GetScreen()=0
const EDA_RECT GetUnitBoundingBox(int aUnit, int aConvert) const
Get the bounding box for the symbol.
bool PinIsDangling(size_t aPin) const
void Move(const wxPoint &aMoveVector)
Function Move moves the rectangle by the aMoveVector.
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:223
bool IsPower() const
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
virtual EDA_RECT * GetClipBox()
void RevertYAxis()
Function RevertYAxis Mirror the rectangle from the X axis (negate Y pos and size) ...
Definition: eda_rect.h:144
bool draw_hidden_fields
Whether to draw "hidden" fields.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:1003
Class BASE_SCREEN handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:76
void GRLine(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color, wxPenStyle aStyle)
Definition: gr_basic.cpp:285
bool m_IsPrinting
Definition: base_screen.h:220
GR_DRAWMODE draw_mode
Device context drawing mode, see wxDC.
COLOR4D color
Color to draw part in.
bool IsVisible() const
Definition: lib_field.h:166
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool show_pin_text
Whether to show pin texts.
bool only_selected
Draws only the body items that are selected, for block moves.
bool show_elec_type
Whether to show the pin electrical type.
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:368
bool draw_visible_fields
Whether to draw "visible" fields.
bool GetGRForceBlackPenState(void)
Function GetGRForceBlackPenState.
Definition: gr_basic.cpp:214
TRANSFORM transform
Coordinate adjustment settings.
#define IS_MOVED
Item being moved.
Definition: base_struct.h:113
LIB_FIELD * LIB_PART::FindField ( const wxString &  aFieldName)

Findd a field within this part matching aFieldName and returns it or NULL if not found.

Definition at line 884 of file class_libentry.cpp.

References LIB_FIELD::GetName(), LIB_FIELD_T, and m_drawings.

885 {
886  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
887  {
888  LIB_FIELD* field = ( LIB_FIELD* ) &item;
889 
890  if( field->GetName() == aFieldName )
891  return field;
892  }
893 
894  return NULL;
895 }
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
wxString GetName(bool aTranslate=true) const
Returns the field name.
Definition: lib_field.cpp:440
LIB_ALIAS * LIB_PART::GetAlias ( size_t  aIndex)

Definition at line 1227 of file class_libentry.cpp.

References m_aliases.

Referenced by LIB_MANAGER::LIB_BUFFER::addAliases(), LIB_EDIT_FRAME::DisplayCmpDoc(), LIB_EDIT_FRAME::fixDuplicateAliases(), LIB_MANAGER::GetAlias(), NETLIST_EXPORTER_GENERIC::makeLibParts(), LIB_EDIT_FRAME::OnViewEntryDoc(), RemoveAlias(), LIB_MANAGER::LIB_BUFFER::removeAliases(), FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataToWindow().

1228 {
1229  wxCHECK2_MSG( aIndex < m_aliases.size(), return NULL,
1230  wxT( "Illegal alias list index, bad programmer." ) );
1231 
1232  return m_aliases[aIndex];
1233 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
LIB_ALIAS * LIB_PART::GetAlias ( const wxString &  aName)

Definition at line 1212 of file class_libentry.cpp.

References GetName(), i, and m_aliases.

1213 {
1214  wxCHECK2_MSG( !aName.IsEmpty(), return NULL,
1215  wxT( "Cannot get alias with an empty name. Bad programmer!" ) );
1216 
1217  for( size_t i = 0; i < m_aliases.size(); i++ )
1218  {
1219  if( aName == m_aliases[i]->GetName() )
1220  return m_aliases[i];
1221  }
1222 
1223  return NULL;
1224 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
size_t i
Definition: json11.cpp:597
const wxString & GetName() const
LIB_ALIASES LIB_PART::GetAliases ( ) const
inline

Definition at line 300 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::OnViewEntryDoc(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataToWindow().

300 { return m_aliases; }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
wxArrayString LIB_PART::GetAliasNames ( bool  aIncludeRoot = true) const

Definition at line 1124 of file class_libentry.cpp.

References m_aliases.

Referenced by SCH_LEGACY_PLUGIN_CACHE::AddSymbol(), SCH_LEGACY_PLUGIN_CACHE::DeleteSymbol(), NETLIST_EXPORTER_GENERIC::makeLibParts(), and SCH_LEGACY_PLUGIN_CACHE::saveSymbol().

1125 {
1126  wxArrayString names;
1127 
1128  LIB_ALIASES::const_iterator it;
1129 
1130  for( it=m_aliases.begin(); it != m_aliases.end(); ++it )
1131  {
1132  if( !aIncludeRoot && (*it)->IsRoot() )
1133  continue;
1134 
1135  names.Add( (*it)->GetName() );
1136  }
1137 
1138  return names;
1139 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
const EDA_RECT LIB_PART::GetBodyBoundingBox ( int  aUnit,
int  aConvert 
) const

Get the symbol bounding box excluding fields.

Returns
the part bounding box ( in user coordinates ) without fields
Parameters
aUnit= unit selection = 0, or 1..n
aConvert= 0, 1 or 2 If aUnit == 0, unit is not used if aConvert == 0 Convert is non used Fields are not taken in account

Definition at line 790 of file class_libentry.cpp.

References LIB_FIELD_T, m_drawings, m_unitCount, and EDA_RECT::Merge().

Referenced by SCH_COMPONENT::GetBodyBoundingBox().

791 {
792  EDA_RECT bBox;
793  bool initialized = false;
794 
795  for( const LIB_ITEM& item : m_drawings )
796  {
797  if( ( item.m_Unit > 0 ) && ( ( m_unitCount > 1 ) && ( aUnit > 0 )
798  && ( aUnit != item.m_Unit ) ) )
799  continue;
800 
801  if( item.m_Convert > 0 && ( ( aConvert > 0 ) && ( aConvert != item.m_Convert ) ) )
802  continue;
803 
804  if( item.Type() == LIB_FIELD_T )
805  continue;
806 
807  if( initialized )
808  bBox.Merge( item.GetBoundingBox() );
809  else
810  {
811  bBox = item.GetBoundingBox();
812  initialized = true;
813  }
814  }
815 
816  return bBox;
817 }
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect...
int m_unitCount
Number of units (parts) per package.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
const EDA_RECT LIB_PART::GetBoundingBox ( ) const
inlineoverridevirtual

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 365 of file class_libentry.h.

References Save.

366  {
367  return GetUnitBoundingBox( 0, 0 );
368  }
const EDA_RECT GetUnitBoundingBox(int aUnit, int aConvert) const
Get the bounding box for the symbol.
virtual wxString LIB_PART::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 280 of file class_libentry.h.

References LIB_ALIAS::GetName(), and LIB_ALIAS::SetName().

281  {
282  return wxT( "LIB_PART" );
283  }
timestamp_t LIB_PART::GetDateLastEdition ( ) const
inline

Definition at line 308 of file class_libentry.h.

Referenced by SCH_LEGACY_PLUGIN_CACHE::saveSymbol().

308 { return m_dateLastEdition; }
timestamp_t m_dateLastEdition
Date of the last modification.
LIB_FIELD * LIB_PART::GetField ( int  aId)

Return pointer to the requested field.

Parameters
aId- Id of field to return.
Returns
The field if found, otherwise NULL.

Definition at line 870 of file class_libentry.cpp.

References LIB_FIELD::GetId(), LIB_FIELD_T, and m_drawings.

Referenced by GetFields(), GetFootprintField(), GetReferenceField(), GetValueField(), SCH_EAGLE_PLUGIN::loadInstance(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), LIB_EDIT_FRAME::RedrawComponent(), and DIALOG_CHOOSE_COMPONENT::ShowFootprintFor().

871 {
872  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
873  {
874  LIB_FIELD* field = ( LIB_FIELD* ) &item;
875 
876  if( field->GetId() == aId )
877  return field;
878  }
879 
880  return NULL;
881 }
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
int GetId() const
Definition: lib_field.h:138
void LIB_PART::GetFields ( LIB_FIELDS aList)

Return a list of fields within this part.

Parameters
aList- List to add fields to

Definition at line 841 of file class_libentry.cpp.

References GetField(), LIB_FIELD::GetId(), LIB_FIELD_T, m_drawings, and MANDATORY_FIELDS.

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_EAGLE_PLUGIN::loadInstance(), NETLIST_EXPORTER_GENERIC::makeLibParts(), SCH_LEGACY_PLUGIN_CACHE::saveSymbol(), FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataToWindow().

842 {
843  LIB_FIELD* field;
844 
845  // Grab the MANDATORY_FIELDS first, in expected order given by
846  // enum NumFieldType
847  for( int id=0; id<MANDATORY_FIELDS; ++id )
848  {
849  field = GetField( id );
850 
851  // the MANDATORY_FIELDS are exactly that in RAM.
852  wxASSERT( field );
853 
854  aList.push_back( *field );
855  }
856 
857  // Now grab all the rest of fields.
858  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
859  {
860  field = ( LIB_FIELD* ) &item;
861 
862  if( (unsigned) field->GetId() < MANDATORY_FIELDS )
863  continue; // was added above
864 
865  aList.push_back( *field );
866  }
867 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
int GetId() const
Definition: lib_field.h:138
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 258 of file base_struct.h.

References EDA_ITEM::m_Flags.

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

258 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
LIB_FIELD & LIB_PART::GetFootprintField ( )

Return reference to the footprint field.

Definition at line 914 of file class_libentry.cpp.

References FOOTPRINT, and GetField().

Referenced by LIB_ALIAS::GetSearchText().

915 {
916  LIB_FIELD* field = GetField( FOOTPRINT );
917  wxASSERT( field != NULL );
918  return *field;
919 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Field object used in symbol libraries.
Definition: lib_field.h:59
Field Name Module PCB, i.e. "16DIP300".
wxArrayString& LIB_PART::GetFootprints ( )
inline
PART_LIB* LIB_PART::GetLib ( )
inline

Definition at line 294 of file class_libentry.h.

Referenced by LIB_MANAGER::LIB_BUFFER::CreateBuffer(), PART_LIB::FindAlias(), and LIB_ALIAS::GetLib().

294 { return m_library; }
PART_LIB * m_library
Library the part belongs to if any.
const wxString LIB_PART::GetLibraryName ( )

Definition at line 293 of file class_libentry.cpp.

References LIB_ID::GetLibNickname(), PART_LIB::GetName(), m_libId, and m_library.

Referenced by LIB_ALIAS::GetLibNickname(), and RemoveDrawItem().

294 {
295  if( m_library )
296  return m_library->GetName();
297 
298  return m_libId.GetLibNickname();
299 }
PART_LIB * m_library
Library the part belongs to if any.
const wxString GetName() const
Return the file name without path or extension.
LIB_ID m_libId
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited
BITMAP_DEF EDA_ITEM::GetMenuImage ( ) const
virtualinherited

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 in D_PAD, ZONE_CONTAINER, SCH_COMPONENT, MODULE, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, GERBER_DRAW_ITEM, TRACK, SCH_GLOBALLABEL, DRAWSEGMENT, DIMENSION, SCH_LABEL, LIB_FIELD, TEXTE_MODULE, SCH_BUS_BUS_ENTRY, SCH_SHEET_PIN, SCH_TEXT, SCH_FIELD, SCH_LINE, LIB_ARC, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, LIB_TEXT, EDGE_MODULE, TEXTE_PCB, LIB_POLYLINE, MARKER_PCB, LIB_RECTANGLE, PCB_TARGET, LIB_CIRCLE, SCH_MARKER, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 280 of file base_struct.cpp.

References dummy_xpm, EDA_ITEM::GetClass(), i, KIGFX::operator<<(), wxPoint::x, and wxPoint::y.

Referenced by SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::doSelectionMenu(), EDA_ITEM::HitTest(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

281 {
282  return dummy_xpm;
283 }
static const BITMAP_OPAQUE dummy_xpm[1]
Definition: base_struct.cpp:56
virtual void EDA_ITEM::GetMsgPanelInfo ( EDA_UNITS_T  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList 
)
inlinevirtualinherited

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 in BOARD, D_PAD, MODULE, SCH_SHEET, SCH_COMPONENT, NETINFO_ITEM, GERBER_DRAW_ITEM, LIB_ITEM, DIMENSION, TRACK, DRAWSEGMENT, SCH_TEXT, TEXTE_MODULE, LIB_FIELD, LIB_PIN, EDGE_MODULE, MARKER_PCB, ZONE_CONTAINER, LIB_BEZIER, LIB_ARC, LIB_TEXT, SCH_MARKER, LIB_POLYLINE, TEXTE_PCB, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 297 of file base_struct.h.

Referenced by SCH_EDIT_FRAME::LocateItem(), EDA_DRAW_FRAME::SetMsgPanel(), FOOTPRINT_VIEWER_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), PCB_BASE_FRAME::UpdateMsgPanel(), and FOOTPRINT_EDIT_FRAME::UpdateMsgPanel().

298  {
299  }
const wxString & LIB_PART::GetName ( ) const

Definition at line 334 of file class_libentry.cpp.

References dummy(), and m_aliases.

Referenced by SCH_LEGACY_PLUGIN_CACHE::AddSymbol(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName(), SCH_EDIT_FRAME::CreateArchiveLibrary(), LIB_MANAGER::LIB_BUFFER::CreateBuffer(), LIB_EDIT_FRAME::DisplayCmpDoc(), GetAlias(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), HasAlias(), LIB_ALIAS::IsRoot(), LIB_EDIT_FRAME::LoadOneLibraryPartAux(), NETLIST_EXPORTER_GENERIC::makeLibParts(), LIB_EDIT_FRAME::OnEditComponentProperties(), LIB_EDIT_FRAME::OnExportPart(), LIB_EDIT_FRAME::OnPasteDuplicatePart(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), RemoveAlias(), RemoveDrawItem(), PART_LIB::ReplacePart(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_COMPONENT::SCH_COMPONENT(), LIB_EDIT_FRAME::SetCurPart(), FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf(), SCH_REFERENCE_LIST::SortByReferenceOnly(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataToWindow(), LIB_MANAGER::UpdatePart(), and LIB_MANAGER::UpdatePartAfterRename().

335 {
336  static wxString dummy;
337 
338  wxCHECK_MSG( m_aliases.size(), dummy, "no aliases defined for symbol" );
339 
340  return m_aliases[0]->GetName();
341 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
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...
LIB_ITEM * LIB_PART::GetNextDrawItem ( LIB_ITEM aItem = NULL,
KICAD_T  aType = TYPE_NOT_INIT 
)

Return the next draw object pointer.

Parameters
aItem- Pointer to the current draw item. Setting item NULL with return the first item of type in the list.
aType- type of searched item (filter). if TYPE_NOT_INIT search for all items types
Returns
- The next drawing object in the list if found, otherwise NULL.

Definition at line 624 of file class_libentry.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::empty(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), m_drawings, EDA_ITEM::Type(), and TYPE_NOT_INIT.

625 {
626  if( m_drawings.empty( aType ) )
627  return NULL;
628 
629  if( aItem == NULL )
630  return &( *( m_drawings.begin( aType ) ) );
631 
632  // Search for the last item, assume aItem is of type aType
633  wxASSERT( ( aType == TYPE_NOT_INIT ) || ( aType == aItem->Type() ) );
635 
636  while( ( it != m_drawings.end( aType ) ) && ( aItem != &( *it ) ) )
637  ++it;
638 
639  // Search the next item
640  if( it != m_drawings.end( aType ) )
641  {
642  ++it;
643 
644  if( it != m_drawings.end( aType ) )
645  return &( *it );
646  }
647 
648  return NULL;
649 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:183
bool empty(int aType=UNDEFINED_TYPE)
Definition: multivector.h:224
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:189
ITERATOR_BASE< LIB_ITEM, MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::iterator > ITERATOR
The non-const iterator
Definition: multivector.h:160
LIB_PIN* LIB_PART::GetNextPin ( LIB_PIN aItem = NULL)
inline

Return the next pin object from the draw list.

This is just a pin object specific version of GetNextDrawItem().

Parameters
aItem- Pointer to the previous pin item, or NULL to get the first pin in the draw object list.
Returns
- The next pin object in the list if found, otherwise NULL.

Definition at line 525 of file class_libentry.h.

References LIB_PIN_T.

Referenced by LIB_EDIT_FRAME::deleteItem(), NETLIST_EXPORTER::findAllUnitsOfComponent(), LIB_EDIT_FRAME::GlobalSetPins(), LIB_EDIT_FRAME::PlacePin(), LIB_PIN::SetConversion(), LIB_PIN::SetPartNumber(), LIB_EDIT_FRAME::StartMovePin(), DIALOG_LIB_EDIT_PIN_TABLE::TransferDataFromWindow(), and DIALOG_LIB_EDIT_PIN_TABLE::TransferDataToWindow().

526  {
527  return (LIB_PIN*) GetNextDrawItem( (LIB_ITEM*) aItem, LIB_PIN_T );
528  }
LIB_ITEM * GetNextDrawItem(LIB_ITEM *aItem=NULL, KICAD_T aType=TYPE_NOT_INIT)
Return the next draw object pointer.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
LIB_PIN * LIB_PART::GetPin ( const wxString &  aNumber,
int  aUnit = 0,
int  aConvert = 0 
)

Return pin object with the requested pin aNumber.

Parameters
aNumber- Number of the pin to find.
aUnit- Unit of the part to find. Set to 0 if a specific unit number is not required.
aConvert- Alternate body style filter (DeMorgan). Set to 0 if no alternate body style is required.
Returns
The pin object if found. Otherwise NULL.

Definition at line 678 of file class_libentry.cpp.

References GetPins(), i, LIB_PIN_T, and EDA_ITEM::Type().

679 {
680  LIB_PINS pinList;
681 
682  GetPins( pinList, aUnit, aConvert );
683 
684  for( size_t i = 0; i < pinList.size(); i++ )
685  {
686  wxASSERT( pinList[i]->Type() == LIB_PIN_T );
687 
688  if( aNumber == pinList[i]->GetNumber() )
689  return pinList[i];
690  }
691 
692  return NULL;
693 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_draw_item.h:61
size_t i
Definition: json11.cpp:597
int LIB_PART::GetPinNameOffset ( )
inline
void LIB_PART::GetPins ( LIB_PINS aList,
int  aUnit = 0,
int  aConvert = 0 
)

Return a list of pin object pointers from the draw item list.

Note pin objects are owned by the draw list of the part. Deleting any of the objects will leave list in a unstable state and will likely segfault when the list is destroyed.

Parameters
aList- Pin list to place pin object pointers into.
aUnit- Unit number of pin to add to list. Set to 0 to get pins from any part unit.
aConvert- Convert number of pin to add to list. Set to 0 to get pins from any convert of part.

Definition at line 652 of file class_libentry.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::empty(), LIB_PIN_T, and m_drawings.

Referenced by LIB_PIN::EnableEditMode(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), GetPin(), NETLIST_EXPORTER_GENERIC::makeLibParts(), LIB_EDIT_FRAME::OnCheckComponent(), PinsConflictWith(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), LIB_PIN::SetLength(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), LIB_PIN::SetType(), and LIB_PIN::SetVisible().

653 {
654  if( m_drawings.empty( LIB_PIN_T ) )
655  return;
656 
657  /* Notes:
658  * when aUnit == 0: no unit filtering
659  * when aConvert == 0: no convert (shape selection) filtering
660  * when .m_Unit == 0, the body item is common to units
661  * when .m_Convert == 0, the body item is common to shapes
662  */
663  for( LIB_ITEM& item : m_drawings[ LIB_PIN_T ] )
664  {
665  // Unit filtering:
666  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
667  continue;
668 
669  // Shape filtering:
670  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
671  continue;
672 
673  aList.push_back( (LIB_PIN*) &item );
674  }
675 }
bool empty(int aType=UNDEFINED_TYPE)
Definition: multivector.h:224
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
LIB_FIELD & LIB_PART::GetReferenceField ( )

Return reference to the reference designator field.

Definition at line 906 of file class_libentry.cpp.

References GetField(), and REFERENCE.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), SCH_LEGACY_PLUGIN_CACHE::saveSymbol(), and SCH_COMPONENT::SCH_COMPONENT().

907 {
908  LIB_FIELD* field = GetField( REFERENCE );
909  wxASSERT( field != NULL );
910  return *field;
911 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Field object used in symbol libraries.
Definition: lib_field.h:59
Field Reference of part, i.e. "IC21".
wxString EDA_ITEM::GetSelectMenuText ( EDA_UNITS_T  aUnits) const
virtualinherited

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 in D_PAD, ZONE_CONTAINER, SCH_COMPONENT, MODULE, SCH_SHEET, LIB_PIN, VIA, SEGZONE, DELETED_SCH_ITEM, SCH_HIERLABEL, GERBER_DRAW_ITEM, TRACK, SCH_GLOBALLABEL, DRAWSEGMENT, DIMENSION, SCH_LABEL, LIB_FIELD, TEXTE_MODULE, SCH_SHEET_PIN, SCH_BUS_BUS_ENTRY, SCH_TEXT, SCH_FIELD, SCH_LINE, LIB_ARC, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, LIB_TEXT, EDGE_MODULE, TEXTE_PCB, LIB_POLYLINE, MARKER_PCB, LIB_RECTANGLE, PCB_TARGET, LIB_CIRCLE, SCH_MARKER, SCH_NO_CONNECT, SCH_JUNCTION, and DELETED_BOARD_ITEM.

Definition at line 173 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::doSelectionMenu(), SCH_FIND_COLLECTOR::GetText(), EDA_ITEM::HitTest(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), DRC_ITEM::SetData(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

174 {
175  wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
176  GetClass() );
177 
178  return wxString( wxT( "Undefined menu text for " ) + GetClass() );
179 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 253 of file base_struct.h.

References EDA_ITEM::m_Status.

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

253 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:164
static int LIB_PART::GetSubpartFirstId ( )
inlinestatic

Definition at line 669 of file class_libentry.h.

Referenced by SCH_EDIT_FRAME::LoadProjectFile(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), and PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataToWindow().

669 { return m_subpartFirstId; }
static int m_subpartFirstId
the ascii char value to calculate the subpart symbol id from the part number: only &#39;A&#39;...
static int LIB_PART::GetSubpartIdSeparator ( )
inlinestatic

Definition at line 662 of file class_libentry.h.

Referenced by SCH_EDIT_FRAME::LoadProjectFile(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), and PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataToWindow().

662 { return m_subpartIdSeparator; }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
timestamp_t EDA_ITEM::GetTimeStamp ( ) const
inlineinherited

Definition at line 207 of file base_struct.h.

References EDA_ITEM::m_TimeStamp.

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

207 { return m_TimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:172
const EDA_RECT LIB_PART::GetUnitBoundingBox ( int  aUnit,
int  aConvert 
) const

Get the bounding box for the symbol.

Returns
the part bounding box ( in user coordinates )
Parameters
aUnit= unit selection = 0, or 1..n
aConvert= 0, 1 or 2 If aUnit == 0, unit is not used if aConvert == 0 Convert is non used Invisible fields are not taken in account

Definition at line 752 of file class_libentry.cpp.

References LIB_FIELD_T, m_drawings, m_unitCount, and EDA_RECT::Merge().

Referenced by LIB_VIEW_FRAME::BestZoom(), LIB_EDIT_FRAME::BestZoom(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), Draw(), LIB_VIEW_FRAME::GetDocumentExtents(), LIB_EDIT_FRAME::GetDocumentExtents(), and LIB_EDIT_FRAME::OnPlotCurrentComponent().

753 {
754  EDA_RECT bBox;
755  bool initialized = false;
756 
757  for( const LIB_ITEM& item : m_drawings )
758  {
759  if( ( item.m_Unit > 0 ) && ( ( m_unitCount > 1 ) && ( aUnit > 0 )
760  && ( aUnit != item.m_Unit ) ) )
761  continue;
762 
763  if( item.m_Convert > 0 && ( ( aConvert > 0 ) && ( aConvert != item.m_Convert ) ) )
764  continue;
765 
766  if ( ( item.Type() == LIB_FIELD_T ) && !( ( LIB_FIELD& ) item ).IsVisible() )
767  continue;
768 
769  if( initialized )
770  bBox.Merge( item.GetBoundingBox() );
771  else
772  {
773  bBox = item.GetBoundingBox();
774  initialized = true;
775  }
776  }
777 
778  return bBox;
779 }
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect...
int m_unitCount
Number of units (parts) per package.
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
LIB_FIELD & LIB_PART::GetValueField ( )

Return reference to the value field.

Definition at line 898 of file class_libentry.cpp.

References GetField(), and VALUE.

Referenced by SCH_LEGACY_PLUGIN_CACHE::saveSymbol(), SetName(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

899 {
900  LIB_FIELD* field = GetField( VALUE );
901  wxASSERT( field != NULL );
902  return *field;
903 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Field object used in symbol libraries.
Definition: lib_field.h:59
#define VALUE
bool LIB_PART::HasAlias ( const wxString &  aName) const

Test if alias aName is in part alias list.

Alias name comparisons are case insensitive.

Parameters
aName- Name of alias.
Returns
True if alias name in alias list.

Definition at line 1142 of file class_libentry.cpp.

References GetName(), i, and m_aliases.

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnAddAlias().

1143 {
1144  wxCHECK2_MSG( !aName.IsEmpty(), return false,
1145  wxT( "Cannot get alias with an empty name, bad programmer." ) );
1146 
1147  for( size_t i = 0; i < m_aliases.size(); i++ )
1148  {
1149  if( aName == m_aliases[i]->GetName() )
1150  return true;
1151  }
1152 
1153  return false;
1154 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
size_t i
Definition: json11.cpp:597
const wxString & GetName() const
bool LIB_PART::HasConversion ( ) const

Test if part has more than one body conversion type (DeMorgan).

Returns
True if part has more than one conversion.

Definition at line 974 of file class_libentry.cpp.

References m_drawings.

Referenced by AddMenusForEditComponent(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), LIB_VIEW_FRAME::onUpdateAltBodyStyleButton(), LIB_EDIT_FRAME::OnUpdateDeMorganConvert(), LIB_EDIT_FRAME::OnUpdateDeMorganNormal(), LIB_VIEW_FRAME::onUpdateNormalBodyStyleButton(), SetConversion(), DIALOG_LIB_EDIT_DRAW_ITEM::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::Validate().

975 {
976  for( const LIB_ITEM& item : m_drawings )
977  {
978  if( item.m_Convert > 1 )
979  return true;
980  }
981 
982  return false;
983 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
virtual bool EDA_ITEM::HitTest ( const wxPoint aPosition) const
inlinevirtualinherited

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 in D_PAD, MODULE, VIA, SCH_ITEM, BOARD_ITEM, GERBER_DRAW_ITEM, ZONE_CONTAINER, DIMENSION, LIB_ITEM, TRACK, DRAWSEGMENT, TEXTE_MODULE, LIB_FIELD, LIB_PIN, MARKER_PCB, LIB_ARC, PCB_TARGET, LIB_TEXT, TEXTE_PCB, LIB_BEZIER, LIB_POLYLINE, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 308 of file base_struct.h.

References EDA_ITEM::Clone(), EDA_ITEM::GetBoundingBox(), EDA_ITEM::GetClass(), EDA_ITEM::GetMenuImage(), EDA_ITEM::GetSelectMenuText(), EDA_ITEM::IterateForward(), and EDA_ITEM::Visit().

Referenced by LIB_ITEM::HitTest(), BOARD_ITEM::HitTest(), GERBER_COLLECTOR::Inspect(), and SCH_COLLECTOR::Inspect().

309  {
310  return false; // derived classes should override this function
311  }
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 227 of file base_struct.h.

References BRIGHTENED.

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

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

Definition at line 226 of file base_struct.h.

References HIGHLIGHTED.

226 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:137
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 220 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

220 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:110
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
bool LIB_PART::IsMulti ( ) const
inline
Returns
true if the part has multiple units per part. When true, the reference has a sub reference to identify part.

Definition at line 649 of file class_libentry.h.

Referenced by SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), LIB_EDIT_FRAME::OnUpdateSyncPinEdit(), LIB_EDIT_FRAME::SetCurPart(), and LIB_EDIT_FRAME::SynchronizePins().

649 { return m_unitCount > 1; }
int m_unitCount
Number of units (parts) per package.
bool EDA_ITEM::IsNew ( ) const
inlineinherited

Definition at line 219 of file base_struct.h.

References IS_NEW.

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

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

Definition at line 391 of file class_libentry.h.

References ENTRY_NORMAL.

Referenced by AddMenusForEditComponent().

391 { return m_options == ENTRY_NORMAL; }
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

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 in SCH_COMPONENT, SCH_SHEET, SCH_LABEL, SCH_FIELD, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 464 of file base_struct.h.

References EDA_ITEM::operator<().

Referenced by EDA_ITEM::Matches(), and EDA_ITEM::Replace().

464 { return false; }
bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 225 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

225 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:115
bool EDA_ITEM::IsSelected ( ) const
inlineinherited
bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[])
inlineinherited

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

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

Definition at line 266 of file base_struct.h.

References EOT.

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

Definition at line 223 of file base_struct.h.

References IS_WIRE_IMAGE.

Referenced by SCH_FIELD::Draw().

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

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

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

Definition at line 130 of file base_struct.cpp.

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

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

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

Definition at line 942 of file class_libentry.cpp.

References m_dateLastEdition, and min.

943 {
944  int year, mon, day, hour, min, sec;
945 
946  year = mon = day = hour = min = sec = 0;
947  strtok( aLine, " \r\t\n" );
948  strtok( NULL, " \r\t\n" );
949 
950  if( sscanf( aLine, "%d/%d/%d %d:%d:%d", &year, &mon, &day, &hour, &min, &sec ) != 6 )
951  return false;
952 
953  m_dateLastEdition = ( sec & 63 ) + ( ( min & 63 ) << 6 ) +
954  ( ( hour & 31 ) << 12 ) + ( ( day & 31 ) << 17 ) +
955  ( ( mon & 15 ) << 22 ) + ( ( year - 1990 ) << 26 );
956 
957  return true;
958 }
timestamp_t m_dateLastEdition
Date of the last modification.
#define min(a, b)
Definition: auxiliary.h:85
LIB_ITEM * LIB_PART::LocateDrawItem ( int  aUnit,
int  aConvert,
KICAD_T  aType,
const wxPoint aPoint 
)

Locate a draw object.

Parameters
aUnit- Unit number of draw item.
aConvert- Body style of draw item.
aType- Draw object type, set to 0 to search for any type.
aPoint- Coordinate for hit testing.
Returns
The draw object if found. Otherwise NULL.

Definition at line 993 of file class_libentry.cpp.

References m_drawings, and TYPE_NOT_INIT.

Referenced by LocateDrawItem().

995 {
996  for( LIB_ITEM& item : m_drawings )
997  {
998  if( ( aUnit && item.m_Unit && ( aUnit != item.m_Unit) )
999  || ( aConvert && item.m_Convert && ( aConvert != item.m_Convert ) )
1000  || ( ( item.Type() != aType ) && ( aType != TYPE_NOT_INIT ) ) )
1001  continue;
1002 
1003  if( item.HitTest( aPoint ) )
1004  return &item;
1005  }
1006 
1007  return NULL;
1008 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
LIB_ITEM * LIB_PART::LocateDrawItem ( int  aUnit,
int  aConvert,
KICAD_T  aType,
const wxPoint aPoint,
const TRANSFORM aTransform 
)

Locate a draw object (overlaid)

Parameters
aUnit- Unit number of draw item.
aConvert- Body style of draw item.
aType- Draw object type, set to 0 to search for any type.
aPoint- Coordinate for hit testing.
aTransform= the transform matrix
Returns
The draw object if found. Otherwise NULL.

Definition at line 1011 of file class_libentry.cpp.

References DefaultTransform, and LocateDrawItem().

1013 {
1014  /* we use LocateDrawItem( int aUnit, int convert, KICAD_T type, const
1015  * wxPoint& pt ) to search items.
1016  * because this function uses DefaultTransform as orient/mirror matrix
1017  * we temporary copy aTransform in DefaultTransform
1018  */
1019  LIB_ITEM* item;
1020  TRANSFORM transform = DefaultTransform;
1021  DefaultTransform = aTransform;
1022 
1023  item = LocateDrawItem( aUnit, aConvert, aType, aPoint );
1024 
1025  // Restore matrix
1026  DefaultTransform = transform;
1027 
1028  return item;
1029 }
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM DefaultTransform
Definition: eeschema.cpp:59
LIB_ITEM * LocateDrawItem(int aUnit, int aConvert, KICAD_T aType, const wxPoint &aPoint)
Locate a draw object.
void LIB_PART::LockUnits ( bool  aLockUnits)
inline

Set interchangeable the property for part units.

Parameters
aLockUnitswhen true then units are set as not interchangeable.

Definition at line 400 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

400 { m_unitsLocked = aLockUnits; }
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
virtual bool EDA_ITEM::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData,
wxPoint aFindLocation 
)
inlinevirtualinherited

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 in SCH_COMPONENT, SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, SCH_TEXT, LIB_PIN, and SCH_MARKER.

Definition at line 420 of file base_struct.h.

References EDA_ITEM::Replace().

Referenced by SCH_FIND_COLLECTOR::Inspect(), SCH_MARKER::Matches(), LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), SCH_SHEET::Matches(), and EDA_ITEM::Sort().

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

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

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

Definition at line 182 of file base_struct.cpp.

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

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

Test if another item is less than this object.

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

Definition at line 239 of file base_struct.cpp.

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

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

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

Definition at line 729 of file class_libentry.h.

729 { return this == aPart; }
bool LIB_PART::PinsConflictWith ( LIB_PART aOtherPart,
bool  aTestNums,
bool  aTestNames,
bool  aTestType,
bool  aTestOrientation,
bool  aTestLength 
)

Return true if this part's pins do not match another part's pins.

This is used to detect whether the project cache is out of sync with the system libs.

Parameters
aOtherPart- The other library part to test
aTestNums- Whether two pins at the same point must have the same number.
aTestNames- Whether two pins at the same point must have the same name.
aTestType- Whether two pins at the same point must have the same electrical type.
aTestOrientation- Whether two pins at the same point must have the same orientation.
aTestLength- Whether two pins at the same point must have the same length.

Definition at line 696 of file class_libentry.cpp.

References GetPins().

Referenced by RESCUE_CACHE_CANDIDATE::FindRescues(), and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues().

698 {
699  LIB_PINS thisPinList;
700  GetPins( thisPinList, /* aUnit */ 0, /* aConvert */ 0 );
701 
702  for( LIB_PIN* eachThisPin : thisPinList )
703  {
704  wxASSERT( eachThisPin );
705  LIB_PINS otherPinList;
706  aOtherPart.GetPins( otherPinList, /* aUnit */ 0, /* aConvert */ 0 );
707  bool foundMatch = false;
708 
709  for( LIB_PIN* eachOtherPin : otherPinList )
710  {
711  wxASSERT( eachOtherPin );
712  // Same position?
713  if( eachThisPin->GetPosition() != eachOtherPin->GetPosition() )
714  continue;
715 
716  // Same number?
717  if( aTestNums && ( eachThisPin->GetNumber() != eachOtherPin->GetNumber() ))
718  continue;
719 
720  // Same name?
721  if( aTestNames && ( eachThisPin->GetName() != eachOtherPin->GetName() ))
722  continue;
723 
724  // Same electrical type?
725  if( aTestType && ( eachThisPin->GetType() != eachOtherPin->GetType() ))
726  continue;
727 
728  // Same orientation?
729  if( aTestOrientation && ( eachThisPin->GetOrientation() != eachOtherPin->GetOrientation() ))
730  continue;
731 
732  // Same length?
733  if( aTestLength && ( eachThisPin->GetLength() != eachOtherPin->GetLength() ))
734  continue;
735 
736  foundMatch = true;
737  }
738 
739  if( !foundMatch )
740  {
741  // This means there was not an identical (according to the arguments)
742  // pin at the same position in the other component.
743  return true;
744  }
745  }
746 
747  // The loop never gave up, so no conflicts were found.
748  return false;
749 }
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_draw_item.h:61
void LIB_PART::Plot ( PLOTTER aPlotter,
int  aUnit,
int  aConvert,
const wxPoint aOffset,
const TRANSFORM aTransform 
)

Plot lib part to plotter.

Lib Fields not are plotted here, because this plot function is used to plot schematic items, which have they own fields

Parameters
aPlotter- Plotter object to plot to.
aUnit- Component part to plot.
aConvert- Component alternate body style to plot.
aOffset- Distance to shift the plot coordinates.
aTransform- Component plot transform matrix.

Definition at line 498 of file class_libentry.cpp.

References FILLED_WITH_BG_BODYCOLOR, PLOTTER::GetColorMode(), GetLayerColor(), LAYER_DEVICE, LIB_FIELD_T, m_drawings, and PLOTTER::SetColor().

Referenced by LIB_EDIT_FRAME::SVG_PlotComponent().

500 {
501  wxASSERT( aPlotter != NULL );
502 
503  aPlotter->SetColor( GetLayerColor( LAYER_DEVICE ) );
504  bool fill = aPlotter->GetColorMode();
505 
506  // draw background for filled items using background option
507  // Solid lines will be drawn after the background
508  for( LIB_ITEM& item : m_drawings )
509  {
510  // Lib Fields are not plotted here, because this plot function
511  // is used to plot schematic items, which have they own fields
512  if( item.Type() == LIB_FIELD_T )
513  continue;
514 
515  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
516  continue;
517 
518  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
519  continue;
520 
521  if( item.m_Fill == FILLED_WITH_BG_BODYCOLOR )
522  item.Plot( aPlotter, aOffset, fill, aTransform );
523  }
524 
525  // Not filled items and filled shapes are now plotted
526  // (plot only items which are not already plotted)
527  for( LIB_ITEM& item : m_drawings )
528  {
529  if( item.Type() == LIB_FIELD_T )
530  continue;
531 
532  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
533  continue;
534 
535  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
536  continue;
537 
538  if( item.m_Fill != FILLED_WITH_BG_BODYCOLOR )
539  item.Plot( aPlotter, aOffset, fill, aTransform );
540  }
541 }
virtual void SetColor(COLOR4D color)=0
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:174
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
bool GetColorMode() const
Definition: plotter.h:131
void LIB_PART::PlotLibFields ( PLOTTER aPlotter,
int  aUnit,
int  aConvert,
const wxPoint aOffset,
const TRANSFORM aTransform 
)

Plot Lib Fields only of the part to plotter.

is used to plot the full lib part, outside the schematic

Parameters
aPlotter- Plotter object to plot to.
aUnit- Component part to plot.
aConvert- Component alternate body style to plot.
aOffset- Distance to shift the plot coordinates.
aTransform- Component plot transform matrix.

Definition at line 544 of file class_libentry.cpp.

References PLOTTER::GetColorMode(), LIB_FIELD::GetFullText(), LIB_FIELD::GetId(), GetLayerColor(), EDA_TEXT::GetShownText(), LAYER_FIELDS, LIB_FIELD_T, m_drawings, REFERENCE, PLOTTER::SetColor(), and LIB_FIELD::SetText().

Referenced by LIB_EDIT_FRAME::SVG_PlotComponent().

546 {
547  wxASSERT( aPlotter != NULL );
548 
549  aPlotter->SetColor( GetLayerColor( LAYER_FIELDS ) );
550  bool fill = aPlotter->GetColorMode();
551 
552  for( LIB_ITEM& item : m_drawings )
553  {
554  if( item.Type() != LIB_FIELD_T )
555  continue;
556 
557  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
558  continue;
559 
560  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
561  continue;
562 
563  // The reference is a special case: we should change the basic text
564  // to add '?' and the part id
565  LIB_FIELD& field = (LIB_FIELD&) item;
566  wxString tmp = field.GetShownText();
567  if( field.GetId() == REFERENCE )
568  {
569  wxString text = field.GetFullText( aUnit );
570  field.SetText( text );
571  }
572  item.Plot( aPlotter, aOffset, fill, aTransform );
573  field.SetText( tmp );
574  }
575 }
virtual void SetColor(COLOR4D color)=0
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:363
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:174
Field Reference of part, i.e. "IC21".
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
virtual wxString GetShownText() const
Returns the string actually shown after processing of the base text.
Definition: eda_text.h:148
void SetText(const wxString &aText) override
Sets the field text to aText.
Definition: lib_field.cpp:510
int GetId() const
Definition: lib_field.h:138
bool GetColorMode() const
Definition: plotter.h:131
void LIB_PART::RemoveAlias ( const wxString &  aName)

Definition at line 1157 of file class_libentry.cpp.

References GetAlias().

Referenced by SCH_LEGACY_PLUGIN_CACHE::DeleteAlias(), SCH_LEGACY_PLUGIN_CACHE::removeAlias(), and LIB_ALIAS::~LIB_ALIAS().

1158 {
1159  LIB_ALIAS* a = GetAlias( aName );
1160 
1161  if( a )
1162  RemoveAlias( a );
1163 }
Part library alias object definition.
LIB_ALIAS * GetAlias(size_t aIndex)
void RemoveAlias(const wxString &aName)
LIB_ALIAS * LIB_PART::RemoveAlias ( LIB_ALIAS aAlias)

Definition at line 1166 of file class_libentry.cpp.

References GetChars(), LIB_ALIAS::GetName(), GetName(), LIB_ALIAS::IsRoot(), m_aliases, m_me, SetName(), and traceSchLibMem.

1167 {
1168  wxCHECK_MSG( aAlias, NULL, wxT( "Cannot remove alias by NULL pointer." ) );
1169 
1170  LIB_ALIAS* nextAlias = NULL;
1171 
1172  LIB_ALIASES::iterator it = find( m_aliases.begin(), m_aliases.end(), aAlias );
1173 
1174  if( it != m_aliases.end() )
1175  {
1176  bool rename = aAlias->IsRoot();
1177 
1178  wxLogTrace( traceSchLibMem,
1179  wxT( "%s: symbol:'%s', alias:'%s', alias count %llu, reference count %ld." ),
1180  GetChars( wxString::FromAscii( __WXFUNCTION__ ) ),
1181  GetChars( GetName() ),
1182  GetChars( aAlias->GetName() ),
1183  (long long unsigned) m_aliases.size(),
1184  m_me.use_count() );
1185 
1186  it = m_aliases.erase( it );
1187 
1188  if( !m_aliases.empty() )
1189  {
1190  if( it == m_aliases.end() )
1191  it = m_aliases.begin();
1192 
1193  nextAlias = *it;
1194 
1195  if( rename )
1196  SetName( nextAlias->GetName() );
1197  }
1198  }
1199 
1200  return nextAlias;
1201 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
bool IsRoot() const override
For symbols having aliases, IsRoot() indicates the principal item.
const wxChar *const traceSchLibMem
Flag to enable schematic library memory deletion debug output.
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 wxString & GetName() const override
const wxString & GetName() const
virtual void SetName(const wxString &aName)
PART_SPTR m_me
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
void LIB_PART::RemoveAllAliases ( )

Definition at line 1204 of file class_libentry.cpp.

References m_aliases.

Referenced by RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), LIB_EDIT_FRAME::SaveOneSymbol(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

1205 {
1206  // Remove all of the aliases except the root alias.
1207  while( m_aliases.size() > 1 )
1208  m_aliases.pop_back();
1209 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
void LIB_PART::RemoveDrawItem ( LIB_ITEM aItem,
EDA_DRAW_PANEL aPanel = NULL,
wxDC *  aDc = NULL 
)

Remove draw aItem from list.

Parameters
aItem- Draw item to remove from list.
aPanel- Panel to remove part from.
aDc- Device context to remove part from.

Definition at line 578 of file class_libentry.cpp.

References DefaultTransform, LIB_ITEM::Draw(), g_XorMode, GetChars(), LIB_FIELD::GetId(), GetLibraryName(), LIB_FIELD::GetName(), GetName(), i, LIB_FIELD_T, m_drawings, MANDATORY_FIELDS, EDA_ITEM::SetModified(), and EDA_ITEM::Type().

Referenced by LIB_EDIT_FRAME::deleteItem(), LIB_PIN::SetConversion(), LIB_PIN::SetPartNumber(), and DIALOG_LIB_EDIT_PIN_TABLE::TransferDataFromWindow().

579 {
580  wxASSERT( aItem != NULL );
581 
582  // none of the MANDATORY_FIELDS may be removed in RAM, but they may be
583  // omitted when saving to disk.
584  if( aItem->Type() == LIB_FIELD_T )
585  {
586  LIB_FIELD* field = (LIB_FIELD*) aItem;
587 
588  if( field->GetId() < MANDATORY_FIELDS )
589  {
590  wxLogWarning( _(
591  "An attempt was made to remove the %s field from component %s in library %s." ),
592  GetChars( field->GetName() ), GetChars( GetName() ),
593  GetChars( GetLibraryName() ) );
594  return;
595  }
596  }
597 
598  LIB_ITEMS& items = m_drawings[ aItem->Type() ];
599 
600  for( LIB_ITEMS::iterator i = items.begin(); i != items.end(); i++ )
601  {
602  if( *i == aItem )
603  {
604  if( aDc != NULL )
605  aItem->Draw( aPanel, aDc, wxPoint( 0, 0 ), COLOR4D::UNSPECIFIED,
606  g_XorMode, NULL, DefaultTransform );
607 
608  items.erase( i );
609  SetModified();
610  break;
611  }
612  }
613 }
GR_DRAWMODE g_XorMode
Definition: gr_basic.cpp:74
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
void SetModified()
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
LIB_ITEMS_CONTAINER::ITEM_PTR_VECTOR LIB_ITEMS
int GetId() const
Definition: lib_field.h:138
wxString GetName(bool aTranslate=true) const
Returns the field name.
Definition: lib_field.cpp:440
const wxString GetLibraryName()
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
TRANSFORM DefaultTransform
Definition: eeschema.cpp:59
virtual void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, COLOR4D aColor, GR_DRAWMODE aDrawMode, void *aData, const TRANSFORM &aTransform)
Draw an item.
size_t i
Definition: json11.cpp:597
const wxString & GetName() const
void LIB_PART::RemoveDuplicateDrawItems ( )

Remove duplicate draw items from list.

Definition at line 968 of file class_libentry.cpp.

References m_drawings, and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::unique().

Referenced by LIB_EDIT_FRAME::LoadOneSymbol().

969 {
970  m_drawings.unique();
971 }
void unique()
Remove duplicate elements in list.
Definition: multivector.h:238
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
wxString &  aText 
)
inherited

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

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

Definition at line 209 of file base_struct.cpp.

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

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

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

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

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

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

Reimplemented in SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 452 of file base_struct.h.

452 { return false; }
bool LIB_PART::Save ( OUTPUTFORMATTER aFormatter)

Write the data structures out to aFormatter in the part library "*.lib" format.

Parameters
aFormatterA reference to an OUTPUTFORMATTER to write to.
Returns
True if success writing else false.
bool LIB_PART::SaveDateAndTime ( OUTPUTFORMATTER aFormatter)

Write the date and time of part to aFile in the format: "Ti yy/mm/jj hh:mm:ss".

Parameters
aFormatterA reference to an OUTPUTFORMATTER object containing the output format to write to.
Returns
True if the date and time were successfully written to aFormatter.

Definition at line 922 of file class_libentry.cpp.

References m_dateLastEdition, min, and OUTPUTFORMATTER::Print().

923 {
924  int year, mon, day, hour, min, sec;
925 
926  if( m_dateLastEdition == 0 )
927  return true;
928 
929  sec = m_dateLastEdition & 63;
930  min = ( m_dateLastEdition >> 6 ) & 63;
931  hour = ( m_dateLastEdition >> 12 ) & 31;
932  day = ( m_dateLastEdition >> 17 ) & 31;
933  mon = ( m_dateLastEdition >> 22 ) & 15;
934  year = ( m_dateLastEdition >> 26 ) + 1990;
935 
936  aFormatter.Print( 0, "Ti %d/%d/%d %d:%d:%d\n", year, mon, day, hour, min, sec );
937 
938  return true;
939 }
timestamp_t m_dateLastEdition
Date of the last modification.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
#define min(a, b)
Definition: auxiliary.h:85
void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 215 of file base_struct.h.

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

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

Definition at line 232 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

232 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:138
void LIB_PART::SetConversion ( bool  aSetConvert)

Set or clear the alternate body style (DeMorgan) for the part.

If the part already has an alternate body style set and a asConvert if false, all of the existing draw items for the alternate body style are remove. If the alternate body style is not set and asConvert is true, than the base draw items are duplicated and added to the part.

Parameters
aSetConvert- Set or clear the part alternate body style.

Definition at line 1079 of file class_libentry.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), EDA_ITEM::Clone(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::erase(), HasConversion(), i, LIB_PIN_T, LIB_ITEM::m_Convert, and m_drawings.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

1080 {
1081  if( aSetConvert == HasConversion() )
1082  return;
1083 
1084  // Duplicate items to create the converted shape
1085  if( aSetConvert )
1086  {
1087  std::vector< LIB_ITEM* > tmp; // Temporarily store the duplicated pins here.
1088 
1089  for( LIB_ITEM& item : m_drawings )
1090  {
1091  // Only pins are duplicated.
1092  if( item.Type() != LIB_PIN_T )
1093  continue;
1094 
1095  if( item.m_Convert == 1 )
1096  {
1097  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1098  newItem->m_Convert = 2;
1099  tmp.push_back( newItem );
1100  }
1101  }
1102 
1103  // Transfer the new pins to the LIB_PART.
1104  for( unsigned i = 0; i < tmp.size(); i++ )
1105  m_drawings.push_back( tmp[i] );
1106  }
1107  else
1108  {
1109  // Delete converted shape items because the converted shape does
1110  // not exist
1111  LIB_ITEMS_CONTAINER::ITERATOR i = m_drawings.begin();
1112 
1113  while( i != m_drawings.end() )
1114  {
1115  if( i->m_Convert > 1 )
1116  i = m_drawings.erase( i );
1117  else
1118  ++i;
1119  }
1120  }
1121 }
bool HasConversion() const
Test if part has more than one body conversion type (DeMorgan).
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
ITERATOR_BASE< LIB_ITEM, MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::iterator > ITERATOR
The non-const iterator
Definition: multivector.h:160
size_t i
Definition: json11.cpp:597
int m_Convert
Shape identification for alternate body styles.
void LIB_PART::SetFields ( const std::vector< LIB_FIELD > &  aFieldsList)

Overwrite all the existing fields in this symbol with fields supplied in aFieldsList.

The only known caller of this function is the library part field editor, and it establishes needed behavior.

Parameters
aFieldsListis a set of fields to import, removing all previous fields.

Definition at line 826 of file class_libentry.cpp.

References deleteAllFields(), i, m_drawings, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), and EDA_ITEM::SetParent().

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

827 {
828  deleteAllFields();
829 
830  for( unsigned i=0; i<aFields.size(); ++i )
831  {
832  // drawings is a ptr_vector, new and copy an object on the heap.
833  LIB_FIELD* field = new LIB_FIELD( aFields[i] );
834 
835  field->SetParent( this );
836  m_drawings.push_back( field );
837  }
838 }
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
void deleteAllFields()
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:216
void push_back(T *aItem)
Definition: multivector.h:169
size_t i
Definition: json11.cpp:597
void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 256 of file base_struct.h.

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

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

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

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

Definition at line 285 of file base_struct.h.

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

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

Definition at line 231 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

231 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:137
void LIB_PART::SetLib ( PART_LIB aLibrary)
inline

Definition at line 296 of file class_libentry.h.

Referenced by LEGACY_RESCUER::AddPart(), PART_LIB::FindAlias(), LIB_PART(), and PART_LIB::LoadLibrary().

296 { m_library = aLibrary; }
PART_LIB * m_library
Library the part belongs to if any.
void LIB_PART::SetLibId ( const LIB_ID aLibId)
inline

Definition at line 290 of file class_libentry.h.

Referenced by RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction().

290 { m_libId = aLibId; }
LIB_ID m_libId
void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 217 of file base_struct.h.

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

217 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:169
void EDA_ITEM::SetModified ( )
inherited
void LIB_PART::SetName ( const wxString &  aName)
virtual

Definition at line 344 of file class_libentry.cpp.

References LIB_ID::FixIllegalChars(), GetValueField(), LIB_ID::ID_SCH, m_aliases, m_libId, LIB_ID::SetLibItemName(), and LIB_FIELD::SetText().

Referenced by SCH_EDIT_FRAME::CreateArchiveLibrary(), LIB_EDIT_FRAME::EditField(), LIB_EDIT_FRAME::fixDuplicateAliases(), LIB_PART(), RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), RemoveAlias(), LIB_EDIT_FRAME::savePartAs(), and DIALOG_LIB_EDIT_ONE_FIELD::UpdateField().

345 {
346  // The LIB_ALIAS that is the LIB_PART name has to be created so create it.
347  if( m_aliases.empty() )
348  m_aliases.push_back( new LIB_ALIAS( aName, this ) );
349  else
350  m_aliases[0]->SetName( aName );
351 
352  wxString validatedName = LIB_ID::FixIllegalChars( aName, LIB_ID::ID_SCH );
353  m_libId.SetLibItemName( validatedName, false );
354 
355  GetValueField().SetText( validatedName );
356 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
LIB_FIELD & GetValueField()
Return reference to the value field.
void SetText(const wxString &aText) override
Sets the field text to aText.
Definition: lib_field.cpp:510
LIB_ID m_libId
int SetLibItemName(const UTF8 &aLibItemName, bool aTestForRev=true)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:206
static UTF8 FixIllegalChars(const UTF8 &aLibItemName, LIB_ID_TYPE aType, bool aLib=false)
Replace illegal LIB_ID item name characters with underscores &#39;_&#39;.
Definition: lib_id.cpp:352
void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 214 of file base_struct.h.

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

214 { Pnext = aNext; }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:167
void LIB_PART::SetNormal ( )
inline

Definition at line 394 of file class_libentry.h.

References ENTRY_NORMAL.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

394 { m_options = ENTRY_NORMAL; }
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
void LIB_PART::SetOffset ( const wxPoint aOffset)

Move the part aOffset.

Parameters
aOffset- Offset displacement.

Definition at line 961 of file class_libentry.cpp.

References m_drawings.

962 {
963  for( LIB_ITEM& item : m_drawings )
964  item.SetOffset( aOffset );
965 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
void LIB_PART::SetPinNameOffset ( int  aOffset)
inline

Set the offset in mils of the pin name text from the pin symbol.

Set the offset to 0 to draw the pin name above the pin symbol.

Parameters
aOffset- The offset in mils.

Definition at line 707 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

707 { m_pinNameOffset = aOffset; }
int m_pinNameOffset
The offset in mils to draw the pin name.
void LIB_PART::SetPower ( )
inline

Definition at line 393 of file class_libentry.h.

References ENTRY_POWER.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

393 { m_options = ENTRY_POWER; }
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
void EDA_ITEM::SetSelected ( )
inlineinherited

Definition at line 230 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

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

230 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:121
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
void LIB_PART::SetShowPinNames ( bool  aShow)
inline

Set or clear the pin name visibility flag.

Parameters
aShow- True to make the part pin names visible.

Definition at line 716 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

716 { m_showPinNames = aShow; }
bool m_showPinNames
Determines if part pin names are visible.
void LIB_PART::SetShowPinNumbers ( bool  aShow)
inline

Set or clear the pin number visibility flag.

Parameters
aShow- True to make the part pin numbers visible.

Definition at line 725 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

725 { m_showPinNumbers = aShow; }
bool m_showPinNumbers
Determines if part pin numbers are visible.
void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited
void LIB_PART::SetSubpartIdNotation ( int  aSep,
int  aFirstId 
)
static

Set the separator char between the subpart id and the reference 0 (no separator) or '.

' , '-' and '_' and the ascii char value to calculate the subpart symbol id from the part number: 'A' or '1' only are allowed. (to print U1.A or U1.1) if this is a digit, a number is used as id symbol Note also if the subpart symbol is a digit, the separator cannot be null.

Parameters
aSep= the separator symbol (0 (no separator) or '.' , '-' and '_')
aFirstId= the Id of the first part ('A' or '1')

Definition at line 1248 of file class_libentry.cpp.

References m_subpartFirstId, and m_subpartIdSeparator.

Referenced by SCH_EDIT_FRAME::LoadProjectFile(), and PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow().

1249 {
1250  m_subpartFirstId = 'A';
1252 
1253  if( aSep == '.' || aSep == '-' || aSep == '_' )
1254  m_subpartIdSeparator = aSep;
1255 
1256  if( aFirstId == '1' && aSep != 0 )
1257  m_subpartFirstId = aFirstId;
1258 }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
static int m_subpartFirstId
the ascii char value to calculate the subpart symbol id from the part number: only &#39;A&#39;...
void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 206 of file base_struct.h.

Referenced by PCB_BASE_FRAME::AddModuleToBoard(), BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::CreateSheet(), Diagnose(), SCH_EDIT_FRAME::DuplicateItemsInList(), DuplicateStruct(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::editFootprintInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), EDA_ITEM::initVars(), BOARD::InsertArea(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadPolygon(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), EDA_ITEM::operator=(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseDIMENSION(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), BOARD::ReplaceNetlist(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), SwapItemData(), TestDuplicateSheetNames(), and DIALOG_ERC::TestErc().

206 { m_TimeStamp = aNewTimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:172
void LIB_PART::SetUnitCount ( int  count)

Set the units per part count.

If the count is greater than the current count, then the all of the current draw items are duplicated for each additional part. If the count is less than the current count, all draw objects for units greater that count are removed from the part.

Parameters
count- Number of units per package.

Definition at line 1032 of file class_libentry.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), EDA_ITEM::Clone(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::erase(), i, m_drawings, LIB_ITEM::m_Unit, and m_unitCount.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataFromWindow().

1033 {
1034  if( m_unitCount == aCount )
1035  return;
1036 
1037  if( aCount < m_unitCount )
1038  {
1040 
1041  while( i != m_drawings.end() )
1042  {
1043  if( i->m_Unit > aCount )
1044  i = m_drawings.erase( i );
1045  else
1046  ++i;
1047  }
1048  }
1049  else
1050  {
1051  int prevCount = m_unitCount;
1052 
1053  // Temporary storage for new items, as adding new items directly to
1054  // m_drawings may cause the buffer reallocation which invalidates the
1055  // iterators
1056  std::vector< LIB_ITEM* > tmp;
1057 
1058  for( LIB_ITEM& item : m_drawings )
1059  {
1060  if( item.m_Unit != 1 )
1061  continue;
1062 
1063  for( int j = prevCount + 1; j <= aCount; j++ )
1064  {
1065  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1066  newItem->m_Unit = j;
1067  tmp.push_back( newItem );
1068  }
1069  }
1070 
1071  for( auto item : tmp )
1072  m_drawings.push_back( item );
1073  }
1074 
1075  m_unitCount = aCount;
1076 }
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:183
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
int m_unitCount
Number of units (parts) per package.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
int m_Unit
Unit identification for multiple parts per package.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:189
ITERATOR erase(const ITERATOR &aIterator)
Definition: multivector.h:174
ITERATOR_BASE< LIB_ITEM, MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::iterator > ITERATOR
The non-const iterator
Definition: multivector.h:160
size_t i
Definition: json11.cpp:597
void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 229 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

229 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:118
PART_SPTR LIB_PART::SharedPtr ( )
inline

Definition at line 274 of file class_libentry.h.

Referenced by SCH_COMPONENT::Resolve(), SCH_COMPONENT::SCH_COMPONENT(), and SCH_COMPONENT::SetLibId().

275  {
276  // clone a shared pointer
277  return m_me;
278  }
PART_SPTR m_me
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
bool LIB_PART::ShowPinNames ( )
inline
bool LIB_PART::ShowPinNumbers ( )
inline
static bool EDA_ITEM::Sort ( const EDA_ITEM aLeft,
const EDA_ITEM aRight 
)
inlinestaticinherited

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

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

Definition at line 483 of file base_struct.h.

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

Referenced by PART_LIB::GetEntryTypePowerNames().

483 { return *aLeft < *aRight; }
static int* LIB_PART::SubpartFirstIdPtr ( )
inlinestatic

return a reference to m_subpartFirstId, only for read/save setting functions

Definition at line 673 of file class_libentry.h.

Referenced by SCH_EDIT_FRAME::GetProjectFileParametersList().

673 { return &m_subpartFirstId; }
static int m_subpartFirstId
the ascii char value to calculate the subpart symbol id from the part number: only &#39;A&#39;...
static int* LIB_PART::SubpartIdSeparatorPtr ( )
inlinestatic

return a reference to m_subpartIdSeparator, only for read/save setting functions

Definition at line 667 of file class_libentry.h.

Referenced by SCH_EDIT_FRAME::GetProjectFileParametersList().

667 { return &m_subpartIdSeparator; }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
wxString LIB_PART::SubReference ( int  aUnit,
bool  aAddSeparator = true 
)
static
Returns
the sub reference for part having multiple units per part. The sub reference identify the part (or unit)
Parameters
aUnit= the part identifier ( 1 to max count)
aAddSeparator= true (default) to prpebd the sub ref by the separator symbol (if any) Note: this is a static function.

Definition at line 302 of file class_libentry.cpp.

References m_subpartFirstId, and m_subpartIdSeparator.

Referenced by AddMenusForEditComponent(), SCH_EDIT_FRAME::AnnotateComponents(), SCH_REFERENCE_LIST::CheckAnnotation(), LIB_FIELD::GetFullText(), SCH_FIELD::GetFullyQualifiedText(), LIB_ALIAS::GetUnitReference(), SCH_FIELD::Matches(), TestMultiunitFootprints(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), and LIB_EDIT_FRAME::UpdatePartSelectList().

303 {
304  wxString subRef;
305 
306  if( m_subpartIdSeparator != 0 && aAddSeparator )
307  subRef << wxChar( m_subpartIdSeparator );
308 
309  if( m_subpartFirstId >= '0' && m_subpartFirstId <= '9' )
310  subRef << aUnit;
311  else
312  {
313  // use letters as notation. To allow more than 26 units, the sub ref
314  // use one letter if letter = A .. Z or a ... z, and 2 letters otherwise
315  // first letter is expected to be 'A' or 'a' (i.e. 26 letters are available)
316  int u;
317  aUnit -= 1; // Unit number starts to 1. now to 0.
318 
319  while( aUnit >= 26 ) // more than one letter are needed
320  {
321  u = aUnit / 26;
322  subRef << wxChar( m_subpartFirstId + u -1 );
323  aUnit %= 26;
324  }
325 
326  u = m_subpartFirstId + aUnit;
327  subRef << wxChar( u );
328  }
329 
330  return subRef;
331 }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
static int m_subpartFirstId
the ascii char value to calculate the subpart symbol id from the part number: only &#39;A&#39;...
KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

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

Returns
KICAD_T - the type of object.

Definition at line 201 of file base_struct.h.

References EDA_ITEM::m_StructType.

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

202  {
203  return m_StructType;
204  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it...
Definition: base_struct.h:163
bool LIB_PART::UnitsLocked ( ) const
inline

Check whether part units are interchangeable.

Returns
False when interchangeable, true otherwise.

Definition at line 406 of file class_libentry.h.

References TYPE_NOT_INIT.

Referenced by LIB_EDIT_FRAME::BlockSelectItems(), SCH_REFERENCE::IsUnitsLocked(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), LIB_EDIT_FRAME::OnEditComponentProperties(), LIB_EDIT_FRAME::OnUpdateSyncPinEdit(), SCH_LEGACY_PLUGIN_CACHE::saveSymbol(), LIB_EDIT_FRAME::SetCurPart(), LIB_EDIT_FRAME::SynchronizePins(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::TransferDataToWindow().

406 { return m_unitsLocked; }
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

Function ViewBBox() returns the bounding box of the item covering all its layers.

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

Reimplemented in D_PAD, MODULE, EDIT_POINTS, GERBER_DRAW_ITEM, TRACK, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, MARKER_PCB, KIGFX::WORKSHEET_VIEWITEM, ROUTER_PREVIEW_ITEM, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, BRIGHT_BOX, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 265 of file base_struct.cpp.

References EDA_ITEM::GetBoundingBox().

Referenced by EDA_ITEM::Sort(), BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), BRIGHT_BOX::ViewDraw(), and COMMON_TOOLS::ZoomFitScreen().

266 {
267  // Basic fallback
268  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
269  VECTOR2I( GetBoundingBox().GetSize() ) );
270 }
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
BOX2< VECTOR2I > BOX2I
Definition: box2.h:520
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
virtual void KIGFX::VIEW_ITEM::ViewDraw ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Function ViewDraw() Draws the parts of the object belonging to layer aLayer.

viewDraw() is an alternative way for drawing objects if if there is no PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on

Reimplemented in EDIT_POINTS, KIGFX::WORKSHEET_VIEWITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::VIEW_OVERLAY, KIGFX::ORIGIN_VIEWITEM, BRIGHT_BOX, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, and PCB_BRIGHT_BOX.

Definition at line 116 of file view_item.h.

References KIGFX::VIEW_ITEM::ViewGetLayers().

Referenced by KIGFX::VIEW::draw(), and KIGFX::VIEW::updateItemGeometry().

117  {}
void LIB_PART::ViewGetLayers ( int  aLayers[],
int &  aCount 
) const
overridevirtual

Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on.

For instance, a D_PAD spans zero or more copper layers and a few technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called for each of the layers returned by ViewGetLayers(), depending on the rendering order.

Parameters
aLayers[]output layer index array
aCountnumber of layer indices in aLayers[]

Reimplemented from EDA_ITEM.

Definition at line 782 of file class_libentry.cpp.

References LAYER_DEVICE, and LAYER_DEVICE_BACKGROUND.

783 {
784  aCount = 2;
785  aLayers[0] = LAYER_DEVICE;
786  aLayers[1] = LAYER_DEVICE_BACKGROUND;
787 }
virtual unsigned int KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Function ViewGetLOD() Returns the level of detail (LOD) of the item.

A level of detail is the minimal VIEW scale that is sufficient for an item to be shown on a given layer.

Parameters
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on
Returns
the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in D_PAD, MODULE, VIA, GERBER_DRAW_ITEM, TRACK, TEXTE_MODULE, and EDGE_MODULE.

Definition at line 140 of file view_item.h.

Referenced by KIGFX::VIEW::drawItem::operator()().

141  {
142  // By default always show the item
143  return 0;
144  }
SEARCH_RESULT EDA_ITEM::Visit ( INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
virtualinherited

Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in scanTypes[], and may use IterateForward() to do so on lists of such data.

Parameters
inspectorAn INSPECTOR instance to use in the inspection.
testDataArbitrary data used by the inspector.
scanTypesWhich KICAD_T types are of interest and the order is significant too, terminated by EOT.
Returns
SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else SCAN_CONTINUE, and determined by the inspector.

Reimplemented in BOARD, MODULE, SCH_COMPONENT, SCH_SHEET, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 149 of file base_struct.cpp.

References EOT, EDA_ITEM::GetClass(), SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Type().

Referenced by SCH_SHEET::CanConnect(), GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), EDA_ITEM::HitTest(), and EDA_ITEM::IterateForward().

150 {
151  KICAD_T stype;
152 
153 #if 0 && defined(DEBUG)
154  std::cout << GetClass().mb_str() << ' ';
155 #endif
156 
157  for( const KICAD_T* p = scanTypes; (stype = *p) != EOT; ++p )
158  {
159  // If caller wants to inspect my type
160  if( stype == Type() )
161  {
162  if( SEARCH_QUIT == inspector( this, testData ) )
163  return SEARCH_QUIT;
164 
165  break;
166  }
167  }
168 
169  return SEARCH_CONTINUE;
170 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
virtual wxString GetClass() const =0
Function GetClass returns the class name.

Member Data Documentation

LIB_ALIASES LIB_PART::m_aliases
private

List of alias object pointers associated with the part.

Definition at line 252 of file class_libentry.h.

Referenced by AddAlias(), GetAlias(), GetAliasNames(), GetName(), HasAlias(), LIB_PART(), RemoveAlias(), RemoveAllAliases(), SetName(), and ~LIB_PART().

timestamp_t LIB_PART::m_dateLastEdition
private

Date of the last modification.

Definition at line 246 of file class_libentry.h.

Referenced by LIB_PART(), LoadDateAndTime(), and SaveDateAndTime().

STATUS_FLAGS EDA_ITEM::m_Flags
protectedinherited

Flag bits for editing and other uses.

Definition at line 178 of file base_struct.h.

Referenced by LIB_CIRCLE::BeginEdit(), LIB_RECTANGLE::BeginEdit(), LIB_POLYLINE::BeginEdit(), LIB_TEXT::BeginEdit(), LIB_ARC::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_CIRCLE::CalcEdit(), LIB_POLYLINE::CalcEdit(), LIB_RECTANGLE::CalcEdit(), LIB_TEXT::CalcEdit(), LIB_ARC::CalcEdit(), LIB_FIELD::CalcEdit(), LIB_PIN::CalcEdit(), LIB_TEXT::Clone(), LIB_CIRCLE::ContinueEdit(), LIB_RECTANGLE::ContinueEdit(), LIB_POLYLINE::ContinueEdit(), LIB_TEXT::ContinueEdit(), LIB_ARC::ContinueEdit(), LIB_FIELD::ContinueEdit(), SCH_LINE::Draw(), TRACK::Draw(), DRAWSEGMENT::Draw(), MODULE::Draw(), SEGZONE::Draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), LIB_BEZIER::drawGraphic(), LIB_ARC::drawGraphic(), DRAWSEGMENT::DRAWSEGMENT(), LIB_CIRCLE::EndEdit(), LIB_RECTANGLE::EndEdit(), LIB_POLYLINE::EndEdit(), LIB_TEXT::EndEdit(), LIB_ARC::EndEdit(), LIB_ITEM::EndEdit(), LIB_FIELD::EndEdit(), EDA_ITEM::GetFlags(), TRACK::GetMsgPanelInfoBase_Common(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), GERBER_DRAW_ITEM::HitTest(), SCH_COMPONENT::HitTest(), LIB_ITEM::InEditMode(), EDA_ITEM::initVars(), SCH_ITEM::IsConnected(), SCH_LINE::Move(), EDA_ITEM::operator=(), SCH_COMPONENT::SCH_COMPONENT(), LIB_PIN::SetConversion(), LIB_PIN::SetLength(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), LIB_PIN::SetType(), and LIB_PIN::SetVisible().

wxArrayString LIB_PART::m_FootprintList
private

List of suitable footprint names for the part (wild card names accepted).

Definition at line 250 of file class_libentry.h.

Referenced by LIB_PART().

bool EDA_ITEM::m_forceVisible
protectedinherited

Set to true to override the visibility setting of the item.

Definition at line 175 of file base_struct.h.

Referenced by SCH_FIELD::Draw(), EDA_ITEM::initVars(), and EDA_ITEM::operator=().

LIB_ID LIB_PART::m_libId
private

Definition at line 239 of file class_libentry.h.

Referenced by GetLibraryName(), LIB_PART(), and SetName().

PART_LIB* LIB_PART::m_library
private

Library the part belongs to if any.

Definition at line 254 of file class_libentry.h.

Referenced by GetLibraryName(), and LIB_PART().

DHEAD* EDA_ITEM::m_List
protectedinherited

which DLIST I am on.

Definition at line 169 of file base_struct.h.

Referenced by EDA_ITEM::GetList(), and EDA_ITEM::initVars().

LIBRENTRYOPTIONS LIB_PART::m_options
private

Special part features such as POWER or NORMAL.)

Definition at line 247 of file class_libentry.h.

Referenced by LIB_PART().

int LIB_PART::m_pinNameOffset
private

The offset in mils to draw the pin name.

Set to 0 to draw the pin name above the pin.

Definition at line 240 of file class_libentry.h.

Referenced by LIB_PART().

bool LIB_PART::m_showPinNames
private

Determines if part pin names are visible.

Definition at line 244 of file class_libentry.h.

Referenced by LIB_PART().

bool LIB_PART::m_showPinNumbers
private

Determines if part pin numbers are visible.

Definition at line 245 of file class_libentry.h.

Referenced by LIB_PART().

int LIB_PART::m_subpartFirstId = 'A'
staticprivate

the ascii char value to calculate the subpart symbol id from the part number: only 'A', 'a' or '1' can be used, other values have no sense.

Definition at line 259 of file class_libentry.h.

Referenced by SetSubpartIdNotation(), and SubReference().

int LIB_PART::m_subpartIdSeparator = 0
staticprivate

the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or U1.A or U1-A

Definition at line 256 of file class_libentry.h.

Referenced by SetSubpartIdNotation(), and SubReference().

timestamp_t EDA_ITEM::m_TimeStamp
protectedinherited
int LIB_PART::m_unitCount
private

Number of units (parts) per package.

Definition at line 248 of file class_libentry.h.

Referenced by GetBodyBoundingBox(), GetUnitBoundingBox(), LIB_PART(), and SetUnitCount().

bool LIB_PART::m_unitsLocked
private

True if part has multiple units and changing one unit does not automatically change another unit.

Definition at line 242 of file class_libentry.h.

Referenced by LIB_PART().

EDA_ITEM* EDA_ITEM::Pback
protectedinherited

previous in linked list

Definition at line 168 of file base_struct.h.

Referenced by SCH_LINE::Back(), TRACK::Back(), BOARD_ITEM::Back(), EDA_ITEM::Back(), EDA_ITEM::initVars(), and TRACK::SetBack().


The documentation for this class was generated from the following files: