SCH_SYMBOL Class Reference

Schematic symbol object. More...

#include <sch_symbol.h>

Inheritance diagram for SCH_SYMBOL:

Public Member Functions
	SCH_SYMBOL (const wxPoint &pos=wxPoint(0, 0), SCH_ITEM *aParent=nullptr)
	SCH_SYMBOL (const LIB_SYMBOL &aSymbol, const LIB_ID &aLibId, const SCH_SHEET_PATH *aSheet, int unit=0, int convert=0, const wxPoint &pos=wxPoint(0, 0))
	Create schematic symbol from library symbol object. More...
	SCH_SYMBOL (const LIB_SYMBOL &aSymbol, const SCH_SHEET_PATH *aSheet, const PICKED_SYMBOL &aSel, const wxPoint &pos=wxPoint(0, 0))
	SCH_SYMBOL (const SCH_SYMBOL &aSymbol)
	Clone aSymbol into a new schematic symbol object. More...
	~SCH_SYMBOL ()
wxString	GetClass () const override
	Return the class name. More...
const std::vector< SYMBOL_INSTANCE_REFERENCE > &	GetInstanceReferences ()
void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the layers the item is drawn on (which may be more than its "home" layer) More...
bool	IsMovableFromAnchorPoint () const override
	Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor. More...
void	SetLibId (const LIB_ID &aName)
const LIB_ID &	GetLibId () const
void	SetSchSymbolLibraryName (const wxString &aName)
	The name of the symbol in the schematic library symbol list. More...
wxString	GetSchSymbolLibraryName () const
bool	UseLibIdLookup () const
std::unique_ptr< LIB_SYMBOL > &	GetLibSymbolRef ()
const std::unique_ptr< LIB_SYMBOL > &	GetLibSymbolRef () const
void	SetLibSymbol (LIB_SYMBOL *aLibSymbol)
	Set this schematic symbol library symbol reference to aLibSymbol. More...
wxString	GetDescription () const
	Return information about the aliased parts. More...
wxString	GetDatasheet () const
	Return the documentation text for the given part alias. More...
int	GetUnit () const
void	UpdatePins ()
	Updates the cache of SCH_PIN objects for each pin. More...
void	SetUnit (int aUnit)
	Change the unit number to aUnit. More...
void	UpdateUnit (int aUnit)
	Change the unit number to aUnit without setting any internal flags. More...
int	GetConvert () const
void	SetConvert (int aConvert)
wxString	GetPrefix () const
void	SetPrefix (const wxString &aPrefix)
TRANSFORM &	GetTransform ()
const TRANSFORM &	GetTransform () const
void	SetTransform (const TRANSFORM &aTransform)
int	GetUnitCount () const
	Return the number of units per package of the symbol. More...
void	SetOrientation (int aOrientation)
	Compute the new transform matrix based on aOrientation for the symbol which is applied to the current transform. More...
int	GetOrientation ()
	Get the display symbol orientation. More...
void	GetContextualTextVars (wxArrayString *aVars) const
	Return the list of system text vars & fields for this symbol. More...
bool	ResolveTextVar (wxString *token, int aDepth=0) const
	Resolve any references to system tokens supported by the symbol. More...
void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
	Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
void	ClearAnnotation (const SCH_SHEET_PATH *aSheetPath)
	Clear exiting symbol annotation. More...
bool	AddSheetPathReferenceEntryIfMissing (const KIID_PATH &aSheetPath)
	Add an instance to the alternate references list (m_instanceReferences), if this entry does not already exist. More...
bool	ReplaceInstanceSheetPath (const KIID_PATH &aOldSheetPath, const KIID_PATH &aNewSheetPath)
	Replace aOldSheetPath with aNewSheetPath in the instance list. More...
const EDA_RECT	GetBoundingBox () const override
	Return the orthogonal bounding box of this object for display purposes. More...
const EDA_RECT	GetBoundingBox (bool aIncludeInvisibleText) const
EDA_RECT	GetBodyBoundingBox () const
	Return a bounding box for the symbol body but not the fields. More...
SCH_FIELD *	GetField (MANDATORY_FIELD_T aFieldType)
	Return a mandatory field in this symbol. More...
const SCH_FIELD *	GetField (MANDATORY_FIELD_T aFieldNdx) const
SCH_FIELD *	GetFieldById (int aFieldId)
	Return a field in this symbol. More...
wxString	GetFieldText (const wxString &aFieldName, SCH_EDIT_FRAME *aFrame) const
	Search for a field named aFieldName and returns text associated with this field. More...
void	GetFields (std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
	Populate a std::vector with SCH_FIELDs. More...
std::vector< SCH_FIELD > &	GetFields ()
	Return a vector of fields from the symbol. More...
const std::vector< SCH_FIELD > &	GetFields () const
SCH_FIELD *	AddField (const SCH_FIELD &aField)
	Add a field to the symbol. More...
void	RemoveField (const wxString &aFieldName)
	Remove a user field from the symbol. More...
SCH_FIELD *	FindField (const wxString &aFieldName, bool aIncludeDefaultFields=true)
	Search for a SCH_FIELD with aFieldName. More...
void	SetFields (const SCH_FIELDS &aFields)
	Set multiple schematic fields. More...
void	UpdateFields (const SCH_SHEET_PATH *aPath, bool aUpdateStyle, bool aUpdateRef, bool aUpdateOtherFields, bool aResetRef, bool aResetOtherFields)
	Restore fields to the original library values. More...
int	GetFieldCount () const
	Return the number of fields in this symbol. More...
void	AutoplaceFields (SCH_SCREEN *aScreen, bool aManual) override
	Automatically orient all the fields in the symbol. More...
void	RunOnChildren (const std::function< void(SCH_ITEM *)> &aFunction) override
SCH_PIN *	GetPin (const wxString &number) const
	Find a symbol pin by number. More...
void	GetLibPins (std::vector< LIB_PIN * > &aPinsList) const
	Populate a vector with all the pins from the library object. More...
SCH_PIN *	GetPin (LIB_PIN *aLibPin)
std::vector< SCH_PIN * >	GetPins (const SCH_SHEET_PATH *aSheet=nullptr) const
	Retrieve a list of the SCH_PINs for the given sheet path. More...
std::vector< std::unique_ptr< SCH_PIN > > &	GetRawPins ()
void	Print (const RENDER_SETTINGS *aSettings, const wxPoint &aOffset) override
	Print a symbol. More...
void	SwapData (SCH_ITEM *aItem) override
	Swap the internal data structures aItem with the schematic item. More...
const wxString	GetRef (const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
	Return the reference for the given sheet path. More...
void	SetRef (const SCH_SHEET_PATH *aSheet, const wxString &aReference)
	Set the reference for the given sheet path for this symbol. More...
bool	IsAnnotated (const SCH_SHEET_PATH *aSheet)
	Check if the symbol has a valid annotation (reference) for the given sheet path. More...
void	AddHierarchicalReference (const KIID_PATH &aPath, const wxString &aRef, int aUnit, const wxString &aValue=wxEmptyString, const wxString &aFootprint=wxEmptyString)
	Add a full hierarchical reference to this symbol. More...
int	GetUnitSelection (const SCH_SHEET_PATH *aSheet) const
	Return the instance-specific unit selection for the given sheet path. More...
void	SetUnitSelection (const SCH_SHEET_PATH *aSheet, int aUnitSelection)
	Set the selected unit of this symbol on one sheet. More...
void	SetUnitSelection (int aUnitSelection)
	Set the selected unit of this symbol for all sheets. More...
const wxString	GetValue (const SCH_SHEET_PATH *sheet, bool aResolve) const
	Return the instance-specific value for the given sheet path. More...
void	SetValue (const SCH_SHEET_PATH *sheet, const wxString &aValue)
void	SetValue (const wxString &aValue)
	Set the value for all instances (the default GUI behavior). More...
const wxString	GetFootprint (const SCH_SHEET_PATH *sheet, bool aResolve) const
	Return the instance-specific footprint assignment for the given sheet path. More...
void	SetFootprint (const SCH_SHEET_PATH *sheet, const wxString &aFootprint)
void	SetFootprint (const wxString &aFootprint)
	Set the value for all instances (the default GUI behavior). More...
void	Move (const wxPoint &aMoveVector) override
	Move the item by aMoveVector to a new position. More...
void	MirrorHorizontally (int aCenter) override
	Mirror item horizontally about aCenter. More...
void	MirrorVertically (int aCenter) override
	Mirror item vertically about aCenter. More...
void	Rotate (const wxPoint &aCenter) override
	Rotate the item around aCenter 90 degrees in the clockwise direction. More...
bool	Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const override
	Compare the item against the search criteria in aSearchData. More...
void	GetEndPoints (std::vector< DANGLING_END_ITEM > &aItemList) override
	Add the schematic item end points to aItemList if the item has end points. More...
bool	UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemList, const SCH_SHEET_PATH *aPath=nullptr) override
	Test if the symbol's dangling state has changed for all pins. More...
wxPoint	GetPinPhysicalPosition (const LIB_PIN *Pin) const
bool	IsConnectable () const override
bool	CanConnect (const SCH_ITEM *aItem) const override
bool	IsInNetlist () const
std::vector< wxPoint >	GetConnectionPoints () const override
	Add all the connection points for this item to aPoints. More...
SEARCH_RESULT	Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...
LIB_ITEM *	GetDrawItem (const wxPoint &aPosition, KICAD_T aType=TYPE_NOT_INIT)
	Return the symbol library item at aPosition that is part of this symbol. More...
wxString	GetSelectMenuText (EDA_UNITS aUnits) const override
	Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
BITMAPS	GetMenuImage () const override
	Return a pointer to an image to be used in menus. More...
bool	operator< (const SCH_ITEM &aItem) const override
bool	operator== (const SCH_SYMBOL &aSymbol) const
bool	operator!= (const SCH_SYMBOL &aSymbol) const
SCH_SYMBOL &	operator= (const SCH_ITEM &aItem)
bool	IsReplaceable () const override
	Override this method in any derived object that supports test find and replace. More...
wxPoint	GetPosition () const override
void	SetPosition (const wxPoint &aPosition) override
bool	HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
	Test if aPosition is contained within or on the bounding box of an item. More...
bool	HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
	Test if aRect intersects or is contained within the bounding box of an item. More...
void	Plot (PLOTTER *aPlotter) const override
	Plot the schematic item to aPlotter. More...
EDA_ITEM *	Clone () const override
	Create a duplicate of this item with linked list members set to NULL. More...
void	ClearBrightenedPins ()
bool	HasBrightenedPins ()
bool	GetIncludeInBom () const
void	SetIncludeInBom (bool aIncludeInBom)
bool	GetIncludeOnBoard () const
void	SetIncludeOnBoard (bool aIncludeOnBoard)
bool	IsPointClickableAnchor (const wxPoint &aPos) const override
SCH_ITEM *	Duplicate (bool doClone=false) const
	Routine to create a new copy of given item. More...
wxPoint &	GetStoredPos ()
void	SetStoredPos (const wxPoint &aPos)
SCHEMATIC *	Schematic () const
	Searches the item hierarchy to find a SCHEMATIC. More...
virtual bool	IsLocked () const
virtual void	SetLocked (bool aLocked)
	Set the 'lock' status to aLocked for of this item. More...
virtual bool	IsHypertext () const
	Allow items to support hypertext actions when hovered/clicked. More...
virtual void	DoHypertextMenu (EDA_DRAW_FRAME *aFrame)
SCH_LAYER_ID	GetLayer () const
	Return the layer this item is on. More...
void	SetLayer (SCH_LAYER_ID aLayer)
	Set the layer this item is on. More...
virtual int	GetPenWidth () const
virtual bool	IsDangling () const
void	ClearConnections ()
	Clears all of the connection items from the list. More...
bool	IsConnected (const wxPoint &aPoint) const
	Test the item to see if it is connected to aPoint. More...
SCH_CONNECTION *	Connection (const SCH_SHEET_PATH *aSheet=nullptr) const
	Retrieve the connection associated with this object in the given sheet. More...
SCH_ITEM_SET &	ConnectedItems (const SCH_SHEET_PATH &aPath)
	Retrieve the set of items connected to this item on the given sheet. More...
void	AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
	Add a connection link between this item and another. More...
SCH_CONNECTION *	InitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
	Create a new connection object associated with this object. More...
virtual bool	ConnectionPropagatesTo (const EDA_ITEM *aItem) const
	Return true if this item should propagate connection info to aItem. More...
bool	IsConnectivityDirty ()
void	SetConnectivityDirty (bool aDirty=true)
NETCLASSPTR	NetClass (const SCH_SHEET_PATH *aSheet=nullptr) const
FIELDS_AUTOPLACED	GetFieldsAutoplaced () const
	Return whether the fields have been automatically placed. More...
void	SetFieldsAutoplaced ()
void	ClearFieldsAutoplaced ()
void	AutoAutoplaceFields (SCH_SCREEN *aScreen)
	Autoplace fields only if correct to do so automatically. More...
virtual bool	HasLineStroke () const
	Check if this schematic item has line stoke properties. More...
virtual STROKE_PARAMS	GetStroke () const
virtual void	SetStroke (const STROKE_PARAMS &aStroke)
bool	operator< (const EDA_ITEM &aItem) const
	Test if another item is less than this object. More...
KICAD_T	Type () const
	Returns the type of object. More...
EDA_ITEM *	GetParent () const
virtual void	SetParent (EDA_ITEM *aParent)
bool	IsModified () const
bool	IsNew () const
bool	IsMoving () const
bool	IsDragging () const
bool	IsWireImage () const
bool	IsSelected () const
bool	IsEntered () const
bool	IsResized () const
bool	IsBrightened () const
void	SetWireImage ()
void	SetSelected ()
void	SetBrightened ()
void	ClearSelected ()
void	ClearBrightened ()
void	SetModified ()
int	GetState (EDA_ITEM_FLAGS type) const
void	SetState (EDA_ITEM_FLAGS type, bool state)
EDA_ITEM_FLAGS	GetStatus () const
void	SetStatus (EDA_ITEM_FLAGS aStatus)
void	SetFlags (EDA_ITEM_FLAGS aMask)
void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
EDA_ITEM_FLAGS	GetFlags () const
bool	HasFlag (EDA_ITEM_FLAGS aFlag) const
EDA_ITEM_FLAGS	GetEditFlags () const
void	ClearTempFlags ()
void	ClearEditFlags ()
virtual bool	IsType (const KICAD_T aScanTypes[]) const
	Check whether the item is one of the listed types. More...
void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
bool	IsForceVisible () const
virtual const wxPoint	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
virtual bool	Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
	Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
virtual const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers. More...
virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Draw the parts of the object belonging to layer aLayer. More...
virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Return the level of detail (LOD) of the item. More...
VIEW_ITEM_DATA *	viewPrivData () const
void	ClearViewPrivData ()
bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)
template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)
template<typename T >
bool	Set (const wxString &aProperty, T aValue)
wxAny	Get (PROPERTY_BASE *aProperty)
template<typename T >
T	Get (PROPERTY_BASE *aProperty)
template<typename T >
boost::optional< T >	Get (const wxString &aProperty)

Static Public Member Functions
static bool	ClassOf (const EDA_ITEM *aItem)
static bool	IsReferenceStringValid (const wxString &aReferenceString)
	Test for an acceptable reference string. More...
template<class T >
static SEARCH_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	This changes first parameter to avoid the DList and use the main queue instead. More...
template<class T >
static SEARCH_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	Change first parameter to avoid the DList and use std::vector instead. More...
static bool	Replace (const wxFindReplaceData &aSearchData, wxString &aText)
	Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
static bool	Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
	Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...

Public Attributes
const KIID	m_Uuid

Protected Member Functions
bool	Matches (const wxString &aText, const wxFindReplaceData &aSearchData) const
	Compare aText against search criteria in aSearchData. More...

Protected Attributes
SCH_LAYER_ID	m_layer
EDA_ITEMS	m_connections
FIELDS_AUTOPLACED	m_fieldsAutoplaced
wxPoint	m_storedPos
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SET >	m_connected_items
	Store pointers to other items that are connected to this one, per sheet. More...
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * >	m_connection_map
	Store connectivity information, per sheet. More...
bool	m_connectivity_dirty
EDA_ITEM_FLAGS	m_status
EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...
bool	m_forceVisible
EDA_ITEM_FLAGS	m_flags

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

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

Detailed Description

Schematic symbol object.

Definition at line 78 of file sch_symbol.h.

Constructor & Destructor Documentation

SCH_SYMBOL() [1/4]

SCH_SYMBOL::SCH_SYMBOL	(	const wxPoint &	pos = wxPoint( 0, 0 ),
		SCH_ITEM *	aParent = nullptr
	)

Definition at line 97 of file sch_symbol.cpp.

                                                               :
    SCH_ITEM( aParent, SCH_SYMBOL_T )
{
    Init( aPos );
}

References Init().

Referenced by Clone().

SCH_SYMBOL() [2/4]

SCH_SYMBOL::SCH_SYMBOL	(	const LIB_SYMBOL &	aSymbol,
		const LIB_ID &	aLibId,
		const SCH_SHEET_PATH *	aSheet,
		int	unit = 0,
		int	convert = 0,
		const wxPoint &	pos = wxPoint( 0, 0 )
	)

Create schematic symbol from library symbol object.

Parameters

aSymbol	is the library symbol to create schematic symbol from.
aLibId	is the LIB_ID of alias to create.
aSheet	is the schematic sheet the symbol is place into.
unit	is unit for symbols that have multiple parts per package.
convert	is the alternate body style for the schematic symbols.
pos	is the position of the symbol.
setNewItemFlag	is used to set the symbol IS_NEW and IS_MOVING flags.

Definition at line 104 of file sch_symbol.cpp.

                                                                                                  :
    SCH_ITEM( nullptr, SCH_SYMBOL_T )
{
    Init( pos );

    m_unit      = unit;
    m_convert   = convert;
    m_lib_id    = aLibId;

    std::unique_ptr< LIB_SYMBOL > part;

    part = aSymbol.Flatten();
    part->SetParent();
    SetLibSymbol( part.release() );

    // Copy fields from the library symbol
    UpdateFields( aSheet,
                  true,   /* update style */
                  false,  /* update ref */
                  false,  /* update other fields */
                  true,   /* reset ref */
                  true    /* reset other fields */ );

    m_prefix = UTIL::GetRefDesPrefix( m_part->GetReferenceField().GetText() );

    if( aSheet )
        SetRef( aSheet, UTIL::GetRefDesUnannotated( m_prefix ) );

    // Inherit the include in bill of materials and board netlist settings from library symbol.
    m_inBom = aSymbol.GetIncludeInBom();
    m_onBoard = aSymbol.GetIncludeOnBoard();
}

References convert, LIB_SYMBOL::Flatten(), LIB_SYMBOL::GetIncludeInBom(), LIB_SYMBOL::GetIncludeOnBoard(), UTIL::GetRefDesPrefix(), UTIL::GetRefDesUnannotated(), Init(), m_convert, m_inBom, m_lib_id, m_onBoard, m_part, m_prefix, m_unit, SetLibSymbol(), SetRef(), and UpdateFields().

SCH_SYMBOL() [3/4]

SCH_SYMBOL::SCH_SYMBOL	(	const LIB_SYMBOL &	aSymbol,
		const SCH_SHEET_PATH *	aSheet,
		const PICKED_SYMBOL &	aSel,
		const wxPoint &	pos = wxPoint( 0, 0 )
	)

Definition at line 139 of file sch_symbol.cpp.

                                                                        :
    SCH_SYMBOL( aSymbol, aSel.LibId, aSheet, aSel.Unit, aSel.Convert, pos )
{
    // Set any fields that were modified as part of the symbol selection
    for( const std::pair<int, wxString>& i : aSel.Fields )
    {
        SCH_FIELD* field = GetFieldById( i.first );

        if( field )
            field->SetText( i.second );
    }
}

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

SCH_SYMBOL() [4/4]

SCH_SYMBOL::SCH_SYMBOL

(

const SCH_SYMBOL &

aSymbol

)

Clone aSymbol into a new schematic symbol object.

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

Parameters

aSymbol

is the schematic symbol to clone.

Definition at line 154 of file sch_symbol.cpp.

                                                  :
    SCH_ITEM( aSymbol )
{
    m_parent      = aSymbol.m_parent;
    m_pos         = aSymbol.m_pos;
    m_unit        = aSymbol.m_unit;
    m_convert     = aSymbol.m_convert;
    m_lib_id      = aSymbol.m_lib_id;
    m_isInNetlist = aSymbol.m_isInNetlist;
    m_inBom       = aSymbol.m_inBom;
    m_onBoard     = aSymbol.m_onBoard;

    if( aSymbol.m_part )
        SetLibSymbol( new LIB_SYMBOL( *aSymbol.m_part.get() ) );

    const_cast<KIID&>( m_Uuid ) = aSymbol.m_Uuid;

    m_transform = aSymbol.m_transform;
    m_prefix = aSymbol.m_prefix;
    m_instanceReferences = aSymbol.m_instanceReferences;
    m_fields = aSymbol.m_fields;

    // Re-parent the fields, which before this had aSymbol as parent
    for( SCH_FIELD& field : m_fields )
        field.SetParent( this );

    m_fieldsAutoplaced = aSymbol.m_fieldsAutoplaced;
    m_schLibSymbolName = aSymbol.m_schLibSymbolName;
}

References m_convert, m_fields, SCH_ITEM::m_fieldsAutoplaced, m_inBom, m_instanceReferences, m_isInNetlist, m_lib_id, m_onBoard, EDA_ITEM::m_parent, m_part, m_pos, m_prefix, m_schLibSymbolName, m_transform, m_unit, EDA_ITEM::m_Uuid, and SetLibSymbol().

~SCH_SYMBOL()

SCH_SYMBOL::~SCH_SYMBOL ( )

inline

Definition at line 111 of file sch_symbol.h.

{ }

Member Function Documentation

AddConnectionTo()

void SCH_ITEM::AddConnectionTo ( const SCH_SHEET_PATH &  aPath, SCH_ITEM *  aItem  )

inherited

Add a connection link between this item and another.

Definition at line 170 of file sch_item.cpp.

{
    m_connected_items[ aSheet ].insert( aItem );
}

References SCH_ITEM::m_connected_items.

Referenced by SCH_TEXT::UpdateDanglingState().

AddField()

SCH_FIELD * SCH_SYMBOL::AddField

(

const SCH_FIELD &

aField

)

Add a field to the symbol.

Parameters

aField

is the field to add to this symbol.

Returns

the newly inserted field.

Definition at line 712 of file sch_symbol.cpp.

{
    int newNdx = m_fields.size();

    m_fields.push_back( aField );
    return &m_fields[newNdx];
}

References m_fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_ALTIUM_PLUGIN::ParseParameter(), DIALOG_CHANGE_SYMBOLS::processSymbol(), and UpdateFields().

AddHierarchicalReference()

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

Add a full hierarchical reference to this symbol.

Parameters

aPath	is the hierarchical path (/&ltsheet timestamp&gt/&ltsymbol timestamp&gt like /05678E50/A23EF560).
aRef	is the local reference like C45, R56.
aUnit	is the unit selection used for symbols with multiple units per package.
aValue	is the value used for this instance.
aFootprint	is the footprint used for this instance (which might have different hole spacing or other board-specific changes from other instances).

Definition at line 391 of file sch_symbol.cpp.

{
    // Search for an existing path and remove it if found (should not occur)
    for( unsigned ii = 0; ii < m_instanceReferences.size(); ii++ )
    {
        if( m_instanceReferences[ii].m_Path == aPath )
        {
            wxLogTrace( traceSchSheetPaths, "Removing symbol instance:\n"
                                            "  sheet path %s\n"
                                            "  reference %s, unit %d from symbol %s.",
                                            aPath.AsString(),
                                            m_instanceReferences[ii].m_Reference,
                                            m_instanceReferences[ii].m_Unit,
                                            m_Uuid.AsString() );

            m_instanceReferences.erase( m_instanceReferences.begin() + ii );
            ii--;
        }
    }

    SYMBOL_INSTANCE_REFERENCE instance;
    instance.m_Path = aPath;
    instance.m_Reference = aRef;
    instance.m_Unit = aUnit;
    instance.m_Value = aValue;
    instance.m_Footprint = aFootprint;

    wxLogTrace( traceSchSheetPaths, "Adding symbol instance:\n"
                                    "  sheet path %s\n"
                                    "  reference %s, unit %d to symbol %s.",
                                    aPath.AsString(),
                                    aRef,
                                    aUnit,
                                    m_Uuid.AsString() );

    m_instanceReferences.push_back( instance );
}

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

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

AddSheetPathReferenceEntryIfMissing()

bool SCH_SYMBOL::AddSheetPathReferenceEntryIfMissing

(

const KIID_PATH &

aSheetPath

)

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

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

Parameters

aSheetPath

is the candidate sheet path of the sheet containing the symbol not the full symbol sheet path.

Returns

false if the alternate reference was existing, true if added.

Definition at line 1048 of file sch_symbol.cpp.

{
    // a empty sheet path is illegal:
    wxCHECK( aSheetPath.size() > 0, false );

    wxString reference_path;

    for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
    {
        // if aSheetPath is found, nothing to do:
        if( instance.m_Path == aSheetPath )
            return false;
    }

    // This entry does not exist: add it, with its last-used reference
    AddHierarchicalReference( aSheetPath, m_fields[REFERENCE_FIELD].GetText(), m_unit );
    return true;
}

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

Referenced by SCH_SCREEN::EnsureAlternateReferencesExist().

AutoAutoplaceFields()

void SCH_ITEM::AutoAutoplaceFields ( SCH_SCREEN *  aScreen )

inlineinherited

Autoplace fields only if correct to do so automatically.

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

Parameters

aScreen

is the SCH_SCREEN associated with the current instance of the symbol.

Definition at line 445 of file sch_item.h.

    {
        if( GetFieldsAutoplaced() )
            AutoplaceFields( aScreen, GetFieldsAutoplaced() == FIELDS_AUTOPLACED_MANUAL );
    }

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

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

AutoplaceFields()

void SCH_SYMBOL::AutoplaceFields ( SCH_SCREEN *  aScreen, bool  aManual  )

overridevirtual

Automatically orient all the fields in the symbol.

Parameters

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

Reimplemented from SCH_ITEM.

Definition at line 677 of file autoplace_fields.cpp.

{
    if( aManual )
        wxASSERT_MSG( aScreen, "A SCH_SCREEN pointer must be given for manual autoplacement" );

    AUTOPLACER autoplacer( this, aScreen );
    autoplacer.DoAutoplace( aManual );
    m_fieldsAutoplaced = ( aManual ? FIELDS_AUTOPLACED_MANUAL : FIELDS_AUTOPLACED_AUTO );
}

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

Referenced by SCH_DRAWING_TOOLS::PlaceSymbol().

CanConnect()

bool SCH_SYMBOL::CanConnect ( const SCH_ITEM *  aItem ) const

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 599 of file sch_symbol.h.

    {
        return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
                ( aItem->Type() == SCH_NO_CONNECT_T ) ||
                ( aItem->Type() == SCH_JUNCTION_T ) ||
                ( aItem->Type() == SCH_SYMBOL_T ) ||
                ( aItem->Type() == SCH_LABEL_T ) ||
                ( aItem->Type() == SCH_HIER_LABEL_T ) ||
                ( aItem->Type() == SCH_GLOBAL_LABEL_T );
    }

References SCH_ITEM::GetLayer(), LAYER_WIRE, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_SYMBOL_T, and EDA_ITEM::Type().

ClassOf()

static bool SCH_SYMBOL::ClassOf ( const EDA_ITEM *  aItem )

inlinestatic

Definition at line 113 of file sch_symbol.h.

    {
        return aItem && SCH_SYMBOL_T == aItem->Type();
    }

References SCH_SYMBOL_T, and EDA_ITEM::Type().

ClearAnnotation()

void SCH_SYMBOL::ClearAnnotation

(

const SCH_SHEET_PATH *

aSheetPath

)

Clear exiting symbol annotation.

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

Parameters

aSheetPath

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

Definition at line 1016 of file sch_symbol.cpp.

{
    // Build a reference with no annotation, i.e. a reference ending with a single '?'
    wxString defRef = UTIL::GetRefDesUnannotated( m_prefix );

    if( aSheetPath )
    {
        KIID_PATH path = aSheetPath->Path();

        for( SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
        {
            if( instance.m_Path == path )
                instance.m_Reference = defRef;
        }
    }
    else
    {
        for( SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
            instance.m_Reference = defRef;
    }

    for( std::unique_ptr<SCH_PIN>& pin : m_pins )
        pin->ClearDefaultNetName( aSheetPath );

    // These 2 changes do not work in complex hierarchy.
    // When a clear annotation is made, the calling function must call a
    // UpdateAllScreenReferences for the active sheet.
    // But this call cannot made here.
    m_fields[REFERENCE_FIELD].SetText( defRef ); //for drawing.
}

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

Referenced by SCH_SCREEN::ClearAnnotation(), SCH_EDIT_FRAME::DeleteAnnotation(), and SCH_EDITOR_CONTROL::updatePastedSymbol().

ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 133 of file eda_item.h.

{ ClearFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

ClearBrightenedPins()

void SCH_SYMBOL::ClearBrightenedPins

(

)

Definition at line 1874 of file sch_symbol.cpp.

{
    for( auto& pin : m_pins )
        pin->ClearBrightened();
}

References m_pins, and pin.

Referenced by SCH_EDITOR_CONTROL::UpdateNetHighlighting().

ClearConnections()

void SCH_ITEM::ClearConnections ( )

inlineinherited

Clears all of the connection items from the list.

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

Definition at line 385 of file sch_item.h.

{ m_connections.clear(); }

References SCH_ITEM::m_connections.

ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 172 of file eda_item.h.

    {
        ClearFlags( GetEditFlags() );
    }

References EDA_ITEM::ClearFlags(), and EDA_ITEM::GetEditFlags().

Referenced by FOOTPRINT::Add(), BOARD::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )

inlineinherited

Definition at line 436 of file sch_item.h.

{ m_fieldsAutoplaced = FIELDS_AUTOPLACED_NO; }

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

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

ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS  aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 154 of file eda_item.h.

{ m_flags &= ~aMask; }

References EDA_ITEM::m_flags.

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

ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 132 of file eda_item.h.

{ ClearFlags( SELECTED ); }

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL::LIB_SYMBOL(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 166 of file eda_item.h.

    {
        ClearFlags( STARTPOINT | ENDPOINT | CANDIDATE | TEMP_SELECTED | IS_LINKED | SKIP_STRUCT |
                    DO_NOT_DRAW );
    }

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 148 of file view_item.h.

    {
        m_viewPrivData = nullptr;
    }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

Clone()

EDA_ITEM * SCH_SYMBOL::Clone ( ) const

overridevirtual

Create a duplicate of this item with linked list members set to NULL.

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

Returns

A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 214 of file sch_symbol.cpp.

{
    return new SCH_SYMBOL( *this );
}

References SCH_SYMBOL().

ConnectedItems()

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

inherited

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

Definition at line 164 of file sch_item.cpp.

{
    return m_connected_items[ aSheet ];
}

References SCH_ITEM::m_connected_items.

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

Connection()

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

inherited

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

Note

The returned value can be nullptr.

Definition at line 131 of file sch_item.cpp.

{
    if( !aSheet )
        aSheet = &Schematic()->CurrentSheet();

    auto it = m_connection_map.find( *aSheet );

    if( it == m_connection_map.end() )
        return nullptr;
    else
        return it->second;
}

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

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

ConnectionPropagatesTo()

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

inlinevirtualinherited

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

Reimplemented in SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 422 of file sch_item.h.

{ return true; }

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

DoHypertextMenu()

virtual void SCH_ITEM::DoHypertextMenu ( EDA_DRAW_FRAME *  aFrame )

inlinevirtualinherited

Reimplemented in SCH_FIELD.

Definition at line 267 of file sch_item.h.

{ }

doIsConnected()

bool SCH_SYMBOL::doIsConnected ( const wxPoint &  aPosition ) const

overrideprivatevirtual

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

Note

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

Parameters

aPosition

is a reference to a wxPoint object containing the test position.

Returns

True if connection to aPosition exists.

Reimplemented from SCH_ITEM.

Definition at line 1811 of file sch_symbol.cpp.

{
    wxPoint new_pos = m_transform.InverseTransform().TransformCoordinate( aPosition - m_pos );

    for( const auto& pin : m_pins )
    {
        if( pin->GetType() == ELECTRICAL_PINTYPE::PT_NC )
            continue;

        // Collect only pins attached to the current unit and convert.
        // others are not associated to this symbol instance
        int pin_unit = pin->GetLibPin()->GetUnit();
        int pin_convert = pin->GetLibPin()->GetConvert();

        if( pin_unit > 0 && pin_unit != GetUnit() )
            continue;

        if( pin_convert > 0 && pin_convert != GetConvert() )
            continue;

        if( pin->GetLocalPosition() == new_pos )
            return true;
    }

    return false;
}

References GetConvert(), GetUnit(), TRANSFORM::InverseTransform(), m_pins, m_pos, m_transform, pin, PT_NC, and TRANSFORM::TransformCoordinate().

Duplicate()

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

inherited

Routine to create a new copy of given item.

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

Parameters

doClone

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

Definition at line 78 of file sch_item.cpp.

{
    SCH_ITEM* newItem = (SCH_ITEM*) Clone();

    if( !doClone )
        const_cast<KIID&>( newItem->m_Uuid ) = KIID();

    newItem->ClearFlags( SELECTED | BRIGHTENED );

    newItem->RunOnChildren(
            []( SCH_ITEM* aChild )
            {
                aChild->ClearFlags( SELECTED | BRIGHTENED );
            } );

    return newItem;
}

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

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

FindField()

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

Search for a SCH_FIELD with aFieldName.

Parameters

aFieldName	is the name of the field to find.
aIncludeDefaultFields	searches the library symbol default fields if true.

Returns

the field if found or NULL if the field was not found.

Definition at line 734 of file sch_symbol.cpp.

{
    unsigned start = aIncludeDefaultFields ? 0 : MANDATORY_FIELDS;

    for( unsigned i = start; i < m_fields.size(); ++i )
    {
        if( aFieldName == m_fields[i].GetName( false ) )
            return &m_fields[i];
    }

    return nullptr;
}

References m_fields, and MANDATORY_FIELDS.

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

Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 86 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
        return object ? aProperty->getter( object ) : wxAny();
    }

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

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

Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 95 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
        return object ? aProperty->get<T>( object ) : T();
    }

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

Get() [3/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
        boost::optional<T> ret = T();

        if( prop )
        {
            void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );

            if( object )
                ret = prop->get<T>( object );
        }

        return ret;
    }

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

GetBodyBoundingBox()

EDA_RECT SCH_SYMBOL::GetBodyBoundingBox

(

)

const

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

Definition at line 1292 of file sch_symbol.cpp.

{
    EDA_RECT    bBox;

    if( m_part )
        bBox = m_part->GetBodyBoundingBox( m_unit, m_convert );
    else
        bBox = dummy()->GetBodyBoundingBox( m_unit, m_convert );

    int x0 = bBox.GetX();
    int xm = bBox.GetRight();

    // We must reverse Y values, because matrix orientation
    // suppose Y axis normal for the library items coordinates,
    // m_transform reverse Y values, but bBox is already reversed!
    int y0 = -bBox.GetY();
    int ym = -bBox.GetBottom();

    // Compute the real Boundary box (rotated, mirrored ...)
    int x1 = m_transform.x1 * x0 + m_transform.y1 * y0;
    int y1 = m_transform.x2 * x0 + m_transform.y2 * y0;
    int x2 = m_transform.x1 * xm + m_transform.y1 * ym;
    int y2 = m_transform.x2 * xm + m_transform.y2 * ym;

    bBox.SetX( x1 );
    bBox.SetY( y1 );
    bBox.SetWidth( x2 - x1 );
    bBox.SetHeight( y2 - y1 );
    bBox.Normalize();

    bBox.Offset( m_pos );
    return bBox;
}

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

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

GetBoundingBox() [1/2]

const EDA_RECT SCH_SYMBOL::GetBoundingBox ( ) const

overridevirtual

Return the orthogonal bounding box of this object for display purposes.

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

Reimplemented from EDA_ITEM.

Definition at line 1327 of file sch_symbol.cpp.

{
    EDA_RECT bbox = GetBodyBoundingBox();

    for( const SCH_FIELD& field : m_fields )
    {
        if( field.IsVisible() )
            bbox.Merge( field.GetBoundingBox() );
    }

    return bbox;
}

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

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

GetBoundingBox() [2/2]

const EDA_RECT SCH_SYMBOL::GetBoundingBox

(

bool

aIncludeInvisibleText

)

const

Definition at line 1341 of file sch_symbol.cpp.

{
    EDA_RECT bbox = GetBodyBoundingBox();

    for( const SCH_FIELD& field : m_fields )
    {
        if( field.IsVisible() || aIncludeInvisibleText )
            bbox.Merge( field.GetBoundingBox() );
    }

    return bbox;
}

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

GetClass()

wxString SCH_SYMBOL::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 118 of file sch_symbol.h.

    {
        return wxT( "SCH_SYMBOL" );
    }

Referenced by operator=().

GetConnectionPoints()

std::vector< wxPoint > SCH_SYMBOL::GetConnectionPoints ( ) const

overridevirtual

Add all the connection points for this item to aPoints.

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

Parameters

aPoints

is the list of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 1583 of file sch_symbol.cpp.

{
    std::vector<wxPoint> retval;

    for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
    {
        // Collect only pins attached to the current unit and convert.
        // others are not associated to this symbol instance
        int pin_unit = pin->GetLibPin()->GetUnit();
        int pin_convert = pin->GetLibPin()->GetConvert();

        if( pin_unit > 0 && pin_unit != GetUnit() )
            continue;

        if( pin_convert > 0 && pin_convert != GetConvert() )
            continue;

        retval.push_back( m_transform.TransformCoordinate( pin->GetLocalPosition() ) + m_pos );
    }

    return retval;
}

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

GetContextualTextVars()

void SCH_SYMBOL::GetContextualTextVars

(

wxArrayString *

aVars

)

const

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

Definition at line 919 of file sch_symbol.cpp.

{
    for( int i = 0; i < MANDATORY_FIELDS; ++i )
        aVars->push_back( m_fields[i].GetCanonicalName().Upper() );

    for( size_t i = MANDATORY_FIELDS; i < m_fields.size(); ++i )
        aVars->push_back( m_fields[i].GetName() );

    aVars->push_back( wxT( "FOOTPRINT_LIBRARY" ) );
    aVars->push_back( wxT( "FOOTPRINT_NAME" ) );
    aVars->push_back( wxT( "UNIT" ) );
}

References m_fields, and MANDATORY_FIELDS.

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

GetConvert()

int SCH_SYMBOL::GetConvert ( ) const

inline

Definition at line 223 of file sch_symbol.h.

{ return m_convert; }

References m_convert.

Referenced by SCH_EDIT_TOOL::ConvertDeMorgan(), SCH_EDIT_FRAME::ConvertPart(), doIsConnected(), KIGFX::SCH_PAINTER::draw(), GetConnectionPoints(), SCH_SCREEN::GetPin(), IsPointClickableAnchor(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), Plot(), SCH_EDIT_TOOL::Properties(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), and Visit().

GetDatasheet()

wxString SCH_SYMBOL::GetDatasheet

(

)

const

Return the documentation text for the given part alias.

Definition at line 266 of file sch_symbol.cpp.

{
    if( m_part )
        return m_part->GetDatasheetField().GetText();

    return wxEmptyString;
}

References m_part.

Referenced by UpdateFields().

GetDescription()

wxString SCH_SYMBOL::GetDescription

(

)

const

Return information about the aliased parts.

Definition at line 257 of file sch_symbol.cpp.

{
    if( m_part )
        return m_part->GetDescription();

    return wxEmptyString;
}

References m_part.

Referenced by NETLIST_EXPORTER_XML::makeSymbols().

GetDrawItem()

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

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

Parameters

aPosition	is the schematic position of the symbol library object.
aType	is the type of symbol library object to find or any if set to TYPE_NOT_INIT.

Returns

is the symbol library object if found otherwise NULL.

Definition at line 1607 of file sch_symbol.cpp.

{
    if( m_part )
    {
        // Calculate the position relative to the symbol.
        wxPoint libPosition = aPosition - m_pos;

        return m_part->LocateDrawItem( m_unit, m_convert, aType, libPosition, m_transform );
    }

    return nullptr;
}

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

Referenced by SCH_SCREEN::GetPin().

GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 158 of file eda_item.h.

    {
        constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
                               | IS_WIRE_IMAGE | STRUCT_DELETED );

        return m_flags & mask;
    }

References IS_DRAGGING, IS_MOVING, IS_NEW, IS_PASTED, IS_RESIZING, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

GetEndPoints()

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

overridevirtual

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

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

Parameters

aItemList

is the list of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 1508 of file sch_symbol.cpp.

{
    for( auto& pin : m_pins )
    {
        LIB_PIN* lib_pin = pin->GetLibPin();

        if( lib_pin->GetUnit() && m_unit && ( m_unit != lib_pin->GetUnit() ) )
            continue;

        DANGLING_END_ITEM item( PIN_END, lib_pin, GetPinPhysicalPosition( lib_pin ), this );
        aItemList.push_back( item );
    }
}

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

GetField() [1/2]

SCH_FIELD * SCH_SYMBOL::GetField

(

MANDATORY_FIELD_T

aFieldType

)

Return a mandatory field in this symbol.

Note

If you need to fetch a user field, use GetFieldById.

Parameters

aFieldType

is one of the mandatory field types (REFERENCE_FIELD, VALUE_FIELD, etc.).

Returns

is the field at aFieldType or NULL if the field does not exist.

Definition at line 666 of file sch_symbol.cpp.

{
    return &m_fields[aFieldType];
}

References m_fields.

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), NETLIST_EXPORTER_XML::addSymbolFields(), SIM_PLOT_FRAME::AddTuner(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_EDIT_TOOL::EditField(), FormatProbeItem(), GetFootprint(), GetRef(), GetSelectMenuText(), NETLIST_EXPORTER_PSPICE::GetSpiceFieldDefVal(), GetValue(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), TUNER_SLIDER::onSave(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), SCH_LEGACY_PLUGIN::saveSymbol(), SetRef(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_SHEET::SymbolCount(), TUNER_SLIDER::TUNER_SLIDER(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_EDITOR_CONTROL::updatePastedSymbol(), SCH_SHEET_LIST::UpdateSymbolInstances(), Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

GetField() [2/2]

const SCH_FIELD * SCH_SYMBOL::GetField

(

MANDATORY_FIELD_T

aFieldNdx

)

const

Definition at line 672 of file sch_symbol.cpp.

{
    return &m_fields[aFieldType];
}

References m_fields.

GetFieldById()

SCH_FIELD * SCH_SYMBOL::GetFieldById

(

int

aFieldId

)

Return a field in this symbol.

Parameters

aFieldId

is the id of the field requested. Note that this id ONLY SOMETIMES equates to the field's position in the vector.

Returns

is the field at aFieldType or NULL if the field does not exist.

Definition at line 678 of file sch_symbol.cpp.

{
    for( size_t ii = 0; ii < m_fields.size(); ++ii )
    {
        if( m_fields[ii].GetId() == aFieldId )
            return &m_fields[ii];
    }

    return nullptr;
}

References m_fields.

Referenced by SCH_SYMBOL(), and UpdateFields().

GetFieldCount()

int SCH_SYMBOL::GetFieldCount ( ) const

inline

Return the number of fields in this symbol.

Definition at line 421 of file sch_symbol.h.

{ return (int)m_fields.size(); }

References m_fields.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), operator==(), SCH_ALTIUM_PLUGIN::ParseParameter(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), UpdateFields(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

GetFields() [1/3]

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

Populate a std::vector with SCH_FIELDs.

Parameters

aVector	is the vector to populate.
aVisibleOnly	is used to add only the fields that are visible and contain text.

Definition at line 702 of file sch_symbol.cpp.

{
    for( SCH_FIELD& field : m_fields )
    {
        if( !aVisibleOnly || ( field.IsVisible() && !field.IsVoid() ) )
            aVector.push_back( &field );
    }
}

References m_fields.

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

GetFields() [2/3]

std::vector<SCH_FIELD>& SCH_SYMBOL::GetFields ( )

inline

Return a vector of fields from the symbol.

Definition at line 366 of file sch_symbol.h.

{ return m_fields; }

References m_fields.

Referenced by operator==().

GetFields() [3/3]

const std::vector<SCH_FIELD>& SCH_SYMBOL::GetFields ( ) const

inline

Definition at line 367 of file sch_symbol.h.

{ return m_fields; }

References m_fields.

GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const

inlineinherited

Return whether the fields have been automatically placed.

Definition at line 433 of file sch_item.h.

{ return m_fieldsAutoplaced; }

References SCH_ITEM::m_fieldsAutoplaced.

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

GetFieldText()

wxString SCH_SYMBOL::GetFieldText	(	const wxString &	aFieldName,
		SCH_EDIT_FRAME *	aFrame
	)		const

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

Parameters

aFieldName

is the name of the field

Definition at line 690 of file sch_symbol.cpp.

{
    for( const SCH_FIELD& field : m_fields )
    {
        if( aFieldName == field.GetName() || aFieldName == field.GetCanonicalName() )
            return field.GetText();
    }

    return wxEmptyString;
}

References m_fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn().

GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 155 of file eda_item.h.

{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), insideArea(), BOARD_INSPECTION_TOOL::InspectConstraints(), LIB_SYMBOL::LIB_SYMBOL(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 259 of file eda_item.h.

{ return GetPosition(); }

References EDA_ITEM::GetPosition().

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

GetFootprint()

const wxString SCH_SYMBOL::GetFootprint	(	const SCH_SHEET_PATH *	sheet,
		bool	aResolve
	)		const

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

Definition at line 615 of file sch_symbol.cpp.

{
    KIID_PATH path = sheet->Path();

    for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
    {
        if( instance.m_Path == path && !instance.m_Footprint.IsEmpty() )
        {
            // This can only be an override from an Update Schematic from PCB, and therefore
            // will always be fully resolved.
            return instance.m_Footprint;
        }
    }

    if( !aResolve )
        return GetField( FOOTPRINT_FIELD )->GetText();

    return GetField( FOOTPRINT_FIELD )->GetShownText();
}

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

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

GetIncludeInBom()

bool SCH_SYMBOL::GetIncludeInBom ( ) const

inline

Definition at line 659 of file sch_symbol.h.

{ return m_inBom; }

References m_inBom.

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

GetIncludeOnBoard()

bool SCH_SYMBOL::GetIncludeOnBoard ( ) const

inline

Definition at line 662 of file sch_symbol.h.

{ return m_onBoard; }

References m_onBoard.

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

GetInstanceReferences()

const std::vector<SYMBOL_INSTANCE_REFERENCE>& SCH_SYMBOL::GetInstanceReferences ( )

inline

Definition at line 123 of file sch_symbol.h.

    {
        return m_instanceReferences;
    }

References m_instanceReferences.

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

GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 272 of file sch_item.h.

{ return m_layer; }

References SCH_ITEM::m_layer.

Referenced by SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_ITEM::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), CanConnect(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LINE::GetEndPoints(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_EDIT_TOOL::Init(), SCH_LINE::IsBus(), SCH_LINE::IsGraphicLine(), SCH_SCREEN::IsJunctionNeeded(), SCH_LINE::IsWire(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_TEXT::operator<(), SCH_LINE::operator<(), SCH_JUNCTION::Plot(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_LINE::Plot(), SCH_SCREEN::Plot(), SCH_JUNCTION::Print(), SCH_LINE::Print(), SCH_SCREEN::Print(), SCH_LEGACY_PLUGIN::saveBusEntry(), SCH_SEXPR_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveText(), SCH_EDIT_FRAME::SchematicCleanUp(), and SCH_EDIT_FRAME::TrimWire().

GetLibId()

const LIB_ID& SCH_SYMBOL::GetLibId ( ) const

inline

Definition at line 147 of file sch_symbol.h.

{ return m_lib_id; }

References m_lib_id.

Referenced by SCH_SCREEN::Append(), CollectOtherUnits(), SCH_REFERENCE::CompareLibName(), SCH_EDIT_FRAME::CreateArchiveLibrary(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_SEXPR_PLUGIN::Format(), SCH_SCREENS::GetLibNicknames(), GetMsgPanelInfo(), GetSelectMenuText(), SYMBOL_CANDIDATE::GetStringLibId(), SCH_SCREENS::HasNoFullyDefinedLibIds(), DIALOG_CHANGE_SYMBOLS::isMatch(), NETLIST_EXPORTER_XML::makeSymbols(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_TOOL::Properties(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_EDIT_FRAME::SelectUnit(), sort_by_libid(), SYMBOL_CANDIDATE::SYMBOL_CANDIDATE(), ERC_TESTER::TestLibSymbolIssues(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and DIALOG_CHANGE_SYMBOLS::updateFieldsList().

GetLibPins()

void SCH_SYMBOL::GetLibPins

(

std::vector< LIB_PIN * > &

aPinsList

)

const

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

Parameters

aPinsList

is the list to populate with all of the pins.

Definition at line 843 of file sch_symbol.cpp.

{
    if( m_part )
        m_part->GetPins( aPinsList, m_unit, m_convert );
}

References m_convert, m_part, and m_unit.

GetLibSymbolRef() [1/2]

std::unique_ptr< LIB_SYMBOL >& SCH_SYMBOL::GetLibSymbolRef ( )

inline

Definition at line 164 of file sch_symbol.h.

{ return m_part; }

References m_part.

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_SHEET_LIST::AnnotatePowerSymbols(), SCH_SCREEN::Append(), SCH_SHEET_PATH::AppendMultiUnitSymbol(), SCH_SHEET_PATH::AppendSymbol(), SCH_EDIT_FRAME::ConvertPart(), NETLIST_EXPORTER_BASE::CreatePinList(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_SCREEN::GetPin(), NETLIST_EXPORTER_PSPICE::GetSpiceFieldDefVal(), SCH_FIELD::IsReplaceable(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), ERC_TESTER::TestLibSymbolIssues(), SYMBOL_UNIT_MENU::update(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

GetLibSymbolRef() [2/2]

const std::unique_ptr< LIB_SYMBOL >& SCH_SYMBOL::GetLibSymbolRef ( ) const

inline

Definition at line 165 of file sch_symbol.h.

{ return m_part; }

References m_part.

GetMenuImage()

BITMAPS SCH_SYMBOL::GetMenuImage ( ) const

overridevirtual

Return a pointer to an image to be used in menus.

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

Returns

The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 1438 of file sch_symbol.cpp.

{
    return BITMAPS::add_component;
}

References add_component.

GetMsgPanelInfo()

void SCH_SYMBOL::GetMsgPanelInfo ( EDA_DRAW_FRAME *  aFrame, std::vector< MSG_PANEL_ITEM > &  aList  )

overridevirtual

Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters

aList

is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 1355 of file sch_symbol.cpp.

{
    wxString msg;

    SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( aFrame );
    SCH_SHEET_PATH* currentSheet = schframe ? &schframe->GetCurrentSheet() : nullptr;

    // part and alias can differ if alias is not the root
    if( m_part )
    {
        if( m_part.get() != dummy() )
        {
            aList.push_back( MSG_PANEL_ITEM( _( "Reference" ), GetRef( currentSheet ) ) );

            msg = m_part->IsPower() ? _( "Power symbol" ) : _( "Value" );

            aList.push_back( MSG_PANEL_ITEM( msg, GetValue( currentSheet, true ) ) );

#if 0       // Display symbol flags, for debug only
            aList.push_back( MSG_PANEL_ITEM( _( "flags" ),
                                             wxString::Format( "%X", GetEditFlags() ) ) );
#endif

            // Display symbol reference in library and library
            aList.push_back( MSG_PANEL_ITEM( _( "Name" ),
                                             UnescapeString( GetLibId().GetLibItemName() ) ) );

            if( !m_part->IsRoot() )
            {
                msg = _( "Missing parent" );

                std::shared_ptr< LIB_SYMBOL > parent = m_part->GetParent().lock();

                if( parent )
                    msg = parent->GetName();

                aList.push_back( MSG_PANEL_ITEM( _( "Alias of" ), UnescapeString( msg ) ) );
            }
            else if( !m_lib_id.GetLibNickname().empty() )
            {
                aList.push_back( MSG_PANEL_ITEM( _( "Library" ), m_lib_id.GetLibNickname() ) );
            }
            else
            {
                aList.push_back( MSG_PANEL_ITEM( _( "Library" ), _( "Undefined!!!" ) ) );
            }

            // Display the current associated footprint, if exists.
            msg = GetFootprint( currentSheet, true );

            if( msg.IsEmpty() )
                msg = _( "<Unknown>" );

            aList.push_back( MSG_PANEL_ITEM( _( "Footprint" ), msg ) );

            // Display description of the symbol, and keywords found in lib
            aList.push_back( MSG_PANEL_ITEM( _( "Description" ), m_part->GetDescription(),
                                             DARKCYAN ) );
            aList.push_back( MSG_PANEL_ITEM( _( "Keywords" ), m_part->GetKeyWords() ) );
        }
    }
    else
    {
        aList.push_back( MSG_PANEL_ITEM( _( "Reference" ), GetRef( currentSheet ) ) );

        aList.push_back( MSG_PANEL_ITEM( _( "Value" ), GetValue( currentSheet, true ) ) );
        aList.push_back( MSG_PANEL_ITEM( _( "Name" ), GetLibId().GetLibItemName() ) );

        wxString libNickname = GetLibId().GetLibNickname();

        if( libNickname.empty() )
        {
            aList.push_back( MSG_PANEL_ITEM( _( "Library" ), _( "No library defined!" ) ) );
        }
        else
        {
            msg.Printf( _( "Symbol not found in %s!" ), libNickname );
            aList.push_back( MSG_PANEL_ITEM( _( "Library" ), msg ) );
        }
    }
}

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

GetOrientation()

int SCH_SYMBOL::GetOrientation

(

)

Get the display symbol orientation.

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

See also

SYMBOL_ORIENTATION_T

Returns

the orientation and mirror of the symbol.

Definition at line 1223 of file sch_symbol.cpp.

{
    int rotate_values[] =
    {
        SYM_ORIENT_0,
        SYM_ORIENT_90,
        SYM_ORIENT_180,
        SYM_ORIENT_270,
        SYM_MIRROR_X + SYM_ORIENT_0,
        SYM_MIRROR_X + SYM_ORIENT_90,
        SYM_MIRROR_X + SYM_ORIENT_270,
        SYM_MIRROR_Y,
        SYM_MIRROR_Y + SYM_ORIENT_0,
        SYM_MIRROR_Y + SYM_ORIENT_90,
        SYM_MIRROR_Y + SYM_ORIENT_180,
        SYM_MIRROR_Y + SYM_ORIENT_270
    };

    // Try to find the current transform option:
    TRANSFORM transform = m_transform;

    for( int type_rotate : rotate_values )
    {
        SetOrientation( type_rotate );

        if( transform == m_transform )
            return type_rotate;
    }

    // Error: orientation not found in list (should not happen)
    wxFAIL_MSG( "Schematic symbol orientation matrix internal error." );
    m_transform = transform;

    return SYM_NORMAL;
}

References m_transform, SetOrientation(), SYM_MIRROR_X, SYM_MIRROR_Y, SYM_NORMAL, SYM_ORIENT_0, SYM_ORIENT_180, SYM_ORIENT_270, and SYM_ORIENT_90.

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

GetParent()

EDA_ITEM* EDA_ITEM::GetParent ( void  ) const

inlineinherited

Definition at line 115 of file eda_item.h.

{ return m_parent; }

References EDA_ITEM::m_parent.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::editFieldText(), FormatProbeItem(), SCH_PIN::GetParentSymbol(), EE_SELECTION_TOOL::highlight(), highlightNet(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), EE_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), BOARD_COMMIT::parentObject(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshSelection(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN::saveField(), SCH_SCREEN::Schematic(), SCH_ITEM::Schematic(), SCH_SHEET::SearchHierarchy(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), EE_SELECTION_TOOL::unhighlight(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), and SCH_BASE_FRAME::UpdateItem().

GetPenWidth()

virtual int SCH_ITEM::GetPenWidth ( ) const

inlinevirtualinherited

Returns

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

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

Definition at line 289 of file sch_item.h.

{ return 0; }

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_BUS_ENTRY_BASE::GetBoundingBox(), KIGFX::SCH_PAINTER::getLineWidth(), SCH_PIN::HitTest(), SCH_BUS_ENTRY_BASE::HitTest(), SCH_BUS_ENTRY_BASE::Plot(), SCH_BUS_ENTRY_BASE::Print(), and DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataToWindow().

GetPin() [1/2]

SCH_PIN * SCH_SYMBOL::GetPin

(

const wxString &

number

)

const

Find a symbol pin by number.

Parameters

number

is the number of the pin to find.

Returns

Pin object if found, otherwise NULL.

Definition at line 831 of file sch_symbol.cpp.

{
    for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
    {
        if( pin->GetNumber() == aNumber )
            return pin.get();
    }

    return nullptr;
}

References m_pins, and pin.

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

GetPin() [2/2]

SCH_PIN * SCH_SYMBOL::GetPin

(

LIB_PIN *

aLibPin

)

Definition at line 850 of file sch_symbol.cpp.

{
    wxASSERT( m_pinMap.count( aLibPin ) );
    return m_pins[ m_pinMap.at( aLibPin ) ].get();
}

References m_pinMap, and m_pins.

GetPinPhysicalPosition()

wxPoint SCH_SYMBOL::GetPinPhysicalPosition

(

const LIB_PIN *

Pin

)

const

Definition at line 1574 of file sch_symbol.cpp.

{
    wxCHECK_MSG( Pin != nullptr && Pin->Type() == LIB_PIN_T, wxPoint( 0, 0 ),
                 wxT( "Cannot get physical position of pin." ) );

    return m_transform.TransformCoordinate( Pin->GetPosition() ) + m_pos;
}

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

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

GetPins()

std::vector< SCH_PIN * > SCH_SYMBOL::GetPins

(

const SCH_SHEET_PATH *

aSheet = nullptr

)

const

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

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

Returns

a vector of pointers (non-owning) to SCH_PINs

Definition at line 857 of file sch_symbol.cpp.

{
    std::vector<SCH_PIN*> pins;

    if( aSheet == nullptr )
    {
        wxCHECK_MSG( Schematic(), pins, "Can't call GetPins on a symbol with no schematic" );

        aSheet = &Schematic()->CurrentSheet();
    }

    int unit = GetUnitSelection( aSheet );

    for( const auto& p : m_pins )
    {
        if( unit && p->GetLibPin()->GetUnit() && ( p->GetLibPin()->GetUnit() != unit ) )
            continue;

        pins.push_back( p.get() );
    }

    return pins;
}

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

Referenced by NETLIST_EXPORTER_BASE::CreatePinList(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), SCH_EDITOR_CONTROL::nextMatch(), SCH_EDITOR_CONTROL::Paste(), AUTOPLACER::pinsOnSide(), SCH_SEXPR_PLUGIN::saveSymbol(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), ERC_TESTER::TestNoConnectPins(), CONNECTION_GRAPH::updateItemConnectivity(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

GetPosition()

wxPoint SCH_SYMBOL::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 641 of file sch_symbol.h.

{ return m_pos; }

References m_pos.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), KIGFX::SCH_PAINTER::draw(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_FIELD::GetPosition(), GetRelativePosition(), SCH_PIN::GetTransformedPosition(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), DIALOG_ERC::OnRunERCClick(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_REFERENCE::SCH_REFERENCE(), SCH_FIELD::SetPosition(), ERC_TESTER::TestLibSymbolIssues(), ERC_TESTER::TestMultiunitFootprints(), ERC_TESTER::TestTextVars(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

GetPrefix()

wxString SCH_SYMBOL::GetPrefix ( ) const

inline

Definition at line 227 of file sch_symbol.h.

{ return m_prefix; }

References m_prefix.

Referenced by SCH_LEGACY_PLUGIN::saveSymbol().

GetRawPins()

std::vector<std::unique_ptr<SCH_PIN> >& SCH_SYMBOL::GetRawPins ( )

inline

Definition at line 467 of file sch_symbol.h.

{ return m_pins; }

References m_pins.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

GetRef()

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

Return the reference for the given sheet path.

Returns

the reference for the sheet.

Definition at line 432 of file sch_symbol.cpp.

{
    KIID_PATH path = sheet->Path();
    wxString  ref;

    for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
    {
        if( instance.m_Path == path )
        {
            ref = instance.m_Reference;
            break;
        }
    }

    // If it was not found in m_Paths array, then see if it is in m_Field[REFERENCE] -- if so,
    // use this as a default for this path.  This will happen if we load a version 1 schematic
    // file.  It will also mean that multiple instances of the same sheet by default all have
    // the same symbol references, but perhaps this is best.
    if( ref.IsEmpty() && !GetField( REFERENCE_FIELD )->GetText().IsEmpty() )
    {
        const_cast<SCH_SYMBOL*>( this )->SetRef( sheet, GetField( REFERENCE_FIELD )->GetText() );
        ref = GetField( REFERENCE_FIELD )->GetText();
    }

    if( ref.IsEmpty() )
        ref = UTIL::GetRefDesUnannotated( m_prefix );

    if( aIncludeUnit && GetUnitCount() > 1 )
        ref += LIB_SYMBOL::SubReference( GetUnit() );

    return ref;
}

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

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

GetSchSymbolLibraryName()

wxString SCH_SYMBOL::GetSchSymbolLibraryName

(

)

const

Definition at line 239 of file sch_symbol.cpp.

{
    if( !m_schLibSymbolName.IsEmpty() )
        return m_schLibSymbolName;
    else
        return m_lib_id.Format();
}

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

Referenced by SCH_SCREEN::Append(), NETLIST_EXPORTER_BASE::findNextSymbol(), SCH_SEXPR_PLUGIN::Format(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDITOR_CONTROL::Paste(), SCH_SCREEN::Remove(), SCH_SEXPR_PLUGIN::saveSymbol(), and SCH_SCREEN::SwapSymbolLinks().

GetSelectMenuText()

wxString SCH_SYMBOL::GetSelectMenuText ( EDA_UNITS  aUnits ) const

overridevirtual

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

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

Returns

The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 1621 of file sch_symbol.cpp.

{
    return wxString::Format( _( "Symbol %s [%s]" ),
                             GetField( REFERENCE_FIELD )->GetShownText(),
                             GetLibId().GetLibItemName().wx_str() );
}

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

Referenced by Matches().

GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS  type ) const

inlineinherited

Definition at line 137 of file eda_item.h.

    {
        return m_status & type;
    }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 150 of file eda_item.h.

{ return m_status; }

References EDA_ITEM::m_status.

GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 235 of file sch_item.h.

{ return m_storedPos; }

References SCH_ITEM::m_storedPos.

GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const

inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 464 of file sch_item.h.

{ wxCHECK( false, STROKE_PARAMS() ); }

Referenced by DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataToWindow().

GetTransform() [1/2]

TRANSFORM& SCH_SYMBOL::GetTransform ( )

inline

Definition at line 231 of file sch_symbol.h.

{ return m_transform; }

References m_transform.

Referenced by AUTOPLACER::computeFBoxSize(), SCH_PIN::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), AUTOPLACER::getPinSide(), SCH_FIELD::GetPosition(), GetRelativePosition(), SCH_PIN::GetTransformedPosition(), SCH_MOVE_TOOL::moveItem(), SCH_FIELD::Plot(), Plot(), SCH_FIELD::Print(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_FIELD::SetPosition(), and ERC_TESTER::TestTextVars().

GetTransform() [2/2]

const TRANSFORM& SCH_SYMBOL::GetTransform ( ) const

inline

Definition at line 232 of file sch_symbol.h.

{ return m_transform; }

References m_transform.

GetUnit()

int SCH_SYMBOL::GetUnit ( ) const

inline

Definition at line 195 of file sch_symbol.h.

{ return m_unit; }

References m_unit.

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), doIsConnected(), KIGFX::SCH_PAINTER::draw(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), GetConnectionPoints(), SCH_SCREEN::GetPin(), GetRef(), SCH_FIELD::GetShownText(), IsPointClickableAnchor(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCH_FIELD::Matches(), SCH_DRAWING_TOOLS::PlaceSymbol(), Plot(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_TOOL::Properties(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), SYMBOL_UNIT_MENU::update(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and Visit().

GetUnitCount()

int SCH_SYMBOL::GetUnitCount

(

void

)

const

Return the number of units per package of the symbol.

Returns

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

Definition at line 361 of file sch_symbol.cpp.

{
    if( m_part )
        return m_part->GetUnitCount();

    return 0;
}

References m_part.

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

GetUnitSelection()

int SCH_SYMBOL::GetUnitSelection

(

const SCH_SHEET_PATH *

aSheet

)

const

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

Definition at line 522 of file sch_symbol.cpp.

{
    KIID_PATH path = aSheet->Path();

    for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
    {
        if( instance.m_Path == path )
            return instance.m_Unit;
    }

    // If it was not found in m_Paths array, then use m_unit.  This will happen if we load a
    // version 1 schematic file.
    return m_unit;
}

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

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

GetValue()

const wxString SCH_SYMBOL::GetValue	(	const SCH_SHEET_PATH *	sheet,
		bool	aResolve
	)		const

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

Definition at line 564 of file sch_symbol.cpp.

{
    KIID_PATH path = sheet->Path();

    for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
    {
        if( instance.m_Path == path && !instance.m_Value.IsEmpty() )
        {
            // This can only be an override from an Update Schematic from PCB, and therefore
            // will always be fully resolved.
            return instance.m_Value;
        }
    }

    if( !aResolve )
        return GetField( VALUE_FIELD )->GetText();

    return GetField( VALUE_FIELD )->GetShownText();
}

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

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

HasBrightenedPins()

bool SCH_SYMBOL::HasBrightenedPins

(

)

Definition at line 1862 of file sch_symbol.cpp.

{
    for( const auto& pin : m_pins )
    {
        if( pin->IsBrightened() )
            return true;
    }

    return false;
}

References m_pins, and pin.

Referenced by SCH_EDITOR_CONTROL::UpdateNetHighlighting().

HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS  aFlag ) const

inlineinherited

Definition at line 156 of file eda_item.h.

{ return ( m_flags & aFlag ) == aFlag; }

References EDA_ITEM::m_flags.

Referenced by TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupSegments(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::moveItem(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList().

HasLineStroke()

virtual bool SCH_ITEM::HasLineStroke ( ) const

inlinevirtualinherited

Check if this schematic item has line stoke properties.

See also

STROKE_PARAMS

Returns

true if this schematic item support line stroke properties. Otherwise, false.

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 462 of file sch_item.h.

{ return false; }

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

HitTest() [1/2]

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

overridevirtual

Test if aPosition is contained within or on the bounding box of an item.

Parameters

aPosition	A reference to a wxPoint object containing the coordinates to test.
aAccuracy	Increase the item bounding box by this amount.

Returns

True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 1783 of file sch_symbol.cpp.

{
    EDA_RECT bBox = GetBodyBoundingBox();
    bBox.Inflate( aAccuracy );

    if( bBox.Contains( aPosition ) )
        return true;

    return false;
}

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

HitTest() [2/2]

bool SCH_SYMBOL::HitTest ( const EDA_RECT &  aRect, bool  aContained, int  aAccuracy = 0  ) const

overridevirtual

Test if aRect intersects or is contained within the bounding box of an item.

Parameters

aRect	A reference to a EDA_RECT object containing the rectangle to test.
aContained	Set to true to test for containment instead of an intersection.
aAccuracy	Increase aRect by this amount.

Returns

True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 1795 of file sch_symbol.cpp.

{
    if( m_flags & STRUCT_DELETED || m_flags & SKIP_STRUCT )
        return false;

    EDA_RECT rect = aRect;

    rect.Inflate( aAccuracy );

    if( aContained )
        return rect.Contains( GetBodyBoundingBox() );

    return rect.Intersects( GetBodyBoundingBox() );
}

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

Init()

void SCH_SYMBOL::Init ( const wxPoint &  pos = wxPoint( 0, 0 ) )

private

Definition at line 185 of file sch_symbol.cpp.

{
    m_pos     = pos;
    m_unit    = 1;  // In multi unit chip - which unit to draw.
    m_convert = LIB_ITEM::LIB_CONVERT::BASE;  // De Morgan Handling

    // The rotation/mirror transformation matrix. pos normal
    m_transform = TRANSFORM();

    // construct only the mandatory fields, which are the first 4 only.
    for( int i = 0; i < MANDATORY_FIELDS; ++i )
    {
        m_fields.emplace_back( pos, i, this, TEMPLATE_FIELDNAME::GetDefaultFieldName( i ) );

        if( i == REFERENCE_FIELD )
            m_fields.back().SetLayer( LAYER_REFERENCEPART );
        else if( i == VALUE_FIELD )
            m_fields.back().SetLayer( LAYER_VALUEPART );
        else
            m_fields.back().SetLayer( LAYER_FIELDS );
    }

    m_prefix = wxString( wxT( "U" ) );
    m_isInNetlist = true;
    m_inBom = true;
    m_onBoard = true;
}

References TEMPLATE_FIELDNAME::GetDefaultFieldName(), LAYER_FIELDS, LAYER_REFERENCEPART, LAYER_VALUEPART, m_convert, m_fields, m_inBom, m_isInNetlist, m_onBoard, m_pos, m_prefix, m_transform, m_unit, MANDATORY_FIELDS, REFERENCE_FIELD, and VALUE_FIELD.

Referenced by SCH_SYMBOL().

InitializeConnection()

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

inherited

Create a new connection object associated with this object.

Parameters

aPath

is the sheet path to initialize.

Definition at line 176 of file sch_item.cpp.

{
    SCH_CONNECTION* connection = Connection( &aSheet );

    if( connection )
    {
        connection->Reset();
    }
    else
    {
        connection = new SCH_CONNECTION( this );
        m_connection_map.insert( std::make_pair( aSheet, connection ) );
    }

    connection->SetGraph( aGraph );
    connection->SetSheet( aSheet );
    return connection;
}

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

IsAnnotated()

bool SCH_SYMBOL::IsAnnotated

(

const SCH_SHEET_PATH *

aSheet

)

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

Parameters

aSheet

is the sheet path to test.

Returns

true if the symbol exists on that sheet and has a valid reference.

Definition at line 508 of file sch_symbol.cpp.

{
    KIID_PATH path = aSheet->Path();

    for( const SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
    {
        if( instance.m_Path == path )
            return instance.m_Reference.Last() != '?';
    }

    return false;
}

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

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

IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 126 of file eda_item.h.

{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_EDITOR_CONTROL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

IsConnectable()

bool SCH_SYMBOL::IsConnectable ( ) const

inlineoverridevirtual

Returns

true if the schematic item can connect to another schematic item.

Reimplemented from SCH_ITEM.

Definition at line 597 of file sch_symbol.h.

{ return true; }

IsConnected()

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

inherited

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

Parameters

aPoint

is a reference to a wxPoint object containing the coordinates to test.

Returns

True if connection to aPoint exists.

Definition at line 122 of file sch_item.cpp.

{
    if(( m_flags & STRUCT_DELETED ) || ( m_flags & SKIP_STRUCT ) )
        return false;

    return doIsConnected( aPosition );
}

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

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

IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( )

inlineinherited

Definition at line 424 of file sch_item.h.

{ return m_connectivity_dirty; }

References SCH_ITEM::m_connectivity_dirty.

IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const

inlinevirtualinherited

Reimplemented in SCH_TEXT, SCH_LINE, SCH_BUS_ENTRY_BASE, and SCH_PIN.

Definition at line 355 of file sch_item.h.

{ return false; }

IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

{ return m_flags & IS_DRAGGING; }

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

{ return m_flags & ENTERED; }

References ENTERED, and EDA_ITEM::m_flags.

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

IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

{ return m_forceVisible; }

References EDA_ITEM::m_forceVisible.

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

IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const

inlinevirtualinherited

Allow items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD.

Definition at line 265 of file sch_item.h.

{ return false; }

IsInNetlist()

bool SCH_SYMBOL::IsInNetlist

(

)

const

Returns

true if the symbol is in netlist.

Definition at line 1839 of file sch_symbol.cpp.

{
    return m_isInNetlist;
}

References m_isInNetlist.

Referenced by AUTOPLACER::AUTOPLACER().

IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const

inlinevirtualinherited

Returns

true if the object is locked, else false.

Definition at line 255 of file sch_item.h.

{ return false; }

IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

IsMovableFromAnchorPoint()

bool SCH_SYMBOL::IsMovableFromAnchorPoint ( ) const

inlineoverridevirtual

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

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

Note

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

Returns

true for a symbol.

Reimplemented from SCH_ITEM.

Definition at line 143 of file sch_symbol.h.

{ return true; }

IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), LIB_PIN::CalcEdit(), LIB_ARC::CalcRadiusAngles(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Rotate().

IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::DragArcTrack(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

IsPointClickableAnchor()

bool SCH_SYMBOL::IsPointClickableAnchor ( const wxPoint &  aPos ) const

overridevirtual

Returns

true if the given point can start drawing (usually means the anchor is unused/free/dangling).

Reimplemented from SCH_ITEM.

Definition at line 1881 of file sch_symbol.cpp.

{
    for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
    {
        int pin_unit = pin->GetLibPin()->GetUnit();
        int pin_convert = pin->GetLibPin()->GetConvert();

        if( pin_unit > 0 && pin_unit != GetUnit() )
            continue;

        if( pin_convert > 0 && pin_convert != GetConvert() )
            continue;

        if( pin->IsPointClickableAnchor( aPos ) )
            return true;
    }

    return false;
}

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

IsReferenceStringValid()

bool SCH_SYMBOL::IsReferenceStringValid ( const wxString &  aReferenceString )

static

Test for an acceptable reference string.

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

Parameters

aReferenceString

is the reference string to validate

Returns

true if reference string is valid.

Definition at line 466 of file sch_symbol.cpp.

{
    return !UTIL::GetRefDesPrefix( aReferenceString ).IsEmpty();
}

References UTIL::GetRefDesPrefix().

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

IsReplaceable()

bool SCH_SYMBOL::IsReplaceable ( ) const

inlineoverridevirtual

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

Returns

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

Reimplemented from EDA_ITEM.

Definition at line 639 of file sch_symbol.h.

{ return true; }

IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

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

IsType()

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

inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes

List of item types

Returns

true if the item type is contained in the list aScanTypes

Reimplemented in PCB_VIA, SCH_LABEL, PCB_DIMENSION_BASE, PAD, SCH_FIELD, FP_TEXT, SCH_LINE, PCB_SHAPE, FP_SHAPE, and PCB_TEXT.

Definition at line 183 of file eda_item.h.

    {
        if( aScanTypes[0] == SCH_LOCATE_ANY_T )
            return true;

        for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
        {
            if( m_structType == *p )
                return true;
        }

        return false;
    }

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

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

IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 295 of file eda_item.h.

    {
        for( auto it : aList )
        {
            if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
                    == SEARCH_RESULT::QUIT )
                return SEARCH_RESULT::QUIT;
        }

        return SEARCH_RESULT::CONTINUE;
    }

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

Referenced by GERBER_FILE_IMAGE::Visit().

IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 314 of file eda_item.h.

    {
        for( auto it : aList )
        {
            if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
                    == SEARCH_RESULT::QUIT )
                return SEARCH_RESULT::QUIT;
        }

        return SEARCH_RESULT::CONTINUE;
    }

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

Matches() [1/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

aText	A reference to a wxString object containing the string to test.
aSearchData	The criteria to search against.

Returns

True if aText matches the search criteria in aSearchData.

Definition at line 118 of file eda_item.cpp.

{
    wxString text = aText;
    wxString searchText = aSearchData.GetFindString();

    // Don't match if searching for replaceable item and the item doesn't support text replace.
    if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
        return false;

    if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
        return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );

    if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
    {
        if( aSearchData.GetFlags() & wxFR_MATCHCASE )
            return text.Matches( searchText );

        return text.MakeUpper().Matches( searchText.MakeUpper() );
    }

    if( aSearchData.GetFlags() & wxFR_MATCHCASE )
        return aText.Find( searchText ) != wxNOT_FOUND;

    return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
}

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

Matches() [2/2]

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

overridevirtual

Compare the item against the search criteria in aSearchData.

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

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns

True if the item's text matches the search criteria in aSearchData.

Reimplemented from EDA_ITEM.

Definition at line 1499 of file sch_symbol.cpp.

{
    wxLogTrace( traceFindItem, wxT( "  item " ) + GetSelectMenuText( EDA_UNITS::MILLIMETRES ) );

    // Symbols are searchable via the child field and pin item text.
    return false;
}

References GetSelectMenuText(), MILLIMETRES, and traceFindItem.

MirrorHorizontally()

void SCH_SYMBOL::MirrorHorizontally ( int  aCenter )

overridevirtual

Mirror item horizontally about aCenter.

Implements SCH_ITEM.

Definition at line 1444 of file sch_symbol.cpp.

{
    int dx = m_pos.x;

    SetOrientation( SYM_MIRROR_Y );
    MIRROR( m_pos.x, aCenter );
    dx -= m_pos.x;     // dx,0 is the move vector for this transform

    for( SCH_FIELD& field : m_fields )
    {
        // Move the fields to the new position because the symbol itself has moved.
        wxPoint pos = field.GetTextPos();
        pos.x -= dx;
        field.SetTextPos( pos );
    }
}

References m_fields, m_pos, MIRROR(), SetOrientation(), and SYM_MIRROR_Y.

MirrorVertically()

void SCH_SYMBOL::MirrorVertically ( int  aCenter )

overridevirtual

Mirror item vertically about aCenter.

Implements SCH_ITEM.

Definition at line 1462 of file sch_symbol.cpp.

{
    int dy = m_pos.y;

    SetOrientation( SYM_MIRROR_X );
    MIRROR( m_pos.y, aCenter );
    dy -= m_pos.y;     // dy,0 is the move vector for this transform

    for( SCH_FIELD& field : m_fields )
    {
        // Move the fields to the new position because the symbol itself has moved.
        wxPoint pos = field.GetTextPos();
        pos.y -= dy;
        field.SetTextPos( pos );
    }
}

References m_fields, m_pos, MIRROR(), SetOrientation(), and SYM_MIRROR_X.

Move()

void SCH_SYMBOL::Move ( const wxPoint &  aMoveVector )

inlineoverridevirtual

Move the item by aMoveVector to a new position.

Implements SCH_ITEM.

Definition at line 561 of file sch_symbol.h.

    {
        if( aMoveVector == wxPoint( 0, 0 ) )
            return;

        m_pos += aMoveVector;

        for( SCH_FIELD& field : m_fields )
            field.Move( aMoveVector );

        SetModified();
    }

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

Referenced by SetPosition().

NetClass()

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

inherited

Definition at line 145 of file sch_item.cpp.

{
    if( m_connection_map.size() )
    {
        SCH_CONNECTION* connection = Connection( aSheet );

        if( connection )
        {
            NET_SETTINGS&   netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
            const wxString& netclassName = netSettings.GetNetclassName( connection->Name() );

            return netSettings.m_NetClasses.Find( netclassName );
        }
    }

    return nullptr;
}

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

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

operator!=()

bool SCH_SYMBOL::operator!=

(

const SCH_SYMBOL &

aSymbol

)

const

Definition at line 1740 of file sch_symbol.cpp.

{
    return !( *this == aSymbol );
}

operator<() [1/2]

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

inherited

Test if another item is less than this object.

Parameters

aItem

- Item to compare against.

Returns

- True if aItem is less than the item.

Definition at line 171 of file eda_item.cpp.

{
    wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
                                  GetClass() ) );

    return false;
}

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

operator<() [2/2]

bool SCH_SYMBOL::operator< ( const SCH_ITEM &  aItem ) const

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1703 of file sch_symbol.cpp.

{
    if( Type() != aItem.Type() )
        return Type() < aItem.Type();

    auto symbol = static_cast<const SCH_SYMBOL*>( &aItem );

    EDA_RECT rect = GetBodyBoundingBox();

    if( rect.GetArea() != symbol->GetBodyBoundingBox().GetArea() )
        return rect.GetArea() < symbol->GetBodyBoundingBox().GetArea();

    if( m_pos.x != symbol->m_pos.x )
        return m_pos.x < symbol->m_pos.x;

    if( m_pos.y != symbol->m_pos.y )
        return m_pos.y < symbol->m_pos.y;

    return m_Uuid < aItem.m_Uuid;       // Ensure deterministic sort
}

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

operator=()

SCH_SYMBOL & SCH_SYMBOL::operator=

(

const SCH_ITEM &

aItem

)

Definition at line 1746 of file sch_symbol.cpp.

{
    wxCHECK_MSG( Type() == aItem.Type(), *this,
                 wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
                 GetClass() );

    if( &aItem != this )
    {
        SCH_ITEM::operator=( aItem );

        SCH_SYMBOL* c = (SCH_SYMBOL*) &aItem;

        m_lib_id    = c->m_lib_id;

        LIB_SYMBOL* libSymbol = c->m_part ? new LIB_SYMBOL( *c->m_part.get() ) : nullptr;

        m_part.reset( libSymbol );
        m_pos       = c->m_pos;
        m_unit      = c->m_unit;
        m_convert   = c->m_convert;
        m_transform = c->m_transform;

        m_instanceReferences = c->m_instanceReferences;

        m_fields    = c->m_fields;    // std::vector's assignment operator

        // Reparent fields after assignment to new symbol.
        for( SCH_FIELD& field : m_fields )
            field.SetParent( this );

        UpdatePins();
    }

    return *this;
}

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

operator==()

bool SCH_SYMBOL::operator==

(

const SCH_SYMBOL &

aSymbol

)

const

Definition at line 1725 of file sch_symbol.cpp.

{
    if( GetFieldCount() !=  aSymbol.GetFieldCount() )
        return false;

    for( int i = VALUE_FIELD; i < GetFieldCount(); i++ )
    {
        if( GetFields()[i].GetText().Cmp( aSymbol.GetFields()[i].GetText() ) != 0 )
            return false;
    }

    return true;
}

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

Plot()

void SCH_SYMBOL::Plot ( PLOTTER *  aPlotter ) const

overridevirtual

Plot the schematic item to aPlotter.

Parameters

aPlotter

is the PLOTTER object to plot to.

Reimplemented from SCH_ITEM.

Definition at line 1845 of file sch_symbol.cpp.

{
    if( m_part )
    {
        TRANSFORM temp = GetTransform();
        aPlotter->StartBlock( nullptr );

        m_part->Plot( aPlotter, GetUnit(), GetConvert(), m_pos, temp );

        for( SCH_FIELD field : m_fields )
            field.Plot( aPlotter );

        aPlotter->EndBlock( nullptr );
    }
}

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

Print()

void SCH_SYMBOL::Print ( const RENDER_SETTINGS *  aSettings, const wxPoint &  aOffset  )

overridevirtual

Print a symbol.

Parameters

aDC	is the device context (can be null).
aOffset	is the drawing offset (usually wxPoint(0,0), but can be different when moving an object)

Implements SCH_ITEM.

Definition at line 370 of file sch_symbol.cpp.

{
    LIB_SYMBOL_OPTIONS opts;
    opts.transform = m_transform;
    opts.draw_visible_fields = false;
    opts.draw_hidden_fields = false;

    if( m_part )
    {
        m_part->Print( aSettings, m_pos + aOffset, m_unit, m_convert, opts );
    }
    else    // Use dummy() part if the actual cannot be found.
    {
        dummy()->Print( aSettings, m_pos + aOffset, 0, 0, opts );
    }

    for( SCH_FIELD& field : m_fields )
        field.Print( aSettings, aOffset );
}

References LIB_SYMBOL_OPTIONS::draw_hidden_fields, LIB_SYMBOL_OPTIONS::draw_visible_fields, dummy(), m_convert, m_fields, m_part, m_pos, m_transform, m_unit, LIB_SYMBOL::Print(), and LIB_SYMBOL_OPTIONS::transform.

RemoveField()

void SCH_SYMBOL::RemoveField

(

const wxString &

aFieldName

)

Remove a user field from the symbol.

Parameters

aFieldName

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

Definition at line 721 of file sch_symbol.cpp.

{
    for( unsigned i = MANDATORY_FIELDS; i < m_fields.size(); ++i )
    {
        if( aFieldName == m_fields[i].GetName( false ) )
        {
            m_fields.erase( m_fields.begin() + i );
            return;
        }
    }
}

References m_fields, and MANDATORY_FIELDS.

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

Replace() [1/2]

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

staticinherited

Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aText	A reference to a wxString object containing the text to be replaced.

Returns

True if aText was modified, otherwise false.

Definition at line 145 of file eda_item.cpp.

{
    wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();

    int result = searchString.Find( ( aSearchData.GetFlags() & wxFR_MATCHCASE ) ?
                                    aSearchData.GetFindString() :
                                    aSearchData.GetFindString().Upper() );

    if( result == wxNOT_FOUND )
        return false;

    wxString prefix = aText.Left( result );
    wxString suffix;

    if( aSearchData.GetFindString().length() + result < aText.length() )
        suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );

    wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
                aText, prefix, aSearchData.GetReplaceString(), suffix );

    aText = prefix + aSearchData.GetReplaceString() + suffix;

    return true;
}

References traceFindReplace.

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

Replace() [2/2]

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

inlinevirtualinherited

Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

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

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns

True if the item text was modified, otherwise false.

Reimplemented in SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 392 of file eda_item.h.

    {
        return false;
    }

ReplaceInstanceSheetPath()

bool SCH_SYMBOL::ReplaceInstanceSheetPath	(	const KIID_PATH &	aOldSheetPath,
		const KIID_PATH &	aNewSheetPath
	)

Replace aOldSheetPath with aNewSheetPath in the instance list.

Parameters

aOldSheetPath	is a KIID_PATH object of an existing path in the instance list.
aNewSheetPath	is a KIID_PATH object of the path to replace the existing path.

Returns

true if aOldSheetPath was found and replaced or false if aOldSheetPath was not found in the instance list.

Definition at line 1068 of file sch_symbol.cpp.

{
    auto it = std::find_if( m_instanceReferences.begin(), m_instanceReferences.end(),
                [ aOldSheetPath ]( SYMBOL_INSTANCE_REFERENCE& r )->bool
                {
                    return aOldSheetPath == r.m_Path;
                }
            );

    if( it != m_instanceReferences.end() )
    {
        wxLogTrace( traceSchSheetPaths,
                    "Replacing sheet path %s\n  with sheet path %s\n  for symbol %s.",
                    aOldSheetPath.AsString(), aNewSheetPath.AsString(), m_Uuid.AsString() );

        it->m_Path = aNewSheetPath;
        return true;
    }

    wxLogTrace( traceSchSheetPaths,
            "Could not find sheet path %s\n  to replace with sheet path %s\n  for symbol %s.",
            aOldSheetPath.AsString(), aNewSheetPath.AsString(), m_Uuid.AsString() );

    return false;
}

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

ResolveTextVar()

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

Resolve any references to system tokens supported by the symbol.

Parameters

aDepth

a counter to limit recursion and circular references.

Definition at line 933 of file sch_symbol.cpp.

{
    SCHEMATIC* schematic = Schematic();

    // SCH_SYMOL object has no context outside a schematic.
    wxCHECK( schematic, false );

    for( int i = 0; i < MANDATORY_FIELDS; ++i )
    {
        if( token->IsSameAs( m_fields[ i ].GetCanonicalName().Upper() ) )
        {
            if( i == REFERENCE_FIELD )
                *token = GetRef( &schematic->CurrentSheet(), true );
            else if( i == VALUE_FIELD )
                *token = GetValue( &schematic->CurrentSheet(), true );
            else if( i == FOOTPRINT_FIELD )
                *token = GetFootprint( &schematic->CurrentSheet(), true );
            else
                *token = m_fields[ i ].GetShownText( aDepth + 1 );

            return true;
        }
    }

    for( size_t i = MANDATORY_FIELDS; i < m_fields.size(); ++i )
    {
        if( token->IsSameAs( m_fields[ i ].GetName() )
            || token->IsSameAs( m_fields[ i ].GetName().Upper() ) )
        {
            *token = m_fields[ i ].GetShownText( aDepth + 1 );
            return true;
        }
    }

    for( const TEMPLATE_FIELDNAME& templateFieldname :
            schematic->Settings().m_TemplateFieldNames.GetTemplateFieldNames() )
    {
        if( token->IsSameAs( templateFieldname.m_Name )
            || token->IsSameAs( templateFieldname.m_Name.Upper() ) )
        {
            // If we didn't find it in the fields list then it isn't set on this symbol.
            // Just return an empty string.
            *token = wxEmptyString;
            return true;
        }
    }

    if( token->IsSameAs( wxT( "FOOTPRINT_LIBRARY" ) ) )
    {
        wxString footprint;

        footprint = GetFootprint( &schematic->CurrentSheet(), true );

        wxArrayString parts = wxSplit( footprint, ':' );

        *token = parts[ 0 ];
        return true;
    }
    else if( token->IsSameAs( wxT( "FOOTPRINT_NAME" ) ) )
    {
        wxString footprint;

        footprint = GetFootprint( &schematic->CurrentSheet(), true );

        wxArrayString parts = wxSplit( footprint, ':' );

        *token = parts[ std::min( 1, (int) parts.size() - 1 ) ];
        return true;
    }
    else if( token->IsSameAs( wxT( "UNIT" ) ) )
    {
        int unit;

        unit = GetUnitSelection( &schematic->CurrentSheet() );

        *token = LIB_SYMBOL::SubReference( unit );
        return true;
    }

    return false;
}

References SCHEMATIC::CurrentSheet(), FOOTPRINT_FIELD, GetFootprint(), GetRef(), TEMPLATES::GetTemplateFieldNames(), GetUnitSelection(), GetValue(), m_fields, SCHEMATIC_SETTINGS::m_TemplateFieldNames, MANDATORY_FIELDS, REFERENCE_FIELD, SCH_ITEM::Schematic(), SCHEMATIC::Settings(), LIB_SYMBOL::SubReference(), and VALUE_FIELD.

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

Rotate()

void SCH_SYMBOL::Rotate ( const wxPoint &  aCenter )

overridevirtual

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

Implements SCH_ITEM.

Definition at line 1480 of file sch_symbol.cpp.

{
    wxPoint prev = m_pos;

    RotatePoint( &m_pos, aCenter, 900 );

    SetOrientation( SYM_ROTATE_COUNTERCLOCKWISE );

    for( SCH_FIELD& field : m_fields )
    {
        // Move the fields to the new position because the symbol itself has moved.
        wxPoint pos = field.GetTextPos();
        pos.x -= prev.x - m_pos.x;
        pos.y -= prev.y - m_pos.y;
        field.SetTextPos( pos );
    }
}

References m_fields, m_pos, RotatePoint(), SetOrientation(), and SYM_ROTATE_COUNTERCLOCKWISE.

RunOnChildren()

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

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 821 of file sch_symbol.cpp.

{
    for( const std::unique_ptr<SCH_PIN>& pin : m_pins )
        aFunction( pin.get() );

    for( SCH_FIELD& field : m_fields )
        aFunction( &field );
}

References m_fields, m_pins, and pin.

Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const

inherited

Searches the item hierarchy to find a SCHEMATIC.

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

Every SCH_SCREEN should be parented to the SCHEMATIC.

Note

This hierarchy is not the same as the sheet hierarchy!

Returns

the parent schematic this item lives on, or nullptr.

Definition at line 97 of file sch_item.cpp.

{
    EDA_ITEM* parent = GetParent();

    while( parent )
    {
        if( parent->Type() == SCHEMATIC_T )
            return static_cast<SCHEMATIC*>( parent );
        else
            parent = parent->GetParent();
    }

    return nullptr;
}

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

Referenced by SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_FIELD::DoHypertextMenu(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::getEffectiveShape(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_NO_CONNECT::GetPenWidth(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), GetPins(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetTextOffset(), inheritNetclass(), SCH_SHEET::IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), SCH_GLOBALLABEL::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_SHEET::ResolveTextVar(), ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and SCH_MARKER::ViewGetLayers().

Set() [1/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );

        if( object )
            aProperty->setter( object, aValue );

        return object != nullptr;
    }

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

Referenced by isCoupledDiffPair().

Set() [2/3]

template<typename T >

bool INSPECTABLE::Set ( PROPERTY_BASE *  aProperty, T  aValue  )

inlineinherited

Definition at line 55 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );

        if( object )
            aProperty->set<T>( object, aValue );

        return object != nullptr;
    }

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

Set() [3/3]

template<typename T >

bool INSPECTABLE::Set ( const wxString &  aProperty, T  aValue  )

inlineinherited

Definition at line 68 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
        void* object = nullptr;

        if( prop )
        {
            object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );

            if( object )
                prop->set<T>( object, aValue );
        }

        return object != nullptr;
    }

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

SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 130 of file eda_item.h.

{ SetFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool  aDirty = true )

inlineinherited

Definition at line 426 of file sch_item.h.

{ m_connectivity_dirty = aDirty; }

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::SaveCopyInUndoList().

SetConvert()

void SCH_SYMBOL::SetConvert

(

int

aConvert

)

Definition at line 338 of file sch_symbol.cpp.

{
    if( m_convert != aConvert )
    {
        m_convert = aConvert;

        // The convert may have a different pin layout so the update the pin map.
        UpdatePins();
        SetModified();
    }
}

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

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

SetFields()

void SCH_SYMBOL::SetFields ( const SCH_FIELDS &  aFields )

inline

Set multiple schematic fields.

Parameters

aFields

are the fields to set in this symbol.

Definition at line 400 of file sch_symbol.h.

    {
        m_fields = aFields;     // vector copying, length is changed possibly
    }

References m_fields.

SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )

inlineinherited

Definition at line 435 of file sch_item.h.

{ m_fieldsAutoplaced = FIELDS_AUTOPLACED_AUTO; }

References FIELDS_AUTOPLACED_AUTO, and SCH_ITEM::m_fieldsAutoplaced.

SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS  aMask )

inlineinherited

Definition at line 153 of file eda_item.h.

{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SCH_MOVE_TOOL::AlignElements(), PCB_CONTROL::AppendBoard(), FOOTPRINT::BuildPolyCourtyards(), SCH_EDIT_TOOL::ChangeTextType(), GRAPHICS_CLEANER::cleanupSegments(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), PCB_SELECTION_TOOL::EnterGroup(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_MOVE_TOOL::getConnectedDragItems(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EE_SELECTION_TOOL::Main(), TRACKS_CLEANER::mergeCollinearSegments(), SYMBOL_EDITOR_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), EE_SELECTION_TOOL::narrowSelection(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseJunction(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParseNoERC(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_ALTIUM_PLUGIN::ParseWire(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

SetFootprint() [1/2]

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

Definition at line 636 of file sch_symbol.cpp.

{
    if( sheet == nullptr )
    {
        // Clear instance overrides and set primary field value
        for( SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
            instance.m_Footprint = wxEmptyString;

        m_fields[ FOOTPRINT_FIELD ].SetText( aFootprint );
        return;
    }

    KIID_PATH path = sheet->Path();

    // check to see if it is already there before inserting it
    for( SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
    {
        if( instance.m_Path == path )
        {
            instance.m_Footprint = aFootprint;
            return;
        }
    }

    // didn't find it; better add it
    AddHierarchicalReference( path, UTIL::GetRefDesUnannotated( m_prefix ), m_unit,
                              wxEmptyString, aFootprint );
}

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

Referenced by BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_ALTIUM_PLUGIN::ParseImplementation(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_FIELD::Replace(), SetFootprint(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), UpdateFields(), and SCH_EDITOR_CONTROL::updatePastedSymbol().

SetFootprint() [2/2]

void SCH_SYMBOL::SetFootprint ( const wxString &  aFootprint )

inline

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

Definition at line 554 of file sch_symbol.h.

    {
        SetFootprint( nullptr, aFootprint );
    }

References SetFootprint().

SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable )

inlineinherited

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

Parameters

aEnable

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

{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

SetIncludeInBom()

void SCH_SYMBOL::SetIncludeInBom ( bool  aIncludeInBom )

inline

Definition at line 660 of file sch_symbol.h.

{ m_inBom = aIncludeInBom; }

References m_inBom.

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

SetIncludeOnBoard()

void SCH_SYMBOL::SetIncludeOnBoard ( bool  aIncludeOnBoard )

inline

Definition at line 663 of file sch_symbol.h.

{ m_onBoard = aIncludeOnBoard; }

References m_onBoard.

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

SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID  aLayer )

inlineinherited

Set the layer this item is on.

Parameters

aLayer

The layer number.

Definition at line 279 of file sch_item.h.

{ m_layer = aLayer; }

References SCH_ITEM::m_layer.

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

SetLibId()

void SCH_SYMBOL::SetLibId

(

const LIB_ID &

aName

)

Definition at line 229 of file sch_symbol.cpp.

{
    if( m_lib_id != aLibId )
    {
        m_lib_id = aLibId;
        SetModified();
    }
}

References m_lib_id, and EDA_ITEM::SetModified().

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

SetLibSymbol()

void SCH_SYMBOL::SetLibSymbol

(

LIB_SYMBOL *

aLibSymbol

)

Set this schematic symbol library symbol reference to aLibSymbol.

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

Note

This is the only way to publicly set the library symbol for a schematic symbol except for the ctors that take a LIB_SYMBOL reference. All previous public resolvers have been deprecated.

Parameters

aLibSymbol

is the library symbol to associate with this schematic symbol.

Definition at line 248 of file sch_symbol.cpp.

{
    wxCHECK2( ( aLibSymbol == nullptr ) || ( aLibSymbol->IsRoot() ), aLibSymbol = nullptr );

    m_part.reset( aLibSymbol );
    UpdatePins();
}

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

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

SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked )

inlinevirtualinherited

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

Definition at line 260 of file sch_item.h.

{}

SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 65 of file eda_item.cpp.

{
    SetFlags( IS_CHANGED );

    // If this a child object, then the parent modification state also needs to be set.
    if( m_parent )
        m_parent->SetModified();
}

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

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

SetOrientation()

void SCH_SYMBOL::SetOrientation

(

int

aOrientation

)

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

Parameters

aOrientation

is the orientation to apply to the transform.

Definition at line 1096 of file sch_symbol.cpp.

{
    TRANSFORM temp = TRANSFORM();
    bool transform = false;

    switch( aOrientation )
    {
    case SYM_ORIENT_0:
    case SYM_NORMAL:                    // default transform matrix
        m_transform.x1 = 1;
        m_transform.y2 = -1;
        m_transform.x2 = m_transform.y1 = 0;
        break;

    case SYM_ROTATE_COUNTERCLOCKWISE:  // Rotate + (incremental rotation)
        temp.x1   = temp.y2 = 0;
        temp.y1   = 1;
        temp.x2   = -1;
        transform = true;
        break;

    case SYM_ROTATE_CLOCKWISE:          // Rotate - (incremental rotation)
        temp.x1   = temp.y2 = 0;
        temp.y1   = -1;
        temp.x2   = 1;
        transform = true;
        break;

    case SYM_MIRROR_Y:                  // Mirror Y (incremental rotation)
        temp.x1   = -1;
        temp.y2   = 1;
        temp.y1   = temp.x2 = 0;
        transform = true;
        break;

    case SYM_MIRROR_X:                  // Mirror X (incremental rotation)
        temp.x1   = 1;
        temp.y2   = -1;
        temp.y1   = temp.x2 = 0;
        transform = true;
        break;

    case SYM_ORIENT_90:
        SetOrientation( SYM_ORIENT_0 );
        SetOrientation( SYM_ROTATE_COUNTERCLOCKWISE );
        break;

    case SYM_ORIENT_180:
        SetOrientation( SYM_ORIENT_0 );
        SetOrientation( SYM_ROTATE_COUNTERCLOCKWISE );
        SetOrientation( SYM_ROTATE_COUNTERCLOCKWISE );
        break;

    case SYM_ORIENT_270:
        SetOrientation( SYM_ORIENT_0 );
        SetOrientation( SYM_ROTATE_CLOCKWISE );
        break;

    case ( SYM_ORIENT_0 + SYM_MIRROR_X ):
        SetOrientation( SYM_ORIENT_0 );
        SetOrientation( SYM_MIRROR_X );
        break;

    case ( SYM_ORIENT_0 + SYM_MIRROR_Y ):
        SetOrientation( SYM_ORIENT_0 );
        SetOrientation( SYM_MIRROR_Y );
        break;

    case ( SYM_ORIENT_90 + SYM_MIRROR_X ):
        SetOrientation( SYM_ORIENT_90 );
        SetOrientation( SYM_MIRROR_X );
        break;

    case ( SYM_ORIENT_90 + SYM_MIRROR_Y ):
        SetOrientation( SYM_ORIENT_90 );
        SetOrientation( SYM_MIRROR_Y );
        break;

    case ( SYM_ORIENT_180 + SYM_MIRROR_X ):
        SetOrientation( SYM_ORIENT_180 );
        SetOrientation( SYM_MIRROR_X );
        break;

    case ( SYM_ORIENT_180 + SYM_MIRROR_Y ):
        SetOrientation( SYM_ORIENT_180 );
        SetOrientation( SYM_MIRROR_Y );
        break;

    case ( SYM_ORIENT_270 + SYM_MIRROR_X ):
        SetOrientation( SYM_ORIENT_270 );
        SetOrientation( SYM_MIRROR_X );
        break;

    case ( SYM_ORIENT_270 + SYM_MIRROR_Y ):
        SetOrientation( SYM_ORIENT_270 );
        SetOrientation( SYM_MIRROR_Y );
        break;

    default:
        transform = false;
        wxFAIL_MSG( "Invalid schematic symbol orientation type." );
        break;
    }

    if( transform )
    {
        /* The new matrix transform is the old matrix transform modified by the
         *  requested transformation, which is the temp transform (rot,
         *  mirror ..) in order to have (in term of matrix transform):
         *     transform coord = new_m_transform * coord
         *  where transform coord is the coord modified by new_m_transform from
         *  the initial value coord.
         *  new_m_transform is computed (from old_m_transform and temp) to
         *  have:
         *     transform coord = old_m_transform * temp
         */
        TRANSFORM newTransform;

        newTransform.x1 = m_transform.x1 * temp.x1 + m_transform.x2 * temp.y1;
        newTransform.y1 = m_transform.y1 * temp.x1 + m_transform.y2 * temp.y1;
        newTransform.x2 = m_transform.x1 * temp.x2 + m_transform.x2 * temp.y2;
        newTransform.y2 = m_transform.y1 * temp.x2 + m_transform.y2 * temp.y2;
        m_transform = newTransform;
    }
}

References m_transform, SYM_MIRROR_X, SYM_MIRROR_Y, SYM_NORMAL, SYM_ORIENT_0, SYM_ORIENT_180, SYM_ORIENT_270, SYM_ORIENT_90, SYM_ROTATE_CLOCKWISE, SYM_ROTATE_COUNTERCLOCKWISE, TRANSFORM::x1, TRANSFORM::x2, TRANSFORM::y1, and TRANSFORM::y2.

Referenced by GetOrientation(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_EDIT_TOOL::Mirror(), MirrorHorizontally(), MirrorVertically(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EDIT_TOOL::Rotate(), Rotate(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM *  aParent )

inlinevirtualinherited

Reimplemented in PCB_DIMENSION_BASE.

Definition at line 116 of file eda_item.h.

{ m_parent = aParent; }

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), FOOTPRINT::operator=(), LIB_SYMBOL::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), PCB_DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_SHEET::SwapData(), SCH_GLOBALLABEL::SwapData(), SwapData(), and SwapItemData().

SetPosition()

void SCH_SYMBOL::SetPosition ( const wxPoint &  aPosition )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 642 of file sch_symbol.h.

{ Move( aPosition - m_pos ); }

References m_pos, and Move().

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

SetPrefix()

void SCH_SYMBOL::SetPrefix ( const wxString &  aPrefix )

inline

Definition at line 229 of file sch_symbol.h.

{ m_prefix = aPrefix; }

References m_prefix.

SetRef()

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

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

Parameters

aSheet	is the hierarchical path of the reference.
aReference	is the new reference for the symbol.

Definition at line 472 of file sch_symbol.cpp.

{
    KIID_PATH path = sheet->Path();
    bool      notInArray = true;

    // check to see if it is already there before inserting it
    for( SYMBOL_INSTANCE_REFERENCE& instance : m_instanceReferences )
    {
        if( instance.m_Path == path )
        {
            instance.m_Reference = ref;
            notInArray = false;
        }
    }

    if( notInArray )
        AddHierarchicalReference( path, ref, m_unit );

    for( std::unique_ptr<SCH_PIN>& pin : m_pins )
        pin->ClearDefaultNetName( sheet );

    SCH_FIELD* rf = GetField( REFERENCE_FIELD );

    rf->SetText( ref );  // for drawing.

    // Reinit the m_prefix member if needed
    m_prefix = UTIL::GetRefDesPrefix( ref );

    if( m_prefix.IsEmpty() )
        m_prefix = wxT( "U" );

    // Power symbols have references starting with # and are not included in netlists
    m_isInNetlist = ! ref.StartsWith( wxT( "#" ) );
}

References AddHierarchicalReference(), GetField(), UTIL::GetRefDesPrefix(), m_instanceReferences, m_isInNetlist, m_pins, m_prefix, m_unit<