SCH_SYMBOL Class Reference

Schematic symbol object. More...

#include <sch_symbol.h>

Inheritance diagram for SCH_SYMBOL:

Public Member Functions
	SCH_SYMBOL ()
	SCH_SYMBOL (const LIB_SYMBOL &aSymbol, const LIB_ID &aLibId, const SCH_SHEET_PATH *aSheet, int aUnit, int aConvert=0, const VECTOR2I &aPosition=VECTOR2I(0, 0), EDA_ITEM *aParent=nullptr)
	Create schematic symbol from library symbol object. More...
	SCH_SYMBOL (const LIB_SYMBOL &aSymbol, const SCH_SHEET_PATH *aSheet, const PICKED_SYMBOL &aSel, const VECTOR2I &aPosition=VECTOR2I(0, 0), EDA_ITEM *aParent=nullptr)
	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...
bool	IsMissingLibSymbol () const
	Check to see if the library symbol is set to the dummy library symbol. More...
const std::vector< SCH_SYMBOL_INSTANCE > &	GetInstanceReferences ()
bool	GetInstance (SCH_SYMBOL_INSTANCE &aInstance, const KIID_PATH &aSheetPath, bool aTestFromEnd=false) const
void	RemoveInstance (const SCH_SHEET_PATH &aInstancePath)
void	RemoveAllInstances ()
void	SortInstances (bool(*aSortFunction)(const SCH_SYMBOL_INSTANCE &aLhs, const SCH_SYMBOL_INSTANCE &aRhs))
void	SetExcludeFromSim (bool aExclude) override
bool	GetExcludeFromSim () const override
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
wxString	GetKeyWords () const
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...
bool	HasUnitDisplayName (int aUnit)
	Return true if the given unit aUnit has a display name set. More...
wxString	GetUnitDisplayName (int aUnit)
	Return the display name for a given unit 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)
void	UpdatePrefix ()
	Set the prefix based on the current reference designator. More...
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 () const
	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 (const SCH_SHEET_PATH *aPath, 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, bool aResetPrefix)
	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 BOX2I	GetBoundingBox () const override
	Return the orthogonal bounding box of this object for display purposes. More...
BOX2I	GetBodyBoundingBox () const
	Return a bounding box for the symbol body but not the pins or fields. More...
BOX2I	GetBodyAndPinsBoundingBox () const
	Return a bounding box for the symbol body and pins 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...
SCH_FIELD *	GetFieldByName (const wxString &aFieldName)
	Return a field in this symbol. More...
wxString	GetFieldText (const wxString &aFieldName) 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...
void	RemoveField (SCH_FIELD *aField)
SCH_FIELD *	FindField (const wxString &aFieldName, bool aIncludeDefaultFields=true)
	Search for a SCH_FIELD with aFieldName. More...
void	SetFields (std::vector< SCH_FIELD > &aFields)
	Set multiple schematic fields. More...
const wxString	GetValueFieldText (bool aResolve, const SCH_SHEET_PATH *aPath, bool aAllowExtraText) const
void	SetValueFieldText (const wxString &aValue)
const wxString	GetFootprintFieldText (bool aResolve, const SCH_SHEET_PATH *aPath, bool aAllowExtraText) const
void	SetFootprintFieldText (const wxString &aFootprint)
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...
std::vector< LIB_PIN * >	GetAllLibPins () const
size_t	GetFullPinCount ()
SCH_PIN *	GetPin (LIB_PIN *aLibPin) const
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 VECTOR2I &aOffset) override
	Print a symbol. More...
void	PrintBackground (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset) override
	Print only the background parts of a symbol (if any) 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)
	Add a full hierarchical reference to this symbol. More...
void	AddHierarchicalReference (const SCH_SYMBOL_INSTANCE &aInstance)
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...
void	Move (const VECTOR2I &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 VECTOR2I &aCenter) override
	Rotate the item around aCenter 90 degrees in the clockwise direction. More...
bool	Matches (const EDA_SEARCH_DATA &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...
VECTOR2I	GetPinPhysicalPosition (const LIB_PIN *Pin) const
bool	IsConnectable () const override
bool	CanConnect (const SCH_ITEM *aItem) const override
bool	IsInNetlist () const
std::vector< VECTOR2I >	GetConnectionPoints () const override
	Add all the connection points for this item to aPoints. More...
INSPECT_RESULT	Visit (INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes) 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 VECTOR2I &aPosition, KICAD_T aType=TYPE_NOT_INIT)
	Return the symbol library item at aPosition that is part of this symbol. More...
wxString	GetItemDescription (UNITS_PROVIDER *aUnitsProvider) const override
	Return a user-visible description string of this item. 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...
VECTOR2I	GetPosition () const override
void	SetPosition (const VECTOR2I &aPosition) override
bool	HitTest (const VECTOR2I &aPosition, int aAccuracy=0) const override
	Test if aPosition is inside or on the boundary of this item. More...
bool	HitTest (const BOX2I &aRect, bool aContained, int aAccuracy=0) const override
	Test if aRect intersects this item. More...
void	Plot (PLOTTER *aPlotter, bool aBackground) const override
	Plot the schematic item to aPlotter. More...
void	PlotPins (PLOTTER *aPlotter) const
	Plot just the symbol pins. More...
void	PlotDNP (PLOTTER *aPlotter) const
	Plot the red 'X' over the symbol. 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	GetDNP () const
void	SetDNP (bool aDNP)
bool	IsPointClickableAnchor (const VECTOR2I &aPos) const override
bool	IsSymbolLikePowerGlobalLabel () const
bool	IsPower () const
bool	IsType (const std::vector< KICAD_T > &aScanTypes) const override
	Check whether the item is one of the listed types. More...
SCH_ITEM *	Duplicate (bool doClone=false) const
	Routine to create a new copy of given item. More...
VECTOR2I &	GetStoredPos ()
void	SetStoredPos (const VECTOR2I &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	DoHypertextAction (EDA_DRAW_FRAME *aFrame) const
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
const wxString &	GetDefaultFont () const
bool	RenderAsBitmap (double aWorldScale) const override
virtual bool	IsDangling () const
void	ClearConnections ()
	Clears all of the connection items from the list. More...
bool	IsConnected (const VECTOR2I &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...
SCH_CONNECTION *	GetOrInitConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
virtual bool	ConnectionPropagatesTo (const EDA_ITEM *aItem) const
	Return true if this item should propagate connection info to aItem. More...
bool	IsConnectivityDirty () const
void	SetConnectivityDirty (bool aDirty=true)
void	SetConnectionGraph (CONNECTION_GRAPH *aGraph)
	Updates the connection graph for all connections in this item. More...
virtual void	SetLastResolvedState (const SCH_ITEM *aItem)
std::shared_ptr< NETCLASS >	GetEffectiveNetClass (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 void	ClearCaches ()
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	IsSelected () const
bool	IsEntered () const
bool	IsBrightened () const
bool	IsRollover () const
void	SetSelected ()
void	SetBrightened ()
void	ClearSelected ()
void	ClearBrightened ()
void	SetModified ()
void	SetFlags (EDA_ITEM_FLAGS aMask)
void	XorFlags (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 ()
void	SetIsShownAsBitmap (bool aBitmap)
bool	IsShownAsBitmap () const
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 wxString	GetFriendlyName () const
virtual const VECTOR2I	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
virtual VECTOR2I	GetSortPosition () const
	Return the coordinates that should be used for sorting this element visually compared to other elements. More...
wxString	GetTypeDesc () const
	Return a translated description of the type for this EDA_ITEM for display in user facing messages. More...
virtual bool	Replace (const EDA_SEARCH_DATA &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	SetForcedTransparency (double aForcedTransparency)
double	GetForcedTransparency () const
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) const
template<typename T >
T	Get (PROPERTY_BASE *aProperty) const
template<typename T >
std::optional< T >	Get (const wxString &aProperty) const

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 INSPECT_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
	This changes first parameter to avoid the DList and use the main queue instead. More...
template<class T >
static INSPECT_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
	Change first parameter to avoid the DList and use std::vector instead. More...
static bool	Replace (const EDA_SEARCH_DATA &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 EDA_SEARCH_DATA &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
VECTOR2I	m_storedPos
std::map< SCH_SHEET_PATH, SCH_ITEM_SET, SHEET_PATH_CMP >	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 *	m_parent
	Linked list: Link (parent struct) More...
bool	m_forceVisible
EDA_ITEM_FLAGS	m_flags

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

Private Attributes
VECTOR2I	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. More...
std::vector< SCH_FIELD >	m_fields
	Variable length list of fields. More...
std::unique_ptr< LIB_SYMBOL >	m_part
	a flattened copy of the LIB_SYMBOL from the PROJECT's libraries. More...
std::vector< std::unique_ptr< SCH_PIN > >	m_pins
	a SCH_PIN for every LIB_PIN (all units) More...
std::unordered_map< LIB_PIN *, unsigned >	m_pinMap
	library pin pointer : SCH_PIN's index More...
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...
bool	m_DNP
	True if symbol is set to 'Do Not Populate'. More...
std::vector< SCH_SYMBOL_INSTANCE >	m_instanceReferences
KICAD_T	m_structType
	Run time identification, keep private so it can never be changed after a ctor sets it. More...
VIEW_ITEM_DATA *	m_viewPrivData
double	m_forcedTransparency
	Additional transparency for diff'ing items. More...

Static Private Attributes
static std::unordered_map< TRANSFORM, int >	s_transformToOrientationCache

Detailed Description

Schematic symbol object.

Definition at line 80 of file sch_symbol.h.

Constructor & Destructor Documentation

SCH_SYMBOL() [1/4]

SCH_SYMBOL::SCH_SYMBOL

(

)

Definition at line 108 of file sch_symbol.cpp.

References Init(), and m_DNP.

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	aUnit,
		int	aConvert = 0,
		const VECTOR2I &	aPosition = VECTOR2I( 0, 0 ),
		EDA_ITEM *	aParent = nullptr
	)

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.
aUnit	is unit for symbols that have multiple parts per package.
aConvert	is the alternate body style for the schematic symbols.
aPosition	is the position of the symbol.

Definition at line 116 of file sch_symbol.cpp.

References LIB_SYMBOL::Flatten(), UTIL::GetRefDesPrefix(), UTIL::GetRefDesUnannotated(), Init(), m_convert, m_DNP, 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 VECTOR2I &	aPosition = VECTOR2I( 0, 0 ),
		EDA_ITEM *	aParent = nullptr
	)

Definition at line 155 of file sch_symbol.cpp.

References PICKED_SYMBOL::Fields, GetFieldById(), REFERENCE_FIELD, and SetRef().

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

References m_convert, m_DNP, 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 113 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 201 of file sch_item.cpp.

References SCH_ITEM::m_connected_items.

Referenced by SCH_LABEL_BASE::UpdateDanglingState(), and CONNECTION_GRAPH::updateItemConnectivity().

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

References m_fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), LTSPICE_SCH_PARSER::CreateFields(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_ALTIUM_PLUGIN::ParseParameter(), SetExcludeFromSim(), and UpdateFields().

AddHierarchicalReference() [1/2]

void SCH_SYMBOL::AddHierarchicalReference	(	const KIID_PATH &	aPath,
		const wxString &	aRef,
		int	aUnit
	)

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

References KIID::AsString(), KIID_PATH::AsString(), m_fields, m_instanceReferences, SCH_SYMBOL_INSTANCE::m_Path, SCH_SYMBOL_INSTANCE::m_Reference, SCH_SYMBOL_INSTANCE::m_Unit, m_unit, EDA_ITEM::m_Uuid, REFERENCE_FIELD, and traceSchSheetPaths.

Referenced by SCH_SHEET_PATH::AddNewSymbolInstances(), AddSheetPathReferenceEntryIfMissing(), SCH_SCREEN::SetLegacySymbolInstanceData(), SetRef(), SetUnitSelection(), and SCH_SHEET_LIST::UpdateSymbolInstanceData().

AddHierarchicalReference() [2/2]

void SCH_SYMBOL::AddHierarchicalReference

(

const SCH_SYMBOL_INSTANCE &

aInstance

)

Definition at line 643 of file sch_symbol.cpp.

References KIID::AsString(), KIID_PATH::AsString(), m_fields, m_instanceReferences, SCH_SYMBOL_INSTANCE::m_Path, SCH_SYMBOL_INSTANCE::m_Reference, SCH_SYMBOL_INSTANCE::m_Unit, m_unit, EDA_ITEM::m_Uuid, REFERENCE_FIELD, and traceSchSheetPaths.

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

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

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

Referenced by SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), SCH_SHEET::SCH_SHEET(), SCH_EDIT_FRAME::SelectUnit(), and DIALOG_LABEL_PROPERTIES::TransferDataFromWindow().

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 734 of file autoplace_fields.cpp.

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

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), and SCH_DRAWING_TOOLS::PlaceSymbol().

CanConnect()

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

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 682 of file sch_symbol.h.

References SCH_ITEM::GetLayer(), LAYER_WIRE, SCH_DIRECTIVE_LABEL_T, 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 115 of file sch_symbol.h.

References SCH_SYMBOL_T, and EDA_ITEM::Type().

ClearAnnotation()

void SCH_SYMBOL::ClearAnnotation	(	const SCH_SHEET_PATH *	aSheetPath,
		bool	aResetPrefix
	)

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.
[in]	aResetPrefix	The annotation prefix ('R', 'U', etc.) should be reset to the symbol library prefix.

Definition at line 1354 of file sch_symbol.cpp.

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(), SCH_DRAWING_TOOLS::PlaceSymbol(), and SCH_EDITOR_CONTROL::updatePastedSymbol().

ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by FOOTPRINT_DIFF_WIDGET::DisplayDiff(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), and PCB_SELECTION_TOOL::unhighlightInternal().

ClearBrightenedPins()

void SCH_SYMBOL::ClearBrightenedPins

(

)

Definition at line 2365 of file sch_symbol.cpp.

References m_pins, and pin.

Referenced by SCH_EDITOR_CONTROL::UpdateNetHighlighting().

ClearCaches()

void SCH_ITEM::ClearCaches ( )

virtualinherited

Reimplemented in SCH_FIELD.

Definition at line 259 of file sch_item.cpp.

References SCH_ITEM::RunOnChildren(), and text.

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

References SCH_ITEM::m_connections.

ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 142 of file eda_item.h.

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

Referenced by BOARD::Add(), FOOTPRINT::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SYMBOL_EDITOR_MOVE_TOOL::Main(), 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 433 of file sch_item.h.

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_LABEL_BASE::SCH_LABEL_BASE(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS  aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 125 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), 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(), BOARD_COMMIT::dirtyIntersectingZones(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Init(), EE_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetIsShownAsBitmap(), SCHEMATIC_COMMIT::Stage(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

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

ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 137 of file eda_item.h.

References CANDIDATE, EDA_ITEM::ClearFlags(), IS_LINKED, SELECTED_BY_DRAG, and SKIP_STRUCT.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::PutDataInPreviousState().

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

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 195 of file sch_item.cpp.

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE::FindWireSegmentNetNameRecursive(), 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 147 of file sch_item.cpp.

References SCHEMATIC::CurrentSheet(), SCH_ITEM::IsConnectable(), SCH_ITEM::IsConnectivityDirty(), 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(), CONNECTION_GRAPH::GetBusesNeedingMigration(), SCH_ITEM::GetEffectiveNetClass(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_JUNCTION::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), SCH_ITEM::GetOrInitConnection(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_TEXT::Plot(), SCH_LABEL_BASE::Print(), NETLIST_EXPORTER_SPICE_MODEL::readPorts(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_LABEL_BASE::ResolveTextVar(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDITOR_CONTROL::SimProbe(), 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, SCH_LINE, and SCH_PIN.

Definition at line 414 of file sch_item.h.

doGetBoundingBox()

BOX2I SCH_SYMBOL::doGetBoundingBox ( bool  aIncludePins, bool  aIncludeFields  ) const

private

Definition at line 1650 of file sch_symbol.cpp.

References dummy, BOX2< Vec >::GetBottom(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), m_convert, m_fields, m_part, m_pos, m_transform, m_unit, BOX2< Vec >::Merge(), BOX2< Vec >::Normalize(), BOX2< Vec >::Offset(), BOX2< Vec >::SetHeight(), BOX2< Vec >::SetWidth(), BOX2< Vec >::SetX(), BOX2< Vec >::SetY(), TRANSFORM::x1, TRANSFORM::x2, TRANSFORM::y1, and TRANSFORM::y2.

Referenced by GetBodyAndPinsBoundingBox(), GetBodyBoundingBox(), and GetBoundingBox().

DoHypertextAction()

virtual void SCH_ITEM::DoHypertextAction ( EDA_DRAW_FRAME *  aFrame ) const

inlinevirtualinherited

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 244 of file sch_item.h.

doIsConnected()

bool SCH_SYMBOL::doIsConnected ( const VECTOR2I &  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 VECTOR2I object containing the test position.

Returns

True if connection to aPosition exists.

Reimplemented from SCH_ITEM.

Definition at line 2196 of file sch_symbol.cpp.

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

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

Referenced by SCH_LINE::BreakAt(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_LINE_WIRE_BUS_TOOL::startSegments().

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

References m_fields, and MANDATORY_FIELDS.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), LTSPICE_SCH_PARSER::CreateFields(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SetExcludeFromSim(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and UpdateFields().

Get() [1/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

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

Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE *  aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

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(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PROPERTIES_PANEL::getItemValue(), and PCB_EXPR_VAR_REF::GetValue().

Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE *  aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

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

GetAllLibPins()

std::vector< LIB_PIN * > SCH_SYMBOL::GetAllLibPins

(

)

const

Returns

a list of pin pointers for all units / converts. Used primarily for SPICE where we want to treat all units together as a single SPICE element.

Definition at line 1088 of file sch_symbol.cpp.

References m_part.

Referenced by LEGACY_POWER_SYMBOLS_TEST_FIXTURE::CheckSymbols(), SIM_LIB_MGR::CreateModel(), SCH_SCREEN::FixLegacyPowerSymbolMismatches(), GetFullPinCount(), and IsSymbolLikePowerGlobalLabel().

GetBodyAndPinsBoundingBox()

BOX2I SCH_SYMBOL::GetBodyAndPinsBoundingBox

(

)

const

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

Definition at line 1701 of file sch_symbol.cpp.

References doGetBoundingBox().

Referenced by KIGFX::SCH_PAINTER::draw(), AUTOPLACER::getPossibleCollisions(), EE_SELECTION_TOOL::GuessSelectionCandidates(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), operator<(), PlotDNP(), and Print().

GetBodyBoundingBox()

BOX2I SCH_SYMBOL::GetBodyBoundingBox

(

)

const

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

Definition at line 1695 of file sch_symbol.cpp.

References doGetBoundingBox().

Referenced by AUTOPLACER::AUTOPLACER(), KIGFX::SCH_PAINTER::draw(), EE_SELECTION_TOOL::GuessSelectionCandidates(), and HitTest().

GetBoundingBox()

const BOX2I 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 1707 of file sch_symbol.cpp.

References doGetBoundingBox().

Referenced by SCH_EDITOR_CONTROL::FindSymbolAndItem(), and Plot().

GetClass()

wxString SCH_SYMBOL::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 120 of file sch_symbol.h.

Referenced by operator=().

GetConnectionPoints()

std::vector< VECTOR2I > 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 1970 of file sch_symbol.cpp.

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

References m_fields, and MANDATORY_FIELDS.

Referenced by DIALOG_TEXT_PROPERTIES::getContextualTextVars(), and DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded().

GetConvert()

int SCH_SYMBOL::GetConvert ( ) const

inline

Definition at line 273 of file sch_symbol.h.

References m_convert.

Referenced by SCH_EDIT_TOOL::ConvertDeMorgan(), SCH_EDIT_FRAME::ConvertPart(), EE_INSPECTION_TOOL::DiffSymbol(), doIsConnected(), KIGFX::SCH_PAINTER::draw(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), GetConnectionPoints(), IsPointClickableAnchor(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), Plot(), PlotPins(), SCH_EDIT_TOOL::Properties(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), ERC_TESTER::TestMissingUnits(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), and Visit().

GetDatasheet()

wxString SCH_SYMBOL::GetDatasheet

(

)

const

Return the documentation text for the given part alias.

Definition at line 330 of file sch_symbol.cpp.

References m_part.

Referenced by UpdateFields().

GetDefaultFont()

const wxString & SCH_ITEM::GetDefaultFont ( ) const

inherited

Definition at line 294 of file sch_item.cpp.

References EESCHEMA_SETTINGS::APPEARANCE::default_font, EESCHEMA_SETTINGS::m_Appearance, and Pgm().

Referenced by SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), SCH_FIELD::GetRenderCache(), and SCH_TEXTBOX::GetShownText().

GetDescription()

wxString SCH_SYMBOL::GetDescription

(

)

const

Returns

the associated LIB_SYMBOL's description field (or wxEmptyString).

Definition at line 312 of file sch_symbol.cpp.

References m_part.

Referenced by NETLIST_EXPORTER_XML::makeSymbols(), and ResolveTextVar().

GetDNP()

bool SCH_SYMBOL::GetDNP ( ) const

inline

Definition at line 767 of file sch_symbol.h.

References m_DNP.

Referenced by BACK_ANNOTATE::applyChangelist(), KIGFX::SCH_PAINTER::draw(), GetMsgPanelInfo(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_FIELD::Plot(), Plot(), PlotPins(), SCH_FIELD::Print(), Print(), PrintBackground(), FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), ResolveTextVar(), SCH_SEXPR_PLUGIN::saveSymbol(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

GetDrawItem()

LIB_ITEM * SCH_SYMBOL::GetDrawItem	(	const VECTOR2I &	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 1994 of file sch_symbol.cpp.

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

References IS_BROKEN, IS_CHANGED, IS_MOVING, IS_NEW, IS_PASTED, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), 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_FRAME::SelectUnit(), DIALOG_IMAGE_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

GetEffectiveNetClass()

std::shared_ptr< NETCLASS > SCH_ITEM::GetEffectiveNetClass ( const SCH_SHEET_PATH *  aSheet = nullptr ) const

inherited

Definition at line 174 of file sch_item.cpp.

References SCH_ITEM::Connection(), PROJECT::GetProjectFile(), PROJECT_FILE::m_NetSettings, SCH_CONNECTION::Name(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

Referenced by BOOST_AUTO_TEST_CASE(), SCH_BUS_ENTRY_BASE::GetBusEntryColor(), SCH_LINE::GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_FIELD::GetFieldColor(), SCH_JUNCTION::GetJunctionColor(), SCH_LABEL_BASE::GetLabelColor(), SCH_LINE::GetLineColor(), SCH_BUS_ENTRY_BASE::GetLineStyle(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_JUNCTION::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), and SCH_LABEL_BASE::ResolveTextVar().

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

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

GetExcludeFromSim()

bool SCH_SYMBOL::GetExcludeFromSim ( ) const

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 537 of file sch_symbol.cpp.

References GetFieldText(), and SIM_ENABLE_FIELD.

Referenced by GetMsgPanelInfo(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), and ERC_TESTER::TestSimModelIssues().

GetField() [1/2]

const SCH_FIELD * SCH_SYMBOL::GetField

(

MANDATORY_FIELD_T

aFieldNdx

)

const

Definition at line 897 of file sch_symbol.cpp.

References m_fields.

GetField() [2/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 891 of file sch_symbol.cpp.

References m_fields.

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_SHEET_PATH::AddNewSymbolInstances(), NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDITOR_CONTROL::AssignFootprints(), LEGACY_POWER_SYMBOLS_TEST_FIXTURE::CheckSymbols(), LTSPICE_SCH_PARSER::CreateFields(), LTSPICE_SCH_PARSER::CreatePowerSymbol(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), EE_INSPECTION_TOOL::DiffSymbol(), SCH_EDIT_TOOL::EditField(), GetFootprintFieldText(), GetItemDescription(), SCH_PIN::GetMsgPanelInfo(), GetMsgPanelInfo(), GetRef(), SYMBOL_SEARCH_HANDLER::GetResultCell(), GetValueFieldText(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), SCH_FIELD::Replace(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), SCH_SHEET::SymbolCount(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_EDITOR_CONTROL::updatePastedSymbol(), UpdatePrefix(), SCH_SHEET_LIST::UpdateSymbolInstanceData(), Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

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

References m_fields.

Referenced by SCH_SYMBOL(), and UpdateFields().

GetFieldByName()

SCH_FIELD * SCH_SYMBOL::GetFieldByName

(

const wxString &

aFieldName

)

Return a field in this symbol.

Parameters

aFieldName

is the name of the field

Returns

is the field with aFieldName or NULL if the field does not exist.

Definition at line 915 of file sch_symbol.cpp.

References m_fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::GetValue(), and FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch().

GetFieldCount()

int SCH_SYMBOL::GetFieldCount ( ) const

inline

Return the number of fields in this symbol.

Definition at line 500 of file sch_symbol.h.

References m_fields.

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

GetFields() [1/3]

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

inline

Return a vector of fields from the symbol.

Definition at line 435 of file sch_symbol.h.

References m_fields.

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

GetFields() [2/3]

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

inline

Definition at line 436 of file sch_symbol.h.

References m_fields.

GetFields() [3/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 939 of file sch_symbol.cpp.

References m_fields.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), AUTOPLACER::AUTOPLACER(), SIM_LIB_MGR::CreateModel(), EE_INSPECTION_TOOL::DiffSymbol(), KIGFX::SCH_PAINTER::draw(), EESCHEMA_JOBS_HANDLER::JobExportBom(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_FIND_REPLACE_TOOL::nextMatch(), operator==(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), SYMBOL_SEARCH_HANDLER::Search(), ERC_TESTER::TestTextVars(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_CHANGE_SYMBOLS::updateFieldsList(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), SIMULATOR_FRAME::UpdateTunerValue(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const

inlineinherited

Return whether the fields have been automatically placed.

Definition at line 430 of file sch_item.h.

References SCH_ITEM::m_fieldsAutoplaced.

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

GetFieldText()

wxString SCH_SYMBOL::GetFieldText

(

const wxString &

aFieldName

)

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

References m_fields.

Referenced by GetExcludeFromSim(), SCH_ALTIUM_PLUGIN::ParseParameter(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 126 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), collidesWithArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), BOARD_COMMIT::dirtyIntersectingZones(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), LIB_PIN::GetMsgPanelInfo(), LIB_SYMBOL::LIB_SYMBOL(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD_TOOL::RecombinePad(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), 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 VECTOR2I 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 239 of file eda_item.h.

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

GetFootprintFieldText()

const wxString SCH_SYMBOL::GetFootprintFieldText	(	bool	aResolve,
		const SCH_SHEET_PATH *	aPath,
		bool	aAllowExtraText
	)		const

Definition at line 875 of file sch_symbol.cpp.

References FOOTPRINT_FIELD, GetField(), SCH_FIELD::GetShownText(), and EDA_TEXT::GetText().

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), netList(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 150 of file view_item.h.

References KIGFX::VIEW_ITEM::m_forcedTransparency.

Referenced by EDA_ITEM::EDA_ITEM(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), and EDA_ITEM::operator=().

GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, PCB_TRACK, and ZONE.

Definition at line 310 of file eda_item.cpp.

References EDA_ITEM::GetTypeDesc().

Referenced by PROPERTIES_PANEL::rebuildProperties().

GetFullPinCount()

size_t SCH_SYMBOL::GetFullPinCount ( )

inline

Returns

a count of pins for all units / converts.

Definition at line 543 of file sch_symbol.h.

References GetAllLibPins().

GetIncludeInBom()

bool SCH_SYMBOL::GetIncludeInBom ( ) const

inline

Definition at line 761 of file sch_symbol.h.

References m_inBom.

Referenced by BACK_ANNOTATE::applyChangelist(), GetMsgPanelInfo(), NETLIST_EXPORTER_XML::makeListOfNets(), NETLIST_EXPORTER_XML::makeSymbols(), FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), ResolveTextVar(), SCH_SEXPR_PLUGIN::saveSymbol(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

GetIncludeOnBoard()

bool SCH_SYMBOL::GetIncludeOnBoard ( ) const

inline

Definition at line 764 of file sch_symbol.h.

References m_onBoard.

Referenced by BACK_ANNOTATE::checkForUnusedSymbols(), CONNECTION_SUBGRAPH::GetDriverPriority(), GetMsgPanelInfo(), NETLIST_EXPORTER_XML::makeListOfNets(), NETLIST_EXPORTER_XML::makeSymbols(), ResolveTextVar(), SCH_SEXPR_PLUGIN::saveSymbol(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

GetInstance()

bool SCH_SYMBOL::GetInstance	(	SCH_SYMBOL_INSTANCE &	aInstance,
		const KIID_PATH &	aSheetPath,
		bool	aTestFromEnd = false
	)		const

Definition at line 543 of file sch_symbol.cpp.

References m_instanceReferences.

Referenced by SCH_SHEET_PATH::AddNewSymbolInstances().

GetInstanceReferences()

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

inline

Definition at line 140 of file sch_symbol.h.

References m_instanceReferences.

Referenced by SCH_SHEET_PATH::AddNewSymbolInstances(), DIALOG_CHANGE_SYMBOLS::getSymbolReferences(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), and SCH_SCREEN::SetLegacySymbolInstanceData().

GetItemDescription()

wxString SCH_SYMBOL::GetItemDescription ( UNITS_PROVIDER *  aUnitsProvider ) const

overridevirtual

Return a user-visible description string of this item.

This description is used in disambiguation menus, the message panel, ERC/DRC reports, etc.

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

References _, KIUI::EllipsizeMenuText(), GetField(), GetLibId(), and REFERENCE_FIELD.

GetKeyWords()

wxString SCH_SYMBOL::GetKeyWords

(

)

const

Returns

the associated LIB_SYMBOL's keywords field (or wxEmptyString).

Definition at line 321 of file sch_symbol.cpp.

References m_part.

Referenced by ResolveTextVar().

GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 249 of file sch_item.h.

References SCH_ITEM::m_layer.

Referenced by SCH_ITEM::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL_BASE::CanConnect(), SCH_LINE::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_SHEET::CanConnect(), CanConnect(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), DIALOG_IMAGE_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_SCREEN::doIsJunction(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_LINE::IsBus(), SCH_LINE::IsGraphicLine(), SCH_LINE::IsWire(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_LINE::operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_JUNCTION::Plot(), SCH_LINE::Plot(), SCH_JUNCTION::Print(), SCH_LINE::Print(), SCH_LEGACY_PLUGIN::saveBusEntry(), SCH_LEGACY_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveText(), SCH_EDIT_FRAME::TrimWire(), and CONNECTION_GRAPH::updateItemConnectivity().

GetLibId()

const LIB_ID & SCH_SYMBOL::GetLibId ( ) const

inline

Definition at line 178 of file sch_symbol.h.

References m_lib_id.

Referenced by SCH_SCREEN::Append(), SCH_SCREENS::ChangeSymbolLibNickname(), CollectOtherUnits(), SCH_REFERENCE::CompareLibName(), SCH_EDIT_FRAME::CreateArchiveLibrary(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), EE_INSPECTION_TOOL::DiffSymbol(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SEXPR_PLUGIN::Format(), GetItemDescription(), SCH_SCREENS::GetLibNicknames(), SCH_SCREEN::getLibSymbolNameMatches(), GetMsgPanelInfo(), SYMBOL_CANDIDATE::GetStringLibId(), DIALOG_CHANGE_SYMBOLS::getSymbolReferences(), SCH_SCREENS::HasNoFullyDefinedLibIds(), DIALOG_CHANGE_SYMBOLS::isMatch(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), NETLIST_EXPORTER_XML::makeSymbols(), DIALOG_CHANGE_SYMBOLS::processMatchingSymbols(), SCH_EDIT_TOOL::Properties(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_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_FIELD_PROPERTIES::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 1081 of file sch_symbol.cpp.

References m_convert, m_part, and m_unit.

Referenced by SCH_SCREEN::GetPin().

GetLibSymbolRef() [1/2]

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

inline

Definition at line 195 of file sch_symbol.h.

References m_part.

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_REFERENCE::AlwaysAnnotate(), SCH_SHEET_LIST::AnnotatePowerSymbols(), SCH_SCREEN::Append(), SCH_SHEET_PATH::AppendMultiUnitSymbol(), SCH_SHEET_PATH::AppendSymbol(), LEGACY_POWER_SYMBOLS_TEST_FIXTURE::CheckSymbols(), SCH_EDIT_FRAME::ConvertPart(), NETLIST_EXPORTER_BASE::CreatePinList(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), EE_INSPECTION_TOOL::DiffSymbol(), KIGFX::SCH_PAINTER::draw(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SCH_SCREEN::FixLegacyPowerSymbolMismatches(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_SCREEN::GetPin(), highlightNet(), IsSymbolLikePowerGlobalLabel(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), NETLIST_EXPORTER_XML::makeSymbols(), DIALOG_SYMBOL_PROPERTIES::onUpdateEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::onUpdateEditSymbol(), SCH_DRAWING_TOOLS::PlaceSymbol(), 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 196 of file sch_symbol.h.

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

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

aFrame	is the EDA_DRAW_FRAME that displays the message panel
aList	is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 1713 of file sch_symbol.cpp.

References _, dummy, KIUI::EllipsizeStatusText(), UTF8::empty(), FOOTPRINT_FIELD, SCH_EDIT_FRAME::GetCurrentSheet(), GetDNP(), EDA_ITEM::GetEditFlags(), GetExcludeFromSim(), GetField(), GetIncludeInBom(), GetIncludeOnBoard(), GetLibId(), LIB_ID::GetLibNickname(), GetRef(), m_lib_id, m_part, UnescapeString(), and VALUE_FIELD.

GetOrientation()

int SCH_SYMBOL::GetOrientation

(

)

const

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

References GetTransform(), m_transform, s_transformToOrientationCache, 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(), SCH_SCREEN::GetLabelOrientationForPoint(), AUTOPLACER::getPreferredSides(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), orientLabel(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_EDIT_TOOL::Swap(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

GetOrInitConnection()

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

inherited

Definition at line 236 of file sch_item.cpp.

References SCH_ITEM::Connection(), SCH_ITEM::InitializeConnection(), SCH_ITEM::IsConnectable(), and SCH_ITEM::SetConnectivityDirty().

GetParent()

EDA_ITEM * EDA_ITEM::GetParent ( ) const

inlineinherited

Definition at line 99 of file eda_item.h.

References EDA_ITEM::m_parent.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::editFieldText(), SCH_PIN::GetDefaultNetName(), SCH_FIELD::GetFieldColor(), getInferredSymbols(), SCH_PIN::GetParentSymbol(), EE_SELECTION_TOOL::highlight(), highlightNet(), SCH_FIELD::HitTest(), SCH_PIN::IsStacked(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), SCHEMATIC_COMMIT::parentObject(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCHEMATIC_COMMIT::pushSchEdit(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCHEMATIC_COMMIT::Revert(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_ITEM::Schematic(), SCH_SCREEN::Schematic(), SCH_SHEET::SearchHierarchy(), PCB_SELECTION_TOOL::select(), SCHEMATIC_COMMIT::Stage(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), EE_SELECTION_TOOL::unhighlight(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), EE_TOOL_BASE< T >::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_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_DIRECTIVE_LABEL, SCH_LINE, SCH_NO_CONNECT, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 266 of file sch_item.h.

Referenced by EE_RTREE::contains(), KIGFX::SCH_PAINTER::draw(), SCH_BUS_ENTRY_BASE::GetBoundingBox(), KIGFX::SCH_PAINTER::getLineWidth(), SCH_BUS_ENTRY_BASE::HitTest(), EE_RTREE::insert(), SCH_BUS_ENTRY_BASE::Plot(), SCH_BUS_ENTRY_BASE::Print(), and EE_RTREE::remove().

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

References m_pins, and pin.

Referenced by BACK_ANNOTATE::applyChangelist(), KIGFX::SCH_PAINTER::draw(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), Plot(), PlotPins(), Print(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

GetPin() [2/2]

SCH_PIN * SCH_SYMBOL::GetPin

(

LIB_PIN *

aLibPin

)

const

Returns

the SCH_PIN associated with a particular LIB_PIN.

Definition at line 1099 of file sch_symbol.cpp.

References m_pinMap, and m_pins.

GetPinPhysicalPosition()

VECTOR2I SCH_SYMBOL::GetPinPhysicalPosition

(

const LIB_PIN *

Pin

)

const

Definition at line 1961 of file sch_symbol.cpp.

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

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_EAGLE_PLUGIN::checkConnections(), GetEndPoints(), 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 1106 of file sch_symbol.cpp.

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

Referenced by NETLIST_EXPORTER_BASE::CreatePinList(), AUTOPLACER::fieldBoxPlacement(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), findSymbolsAndPins(), SCH_PIN::GetDefaultNetName(), SCH_SCREEN::GetLabelOrientationForPoint(), highlightNet(), netList(), SCH_FIND_REPLACE_TOOL::nextMatch(), SCH_EDITOR_CONTROL::Paste(), AUTOPLACER::pinsOnSide(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), ERC_TESTER::TestNoConnectPins(), ERC_TESTER::TestOffGridEndpoints(), CONNECTION_GRAPH::updateItemConnectivity(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

GetPosition()

VECTOR2I SCH_SYMBOL::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 726 of file sch_symbol.h.

References m_pos.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), EE_INSPECTION_TOOL::DiffSymbol(), KIGFX::SCH_PAINTER::draw(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_FIELD::GetPosition(), GetRelativePosition(), SYMBOL_SEARCH_HANDLER::GetResultCell(), SCH_PIN::GetTransformedPosition(), EE_SELECTION_TOOL::GuessSelectionCandidates(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), DIALOG_ERC::OnRunERCClick(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_REFERENCE::SCH_REFERENCE(), SCH_FIELD::SetPosition(), ERC_TESTER::TestLibSymbolIssues(), ERC_TESTER::TestMissingUnits(), ERC_TESTER::TestMultiunitFootprints(), ERC_TESTER::TestSimModelIssues(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

GetPrefix()

wxString SCH_SYMBOL::GetPrefix ( ) const

inline

Definition at line 277 of file sch_symbol.h.

References m_prefix.

Referenced by SCH_LEGACY_PLUGIN::saveSymbol().

GetRawPins()

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

inline

Definition at line 561 of file sch_symbol.h.

References m_pins.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), and SCH_SEXPR_PLUGIN::saveSymbol().

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

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

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SIMULATOR_FRAME::AddTuner(), SCH_REFERENCE::AlwaysAnnotate(), SCH_EDIT_FRAME::AnnotateSymbols(), SCH_SHEET_PATH::AppendMultiUnitSymbol(), SCH_SHEET_PATH::AppendSymbol(), TEST_SCH_REFERENCE_LIST_FIXTURE::checkAnnotation(), SCHEMATIC::ConvertKIIDsToRefs(), SCHEMATIC::ConvertRefsToKIIDs(), SIM_LIB_MGR::CreateModel(), NETLIST_EXPORTER_BASE::CreatePinList(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), NETLIST_EXPORTER_BASE::findNextSymbol(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), SCH_PIN::GetDefaultNetName(), SCH_PIN::GetMsgPanelInfo(), GetMsgPanelInfo(), SYMBOL_SEARCH_HANDLER::GetResultCell(), DIALOG_EDIT_SYMBOLS_LIBID::initDlg(), DIALOG_CHANGE_SYMBOLS::isMatch(), TEST_SCH_REFERENCE_LIST_FIXTURE::loadTestCase(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_FIELD::Matches(), netList(), Plot(), NETLIST_EXPORTER_SPICE::readModel(), NETLIST_EXPORTER_SPICE::readRefName(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SCH_REFERENCE_LIST::ReannotateByOptions(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), SCH_FIELD::Replace(), SCHEMATIC::ResolveCrossReference(), ResolveTextVar(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCH_REFERENCE::SCH_REFERENCE(), SCH_EDITOR_CONTROL::SimProbe(), ERC_TESTER::TestMultiunitFootprints(), ERC_TESTER::TestSimModelIssues(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

GetSchSymbolLibraryName()

wxString SCH_SYMBOL::GetSchSymbolLibraryName

(

)

const

Definition at line 294 of file sch_symbol.cpp.

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(), and SCH_SEXPR_PLUGIN::saveSymbol().

GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

Return the coordinates that should be used for sorting this element visually compared to other elements.

For instance, for lines the midpoint might be a better sorting point than either end.

Returns

X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 248 of file eda_item.h.

References EDA_ITEM::GetPosition().

GetStoredPos()

VECTOR2I & SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 212 of file sch_item.h.

References SCH_ITEM::m_storedPos.

GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 463 of file sch_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

GetTransform() [1/2]

TRANSFORM & SCH_SYMBOL::GetTransform ( )

inline

Definition at line 286 of file sch_symbol.h.

References m_transform.

Referenced by AUTOPLACER::computeFBoxSize(), KIGFX::SCH_PAINTER::draw(), SCH_FIELD::GetBoundingBox(), SCH_PIN::GetBoundingBox(), SCH_FIELD::GetDrawRotation(), GetOrientation(), AUTOPLACER::getPinSide(), SCH_FIELD::GetPosition(), GetRelativePosition(), SCH_PIN::GetTransformedPosition(), EE_SELECTION_TOOL::GuessSelectionCandidates(), SCH_MOVE_TOOL::moveItem(), SCH_FIELD::Plot(), Plot(), PlotPins(), SCH_FIELD::Print(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_LEGACY_PLUGIN::saveSymbol(), and SCH_FIELD::SetPosition().

GetTransform() [2/2]

const TRANSFORM & SCH_SYMBOL::GetTransform ( ) const

inline

Definition at line 287 of file sch_symbol.h.

References m_transform.

GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

Return a translated description of the type for this EDA_ITEM for display in user facing messages.

Definition at line 301 of file eda_item.cpp.

References ENUM_MAP< T >::Instance(), and EDA_ITEM::Type().

Referenced by PCB_GROUP::AddItem(), EDIT_TOOL::doMoveSelection(), and EDA_ITEM::GetFriendlyName().

GetUnit()

int SCH_SYMBOL::GetUnit ( ) const

inline

Definition at line 231 of file sch_symbol.h.

References m_unit.

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_SHEET_PATH::AddNewSymbolInstances(), SCH_EDIT_FRAME::AnnotateSymbols(), EE_INSPECTION_TOOL::DiffSymbol(), doIsConnected(), KIGFX::SCH_PAINTER::draw(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), GetConnectionPoints(), SCH_FIELD::GetShownText(), IsPointClickableAnchor(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCH_FIELD::Matches(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), SCH_DRAWING_TOOLS::PlaceSymbol(), Plot(), PlotPins(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_EDIT_TOOL::Properties(), CONNECTION_GRAPH::Recalculate(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), SYMBOL_UNIT_MENU::update(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and Visit().

GetUnitCount()

int SCH_SYMBOL::GetUnitCount

(

)

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

References m_part.

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

GetUnitDisplayName()

wxString SCH_SYMBOL::GetUnitDisplayName

(

int

aUnit

)

Return the display name for a given unit aUnit.

Returns

the display name of a unit if set, or the ordinal name of the unit otherwise.

Definition at line 436 of file sch_symbol.cpp.

References _, m_part, and LIB_SYMBOL::SubReference().

Referenced by 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 817 of file sch_symbol.cpp.

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

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), KIGFX::SCH_PAINTER::draw(), GetPins(), CONNECTION_GRAPH::Recalculate(), ResolveTextVar(), SCH_REFERENCE::SCH_REFERENCE(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

GetValueFieldText()

const wxString SCH_SYMBOL::GetValueFieldText	(	bool	aResolve,
		const SCH_SHEET_PATH *	aPath,
		bool	aAllowExtraText
	)		const

Definition at line 859 of file sch_symbol.cpp.

References GetField(), SCH_FIELD::GetShownText(), EDA_TEXT::GetText(), and VALUE_FIELD.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), SCH_EDIT_FRAME::AnnotateSymbols(), netList(), SCH_REFERENCE::SCH_REFERENCE(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

HasBrightenedPins()

bool SCH_SYMBOL::HasBrightenedPins

(

)

Definition at line 2353 of file sch_symbol.cpp.

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

References EDA_ITEM::m_flags.

Referenced by GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), ZONE::IsConflicting(), SCH_MOVE_TOOL::Main(), SCH_SCREEN::MarkConnections(), SCH_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::orthoLineDrag(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), SCHEMATIC_COMMIT::pushLibEdit(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), and EE_SELECTION_TOOL::selectMultiple().

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_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 461 of file sch_item.h.

Referenced by SCH_EDIT_TOOL::Init(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

HasUnitDisplayName()

bool SCH_SYMBOL::HasUnitDisplayName

(

int

aUnit

)

Return true if the given unit aUnit has a display name set.

Returns

true if the display name of a unit is set, otherwise false.

Definition at line 444 of file sch_symbol.cpp.

References m_part.

Referenced by DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

HitTest() [1/2]

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

overridevirtual

Test if aRect intersects this item.

Parameters

aRect	A reference to a BOX2I 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 2180 of file sch_symbol.cpp.

References BOX2< Vec >::Contains(), GetBodyBoundingBox(), BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), EDA_ITEM::m_flags, SKIP_STRUCT, and STRUCT_DELETED.

HitTest() [2/2]

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

overridevirtual

Test if aPosition is inside or on the boundary of this item.

Parameters

aPosition	A reference to a VECTOR2I 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 2168 of file sch_symbol.cpp.

References BOX2< Vec >::Contains(), GetBodyBoundingBox(), and BOX2< Vec >::Inflate().

Init()

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

private

Definition at line 203 of file sch_symbol.cpp.

References LIB_ITEM::BASE, TEMPLATE_FIELDNAME::GetDefaultFieldName(), LAYER_DEVICE, LAYER_FIELDS, LAYER_REFERENCEPART, LAYER_VALUEPART, m_convert, m_fields, m_inBom, m_isInNetlist, SCH_ITEM::m_layer, 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 213 of file sch_item.cpp.

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

Referenced by SCH_ITEM::GetOrInitConnection().

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

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

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

IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_EDIT_FRAME::FocusOnItem(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::setDeviceColors(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

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

IsConnected()

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

inherited

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

Parameters

aPoint

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

Returns

True if connection to aPoint exists.

Definition at line 138 of file sch_item.cpp.

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

Referenced by SCH_SCREEN::doIsJunction(), SCH_MOVE_TOOL::getConnectedItems(), SCH_SCREEN::IsTerminalPoint(), and SCH_SCREEN::MarkConnections().

IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( ) const

inlineinherited

Definition at line 416 of file sch_item.h.

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_ITEM::Connection(), KIGFX::SCH_PAINTER::draw(), SCH_BUS_ENTRY_BASE::GetBusEntryColor(), SCH_LINE::GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_FIELD::GetFieldColor(), SCH_JUNCTION::GetJunctionColor(), SCH_LABEL_BASE::GetLabelColor(), SCH_LINE::GetLineColor(), SCH_BUS_ENTRY_BASE::GetLineStyle(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_JUNCTION::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), highlightNet(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LABEL_BASE, SCH_LINE, and SCH_PIN.

Definition at line 345 of file sch_item.h.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), and KIGFX::SCH_PAINTER::draw().

IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

References ENTERED, and EDA_ITEM::m_flags.

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

IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 184 of file eda_item.h.

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, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 242 of file sch_item.h.

Referenced by SCH_ITEM::RenderAsBitmap().

IsInNetlist()

bool SCH_SYMBOL::IsInNetlist

(

)

const

Returns

true if the symbol is in netlist.

Definition at line 2224 of file sch_symbol.cpp.

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

IsMissingLibSymbol()

bool SCH_SYMBOL::IsMissingLibSymbol

(

)

const

Check to see if the library symbol is set to the dummy library symbol.

When the library symbol is missing (which technically should not happen now that the library symbols are cached in the schematic file), a dummy library symbol is substituted for the missing symbol as an indicator that something is amiss. The dummy symbol cannot be edited so a check for this symbol must be performed before attempting to edit the library symbol with the library editor or it will crash KiCad.

See also

dummy()

Returns

true if the library symbol is missing or false if it is valid.

Definition at line 239 of file sch_symbol.cpp.

References m_part.

Referenced by SCH_EDITOR_CONTROL::EditWithSymbolEditor(), and SCH_EDIT_TOOL::Properties().

IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

IsMovableFromAnchorPoint()

bool SCH_SYMBOL::IsMovableFromAnchorPoint ( ) const

overridevirtual

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.

We now use this to keep poorly-formed symbols from getting dragged off-grid. If the symbol contains off-grid pins we will not allow it to be moved from its anchor.

Reimplemented from SCH_ITEM.

Definition at line 263 of file sch_symbol.cpp.

References m_pins, m_pos, EDA_IU_SCALE::MilsToIU(), pin, schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

References IS_MOVING, and EDA_ITEM::m_flags.

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

IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_MOVE_TOOL::getConnectedDragItems(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

IsPointClickableAnchor()

bool SCH_SYMBOL::IsPointClickableAnchor ( const VECTOR2I &  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 2372 of file sch_symbol.cpp.

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

IsPower()

bool SCH_SYMBOL::IsPower

(

)

const

Definition at line 2411 of file sch_symbol.cpp.

References m_part.

Referenced by NETLIST_EXPORTER_BASE::CreatePinList(), IsSymbolLikePowerGlobalLabel(), SYMBOL_SEARCH_HANDLER::Search(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

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

References UTIL::GetRefDesPrefix().

Referenced by DIALOG_FIELD_PROPERTIES::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 724 of file sch_symbol.h.

IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

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_TOOL::ChangeTextType(), 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(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), RENDER_3D_OPENGL::get3dModelsFromFootprint(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), KIGFX::SCH_PAINTER::nonCached(), SCH_MOVE_TOOL::orthoLineDrag(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), SCHEMATIC_COMMIT::pushLibEdit(), SCHEMATIC_COMMIT::pushSchEdit(), EE_SELECTION_TOOL::RebuildSelection(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), GERBVIEW_SELECTION_TOOL::unselect(), SCH_FIND_REPLACE_TOOL::UpdateFind(), HIERARCHY_PANE::UpdateHierarchySelection(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

IsSymbolLikePowerGlobalLabel()

bool SCH_SYMBOL::IsSymbolLikePowerGlobalLabel

(

)

const

Returns

true if the symbol is equivalent to a global label: It is a Power symbol It has only one pin type Power input

Definition at line 2393 of file sch_symbol.cpp.

References GetAllLibPins(), GetLibSymbolRef(), and IsPower().

Referenced by DIALOG_LABEL_PROPERTIES::TransferDataToWindow().

IsType()

bool SCH_ITEM::IsType ( const std::vector< KICAD_T > &  aScanTypes ) const

inlineoverridevirtualinherited

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 from EDA_ITEM.

Reimplemented in SCH_LABEL_BASE, and SCH_LINE.

Definition at line 162 of file sch_item.h.

References EDA_ITEM::IsType(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, SCH_ITEM::m_layer, SCH_ITEM_LOCATE_BUS_T, SCH_ITEM_LOCATE_GRAPHIC_LINE_T, SCH_ITEM_LOCATE_WIRE_T, SCH_LINE_T, and EDA_ITEM::Type().

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_FRAME::AutoRotateItem(), SCH_FIELD::IsType(), SCH_LABEL_BASE::IsType(), SCH_LINE::IsType(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 285 of file eda_item.h.

References EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 305 of file eda_item.h.

References EDA_ITEM::Visit().

Matches() [1/2]

bool SCH_SYMBOL::Matches ( const EDA_SEARCH_DATA &  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 1889 of file sch_symbol.cpp.

Referenced by SCH_DRAWING_TOOLS::PlaceSymbol().

Matches() [2/2]

bool EDA_ITEM::Matches ( const wxString &  aText, const EDA_SEARCH_DATA &  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 116 of file eda_item.cpp.

References EDA_SEARCH_DATA::findString, EDA_ITEM::IsReplaceable(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::searchAndReplace, and text.

MirrorHorizontally()

void SCH_SYMBOL::MirrorHorizontally ( int  aCenter )

overridevirtual

Mirror item horizontally about aCenter.

Implements SCH_ITEM.

Definition at line 1834 of file sch_symbol.cpp.

References m_fields, m_pos, MIRROR(), SetOrientation(), SYM_MIRROR_Y, and VECTOR2< T >::x.

MirrorVertically()

void SCH_SYMBOL::MirrorVertically ( int  aCenter )

overridevirtual

Mirror item vertically about aCenter.

Implements SCH_ITEM.

Definition at line 1852 of file sch_symbol.cpp.

References m_fields, m_pos, MIRROR(), SetOrientation(), SYM_MIRROR_X, and VECTOR2< T >::y.

Move()

void SCH_SYMBOL::Move ( const VECTOR2I &  aMoveVector )

inlineoverridevirtual

Move the item by aMoveVector to a new position.

Implements SCH_ITEM.

Definition at line 644 of file sch_symbol.h.

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

Referenced by LTSPICE_SCH_PARSER::CreateKicadSYMBOLs(), LTSPICE_SCH_PARSER::CreatePowerSymbol(), and SetPosition().

operator!=()

bool SCH_SYMBOL::operator!=

(

const SCH_SYMBOL &

aSymbol

)

const

Definition at line 2125 of file sch_symbol.cpp.

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

References EDA_ITEM::GetClass().

operator<() [2/2]

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

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 2088 of file sch_symbol.cpp.

References BOX2< Vec >::GetArea(), GetBodyAndPinsBoundingBox(), m_pos, EDA_ITEM::m_Uuid, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

operator=()

SCH_SYMBOL & SCH_SYMBOL::operator=

(

const SCH_ITEM &

aItem

)

Definition at line 2131 of file sch_symbol.cpp.

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

operator==()

bool SCH_SYMBOL::operator==

(

const SCH_SYMBOL &

aSymbol

)

const

Definition at line 2110 of file sch_symbol.cpp.

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

Plot()

void SCH_SYMBOL::Plot ( PLOTTER *  aPlotter, bool  aBackground  ) const

overridevirtual

Plot the schematic item to aPlotter.

Parameters

aPlotter	is the PLOTTER object to plot to.
aBackground	a poor-man's Z-order. The routine will get called twice, first with aBackground true and then with aBackground false.

Reimplemented from SCH_ITEM.

Definition at line 2230 of file sch_symbol.cpp.

References _, PLOTTER::Bookmark(), SCHEMATIC::CurrentSheet(), PLOTTER::EndBlock(), GetBoundingBox(), GetConvert(), GetDNP(), GetFields(), GetPin(), LIB_SYMBOL::GetPins(), GetRef(), SCH_PIN::GetShape(), SCH_PIN::GetShownName(), GetTransform(), SCH_PIN::GetType(), GetUnit(), PLOTTER::HyperlinkMenu(), IS_DANGLING, SCH_PIN::IsDangling(), m_DNP, m_fields, m_part, m_pos, LIB_SYMBOL::Plot(), PlotDNP(), SCH_ITEM::Schematic(), EDA_ITEM::SetFlags(), LIB_PIN::SetName(), LIB_PIN::SetShape(), LIB_PIN::SetType(), and PLOTTER::StartBlock().

PlotDNP()

void SCH_SYMBOL::PlotDNP

(

PLOTTER *

aPlotter

)

const

Plot the red 'X' over the symbol.

This is separated to allow it being used from the screen plot function, overlapping the pins

Parameters

aPlotter

the PLOTTER object used to draw the X

Definition at line 2305 of file sch_symbol.cpp.

References DEFAULT_LINE_WIDTH_MILS, FILLED, GetBodyAndPinsBoundingBox(), COLOR_SETTINGS::GetColor(), BOX2< Vec >::GetEnd(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetWidth(), LAYER_ERC_ERR, EDA_IU_SCALE::MilsToIU(), Pgm(), schIUScale, PLOTTER::SetColor(), and PLOTTER::ThickSegment().

Referenced by Plot().

PlotPins()

void SCH_SYMBOL::PlotPins

(

PLOTTER *

aPlotter

)

const

Plot just the symbol pins.

This is separated to match the GAL display order. The pins are ALSO plotted with the symbol group. This replotting allows us to ensure that they are shown above other elements in the schematic.

Parameters

aPlotter

is the PLOTTER object used to plot pins.

Definition at line 2324 of file sch_symbol.cpp.

References GetConvert(), GetDNP(), GetPin(), LIB_SYMBOL::GetPins(), SCH_PIN::GetShape(), SCH_PIN::GetShownName(), GetTransform(), SCH_PIN::GetType(), GetUnit(), m_part, m_pos, LIB_PIN::Plot(), LIB_PIN::SetName(), LIB_PIN::SetShape(), and LIB_PIN::SetType().

Print()

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

overridevirtual

Print a symbol.

Parameters

aSettings	Render settings controlling output
aOffset	is the drawing offset (usually VECTOR2I(0,0), but can be different when moving an object)

Implements SCH_ITEM.

Definition at line 464 of file sch_symbol.cpp.

References DEFAULT_LINE_WIDTH_MILS, LIB_SYMBOL_OPTIONS::draw_hidden_fields, LIB_SYMBOL_OPTIONS::draw_visible_fields, dummy, GetBodyAndPinsBoundingBox(), GetDNP(), BOX2< Vec >::GetEnd(), BOX2< Vec >::GetHeight(), KIGFX::RENDER_SETTINGS::GetLayerColor(), BOX2< Vec >::GetOrigin(), GetPin(), LIB_SYMBOL::GetPins(), KIGFX::RENDER_SETTINGS::GetPrintDC(), SCH_PIN::GetShape(), SCH_PIN::GetShownName(), SCH_PIN::GetType(), BOX2< Vec >::GetWidth(), GRFilledSegment(), LAYER_ERC_ERR, m_convert, m_DNP, m_fields, m_part, m_pos, m_transform, m_unit, EDA_IU_SCALE::MilsToIU(), LIB_SYMBOL::Print(), schIUScale, LIB_PIN::SetName(), LIB_PIN::SetShape(), LIB_PIN::SetType(), and LIB_SYMBOL_OPTIONS::transform.

PrintBackground()

void SCH_SYMBOL::PrintBackground ( const RENDER_SETTINGS *  aSettings, const VECTOR2I &  aOffset  )

overridevirtual

Print only the background parts of a symbol (if any)

Parameters

aSettings	Render settings controlling output
aOffset	is the drawing offset (usually VECTOR2I(0,0), but can be different when moving an object)

Reimplemented from SCH_ITEM.

Definition at line 452 of file sch_symbol.cpp.

References LIB_SYMBOL_OPTIONS::draw_hidden_fields, LIB_SYMBOL_OPTIONS::draw_visible_fields, GetDNP(), m_convert, m_part, m_pos, m_transform, m_unit, and LIB_SYMBOL_OPTIONS::transform.

RemoveAllInstances()

void SCH_SYMBOL::RemoveAllInstances ( )

inline

Definition at line 150 of file sch_symbol.h.

References m_instanceReferences.

RemoveField() [1/2]

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

References m_fields, and MANDATORY_FIELDS.

Referenced by SetExcludeFromSim().

RemoveField() [2/2]

void SCH_SYMBOL::RemoveField ( SCH_FIELD *  aField )

inline

Definition at line 454 of file sch_symbol.h.

References SCH_FIELD::GetName(), and RemoveField().

Referenced by RemoveField().

RemoveInstance()

void SCH_SYMBOL::RemoveInstance

(

const SCH_SHEET_PATH &

aInstancePath

)

Definition at line 567 of file sch_symbol.cpp.

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

Referenced by SCH_SHEET_PATH::RemoveSymbolInstances().

RenderAsBitmap()

bool SCH_ITEM::RenderAsBitmap ( double  aWorldScale ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 302 of file sch_item.cpp.

References BITMAP_FONT_SIZE_THRESHOLD, SCH_ITEM::IsHypertext(), and text.

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

Replace() [1/2]

virtual bool EDA_ITEM::Replace ( const EDA_SEARCH_DATA &  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 LIB_TEXTBOX, SCH_LABEL_BASE, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 392 of file eda_item.h.

Replace() [2/2]

bool EDA_ITEM::Replace ( const EDA_SEARCH_DATA &  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 167 of file eda_item.cpp.

References EDA_SEARCH_DATA::findString, EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::replaceString, and text.

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

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

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

ResolveTextVar()

bool SCH_SYMBOL::ResolveTextVar	(	const SCH_SHEET_PATH *	aPath,
		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 1202 of file sch_symbol.cpp.

References _, GetDescription(), GetDNP(), GetFootprintFieldText(), GetIncludeInBom(), GetIncludeOnBoard(), GetKeyWords(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SCHEMATIC::GetOperatingPoint(), GetRef(), TEMPLATES::GetTemplateFieldNames(), GetUnitSelection(), SCH_SHEET_PATH::Last(), m_fields, m_lib_id, SCHEMATIC_SETTINGS::m_TemplateFieldNames, MANDATORY_FIELDS, REFERENCE_FIELD, SCHEMATIC::ResolveCrossReference(), SCH_SHEET::ResolveTextVar(), SCH_ITEM::Schematic(), SCHEMATIC::Settings(), and LIB_SYMBOL::SubReference().

Referenced by KIGFX::SCH_PAINTER::expandLibItemTextVars(), and SCHEMATIC::ResolveCrossReference().

Rotate()

void SCH_SYMBOL::Rotate ( const VECTOR2I &  aCenter )

overridevirtual

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

Implements SCH_ITEM.

Definition at line 1870 of file sch_symbol.cpp.

References ANGLE_90, m_fields, m_pos, RotatePoint(), SetOrientation(), SYM_ROTATE_COUNTERCLOCKWISE, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_EDIT_TOOL::Rotate().

RunOnChildren()

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

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1059 of file sch_symbol.cpp.

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 113 of file sch_item.cpp.

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

Referenced by EE_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::ChangeTextType(), SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_SHEET::findSelf(), SCH_MARKER::GetColorLayer(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), SCH_SHEET::GetContextualTextVars(), SCH_ITEM::GetEffectiveNetClass(), SCH_JUNCTION::getEffectiveShape(), SCH_LABEL_BASE::GetIntersheetRefs(), SCH_LABEL_BASE::GetLabelBoxExpansion(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_NO_CONNECT::GetPenWidth(), SCH_SHAPE::GetPenWidth(), SCH_SHEET::GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), GetPins(), SCH_MARKER::GetSeverity(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_PIN::HitTest(), SCH_SHEET::IsRootSheet(), SCH_LABEL_BASE::IsType(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), Plot(), SCH_LABEL_BASE::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), ResolveTextVar(), SetRef(), SCH_EDITOR_CONTROL::SimTune(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), and SCH_MARKER::ViewGetLayers().

Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 66 of file inspectable.h.

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

Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 54 of file inspectable.h.

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

Set() [3/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

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

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 116 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), and PCB_SELECTION_TOOL::highlightInternal().

SetConnectionGraph()

void SCH_ITEM::SetConnectionGraph ( CONNECTION_GRAPH *  aGraph )

inherited

Updates the connection graph for all connections in this item.

Definition at line 167 of file sch_item.cpp.

References SCH_ITEM::m_connection_map, and path.

Referenced by CONNECTION_GRAPH::Merge().

SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool  aDirty = true )

inlineinherited

Definition at line 418 of file sch_item.h.

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_LINE::BreakAt(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_ITEM::GetOrInitConnection(), SCH_ITEM::InitializeConnection(), SCH_LINE::MergeOverlap(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and CONNECTION_GRAPH::updateItemConnectivity().

SetConvert()

void SCH_SYMBOL::SetConvert

(

int

aConvert

)

Definition at line 404 of file sch_symbol.cpp.

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

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

SetDNP()

void SCH_SYMBOL::SetDNP ( bool  aDNP )

inline

Definition at line 768 of file sch_symbol.h.

References m_DNP.

Referenced by BACK_ANNOTATE::applyChangelist(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

SetExcludeFromSim()

void SCH_SYMBOL::SetExcludeFromSim ( bool  aExclude )

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 519 of file sch_symbol.cpp.

References AddField(), FindField(), RemoveField(), EDA_TEXT::SetText(), and SIM_ENABLE_FIELD.

SetFields()

void SCH_SYMBOL::SetFields ( std::vector< SCH_FIELD > &  aFields )

inline

Set multiple schematic fields.

Parameters

aFields

are the fields to set in this symbol.

Definition at line 471 of file sch_symbol.h.

References m_fields.

SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )

inlineinherited

Definition at line 432 of file sch_item.h.

References FIELDS_AUTOPLACED_AUTO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_SEXPR_PARSER::parseSchText().

SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS  aMask )

inlineinherited

Definition at line 123 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SCH_ALTIUM_PLUGIN::AddTextBox(), SCH_MOVE_TOOL::AlignElements(), PCB_CONTROL::AppendBoard(), SCH_EDIT_FRAME::BreakSegment(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), SCH_EDIT_TOOL::ChangeTextType(), GRAPHICS_CLEANER::cleanupShapes(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), PCB_TOOL_BASE::doInteractiveItemPlacement(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::EnterGroup(), PAD_TOOL::explodePad(), SCH_MOVE_TOOL::getConnectedDragItems(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EE_COLLECTOR::Inspect(), CONVERT_TOOL::makePolysFromChainedSegs(), CONVERT_TOOL::makePolysFromClosedGraphics(), CONVERT_TOOL::makePolysFromOpenGraphics(), SCH_SCREEN::MarkConnections(), TRACKS_CLEANER::mergeCollinearSegments(), SCH_MOVE_TOOL::moveItem(), SYMBOL_EDITOR_MOVE_TOOL::moveItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), 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::ParseSignalHarness(), SCH_ALTIUM_PLUGIN::ParseWire(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), Plot(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::SelectAll(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), EDA_ITEM::SetIsShownAsBitmap(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCHEMATIC_COMMIT::Stage(), BOARD_COMMIT::Stage(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

SetFootprintFieldText()

void SCH_SYMBOL::SetFootprintFieldText

(

const wxString &

aFootprint

)

Definition at line 885 of file sch_symbol.cpp.

References FOOTPRINT_FIELD, and m_fields.

Referenced by BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_ALTIUM_PLUGIN::ParseImplementation(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), SCH_FIELD::Replace(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), UpdateFields(), and SCH_SHEET_LIST::UpdateSymbolInstanceData().

SetForcedTransparency()

void KIGFX::VIEW_ITEM::SetForcedTransparency ( double  aForcedTransparency )

inlineinherited

Definition at line 145 of file view_item.h.

References KIGFX::VIEW_ITEM::m_forcedTransparency.

Referenced by EDA_ITEM::EDA_ITEM(), SYMBOL_DIFF_WIDGET::onSlider(), FOOTPRINT_DIFF_WIDGET::onSlider(), and EDA_ITEM::operator=().

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

References EDA_ITEM::m_forceVisible.

Referenced by SCH_FIND_REPLACE_TOOL::FindNext(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

SetIncludeInBom()

void SCH_SYMBOL::SetIncludeInBom ( bool  aIncludeInBom )

inline

Definition at line 762 of file sch_symbol.h.

References m_inBom.

Referenced by BACK_ANNOTATE::applyChangelist(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

SetIncludeOnBoard()

void SCH_SYMBOL::SetIncludeOnBoard ( bool  aIncludeOnBoard )

inline

Definition at line 765 of file sch_symbol.h.

References m_onBoard.

Referenced by DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool  aBitmap )

inlineinherited

Definition at line 149 of file eda_item.h.

References EDA_ITEM::ClearFlags(), IS_SHOWN_AS_BITMAP, and EDA_ITEM::SetFlags().

SetLastResolvedState()

virtual void SCH_ITEM::SetLastResolvedState ( const SCH_ITEM *  aItem )

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, and SCH_LINE.

Definition at line 423 of file sch_item.h.

Referenced by SCH_EDITOR_CONTROL::Paste().

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

References SCH_ITEM::m_layer.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), LTSPICE_SCH_PARSER::CreateWire(), SCH_MOVE_TOOL::getConnectedDragItems(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), SCH_NO_CONNECT::SCH_NO_CONNECT(), SCH_SHAPE::SCH_SHAPE(), and SCH_FIELD::SetId().

SetLibId()

void SCH_SYMBOL::SetLibId

(

const LIB_ID &

aName

)

Definition at line 284 of file sch_symbol.cpp.

References m_lib_id, and EDA_ITEM::SetModified().

Referenced by SCH_SCREENS::ChangeSymbolLibNickname(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), 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 303 of file sch_symbol.cpp.

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

Referenced by SCH_SCREEN::Append(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EDITOR_CONTROL::Paste(), 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 237 of file sch_item.h.

SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 63 of file eda_item.cpp.

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(), PCB_PARSER::parseZONE(), 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 1444 of file sch_symbol.cpp.

References m_transform, SetOrientation(), 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 LTSPICE_SCH_PARSER::CreatePowerSymbol(), GetOrientation(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_EDIT_TOOL::Mirror(), MirrorHorizontally(), MirrorVertically(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), Rotate(), LTSPICE_SCH_PARSER::RotateMirror(), SetOrientation(), SCH_EDIT_TOOL::Swap(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM *  aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 100 of file eda_item.h.

References EDA_ITEM::m_parent.

Referenced by BOARD::Add(), FOOTPRINT::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveAnnotationBox(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), CADSTAR_SCH_ARCHIVE_LOADER::copySymbolItems(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_PLUGIN::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), LTSPICE_SCHEMATIC::Load(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), KI_TEST::LoadHierarchy(), LIB_SYMBOL::operator=(), FOOTPRINT::operator=(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCHEMATIC_COMMIT::pushLibEdit(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), CLIPBOARD_IO::SaveSelection(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_LABEL_BASE::SwapData(), SCH_SHEET::SwapData(), SwapData(), BOARD_ITEM::SwapItemData(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

SetPosition()

void SCH_SYMBOL::SetPosition ( const VECTOR2I &  aPosition )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 727 of file sch_symbol.h.

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

References m_prefix.

Referenced by UpdatePrefix().

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

References AddHierarchicalReference(), UTIL::GetRefDesPrefix(), m_fields, m_instanceReferences, m_isInNetlist, m_pins, m_prefix, m_unit, SCH_SHEET_PATH::Path(), path, pin, REFERENCE_FIELD, and SCH_ITEM::Schematic().

Referenced by SCH_REFERENCE::Annotate(), BACK_ANNOTATE::applyChangelist(), LTSPICE_SCH_PARSER::CreateFields(), LTSPICE_SCH_PARSER::CreatePowerSymbol(), GetRef(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_FIELD::Replace(), SCHEMATIC_COMMIT::Revert(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SYMBOL(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), UpdateFields(), and SCH_EDITOR_CONTROL::updatePastedSymbol().

SetSchSymbolLibraryName()

void SCH_SYMBOL::SetSchSymbolLibraryName ( const wxString &  aName )

inline

The name of the symbol in the schematic library symbol list.

Note

See SCH_SCREEN::m_libSymbols

The name of the schematic symbol list entry can vary from the item name in the LIB_ID object because the library symbol may have changed so a new name has to be generated but the original symbol library link has to be preserved in order to update it from the library at some point in the future. If this name is empty, then the library item name from LIB_ID is used.

Definition at line 191 of file sch_symbol.h.

References m_schLibSymbolName.

Referenced by SCH_SCREEN::Append().

SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 115 of file eda_item.h.

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), SCH_LINE::MergeOverlap(), DS_PROXY_UNDO_ITEM::Restore(), EE_TOOL_BASE< T >::saveCopyInUndoList(), and GERBVIEW_SELECTION_TOOL::selectVisually().

SetStoredPos()

void SCH_ITEM::SetStoredPos ( const VECTOR2I &  aPos )

inlineinherited

Definition at line 213 of file sch_item.h.

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::Main().

SetStroke()

virtual void SCH_ITEM::SetStroke ( const STROKE_PARAMS &  aStroke )

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 465 of file sch_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

SetTransform()

void SCH_SYMBOL::SetTransform

(

const TRANSFORM &

aTransform

)

Definition at line 417 of file sch_symbol.cpp.

References m_transform, and EDA_ITEM::SetModified().

SetUnit()

void SCH_SYMBOL::SetUnit

(

int

aUnit

)

Change the unit number to aUnit.

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

Note

This also set the modified flag bit

Parameters

aUnit

is the new unit to select.

Definition at line 388 of file sch_symbol.cpp.

References m_unit, EDA_ITEM::SetModified(), and UpdateUnit().

Referenced by SCH_REFERENCE::Annotate(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_EDITOR_CONTROL::updatePastedSymbol().

SetUnitSelection() [1/2]

void SCH_SYMBOL::SetUnitSelection	(	const SCH_SHEET_PATH *	aSheet,
		int	aUnitSelection
	)

Set the selected unit of this symbol on one sheet.

Definition at line 833 of file sch_symbol.cpp.

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

Referenced by SCH_REFERENCE::Annotate(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_EDITOR_CONTROL::updatePastedSymbol().

SetUnitSelection() [2/2]

void SCH_SYMBOL::SetUnitSelection

(

int

aUnitSelection

)

Set the selected unit of this symbol for all sheets.

Definition at line 852 of file sch_symbol.cpp.

References m_instanceReferences.

SetValueFieldText()

void SCH_SYMBOL::SetValueFieldText

(

const wxString &

aValue

)

Definition at line 869 of file sch_symbol.cpp.

References m_fields, and VALUE_FIELD.

Referenced by BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), LTSPICE_SCH_PARSER::CreateFields(), LTSPICE_SCH_PARSER::CreatePowerSymbol(), SCH_SCREEN::FixLegacyPowerSymbolMismatches(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_FIELD::Replace(), SCH_REFERENCE::SCH_REFERENCE(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), UpdateFields(), and SCH_SHEET_LIST::UpdateSymbolInstanceData().

Sort()

static bool EDA_ITEM::Sort ( const EDA_ITEM *  aLeft, const EDA_ITEM *  aRight  )

inlinestaticinherited

Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters

aLeft	The left hand item to compare.
aRight	The right hand item to compare.

Returns

True if aLeft is less than aRight.

Definition at line 421 of file eda_item.h.

SortInstances()

void SCH_SYMBOL::SortInstances

(

bool(*)(const SCH_SYMBOL_INSTANCE &aLhs, const SCH_SYMBOL_INSTANCE &aRhs)

aSortFunction

)

Definition at line 589 of file sch_symbol.cpp.

References m_instanceReferences.

Referenced by SCH_SEXPR_PLUGIN::saveSymbol().

SwapData()

void SCH_SYMBOL::SwapData ( SCH_ITEM *  aItem )

overridevirtual

Swap the internal data structures aItem with the schematic item.

Obviously, aItem must have the same type than me.

Parameters

aItem

The item to swap the data structures with.

Reimplemented from SCH_ITEM.

Definition at line 1131 of file sch_symbol.cpp.

References m_convert, m_DNP, m_fields, m_inBom, m_instanceReferences, m_lib_id, m_onBoard, m_part, m_pins, m_pos, m_schLibSymbolName, m_transform, m_unit, pin, SCH_SYMBOL_T, EDA_ITEM::SetParent(), EDA_ITEM::Type(), and UpdatePins().

Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Returns the type of object.

This attribute should never be changed after a ctor sets it, so there is no public "setter" method.

Returns

the type of object.

Definition at line 97 of file eda_item.h.

References EDA_ITEM::m_structType.

Referenced by CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), FOOTPRINT::Add(), CN_CLUSTER::Add(), KIGFX::PCB_VIEW::Add(), PCB_POINT_EDITOR::addCorner(), PCB_GROUP::AddItem(), CONNECTION_SUBGRAPH::AddItem(), DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), ZONE_FILLER::addKnockout(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), SCH_MOVE_TOOL::AlignElements(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), SCH_SCREEN::Append(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), TEARDROP_MANAGER::areItemsInSameZone(), PNS::TOPOLOGY::AssembleTuningPath(), SCH_LABEL_BASE::AutoplaceFields(), EE_SELECTION_TOOL::autostartEvent(), DIALOG_NET_INSPECTOR::buildNewItem(), SCH_SCREENS::buildScreenList(), EXPORTER_STEP::buildTrack3DShape(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), PCB_POINT_EDITOR::canAddCorner(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_JUNCTION::CanConnect(), SCH_LABEL_BASE::CanConnect(), SCH_LINE::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_SHEET::CanConnect(), CanConnect(), SCH_EDIT_TOOL::ChangeTextType(), KI_TEST::CheckFootprint(), KI_TEST::CheckFpShape(), KI_TEST::CheckFpZone(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), CN_VISITOR::checkZoneItemConnection(), LIB_FIELD::ClassOf(), LIB_ITEM::ClassOf(), LIB_PIN::ClassOf(), LIB_SHAPE::ClassOf(), LIB_SYMBOL::ClassOf(), LIB_TEXT::ClassOf(), LIB_TEXTBOX::ClassOf(), SCH_BITMAP::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), SCH_FIELD::ClassOf(), SCH_JUNCTION::ClassOf(), SCH_LABEL::ClassOf(), SCH_DIRECTIVE_LABEL::ClassOf(), SCH_GLOBALLABEL::ClassOf(), SCH_HIERLABEL::ClassOf(), SCH_LINE::ClassOf(), SCH_MARKER::ClassOf(), SCH_NO_CONNECT::ClassOf(), SCH_PIN::ClassOf(), SCH_SCREEN::ClassOf(), SCH_SHEET::ClassOf(), SCH_SHEET_PIN::ClassOf(), ClassOf(), SCH_TEXT::ClassOf(), SCH_TEXTBOX::ClassOf(), PCB_GROUP::ClassOf(), BOARD::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), FOOTPRINT::ClassOf(), NETINFO_ITEM::ClassOf(), PAD::ClassOf(), PCB_BITMAP::ClassOf(), PCB_DIM_ALIGNED::ClassOf(), PCB_DIM_ORTHOGONAL::ClassOf(), PCB_DIM_RADIAL::ClassOf(), PCB_DIM_LEADER::ClassOf(), PCB_DIM_CENTER::ClassOf(), PCB_MARKER::ClassOf(), PCB_SHAPE::ClassOf(), PCB_TARGET::ClassOf(), PCB_TEXT::ClassOf(), PCB_TEXTBOX::ClassOf(), PCB_TRACK::ClassOf(), PCB_ARC::ClassOf(), PCB_VIA::ClassOf(), ZONE::ClassOf(), CONNECTION_GRAPH::collectAllDriverValues(), collidesWithArea(), LIB_ITEM::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_TEXT::compare(), LIB_TEXTBOX::compare(), PCB_GRID_HELPER::computeAnchors(), EE_GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_LINE::ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), PAD_TOOL::copyPadSettings(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createLayers(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), ZONE_CREATE_HELPER::createNewZone(), BOARD_ADAPTER::createTrack(), EE_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), SCH_SCREEN::DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), BOARD_COMMIT::dirtyIntersectingZones(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), SCH_EDIT_TOOL::DoDelete(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), APPEARANCE_CONTROLS::doesBoardItemNeedRebuild(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawVia(), CONNECTION_SUBGRAPH::driverName(), CN_ITEM::Dump(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_ITEM_DESC::EDA_ITEM_DESC(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_EDIT_TOOL::editTextBoxProperties(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), DRC_ENGINE::EvalRules(), DRC_ENGINE::EvalZoneConnection(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), PCB_SELECTION_TOOL::FindItem(), NETLIST_EXPORTER_BASE::findNextSymbol(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), PCB_BASE_FRAME::FocusOnItems(), EDIT_TOOL::FootprintFilter(), PCB_PLUGIN::Format(), PCB_PLUGIN::format(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), FormatProbeItem(), PCB_POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), SCH_LABEL_BASE::GetBoundingBox(), PCB_TRACK::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), getClosestGroup(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), CONNECTIVITY_DATA::GetConnectedPadsAndVias(), FOOTPRINT::GetCoverageArea(), CONNECTION_GRAPH::getDefaultConnection(), SCH_FIELD::GetDrawRotation(), getDrilledHoleShape(), CONNECTION_SUBGRAPH::GetDriverPriority(), getFieldFunc(), PCB_TRACK::GetFriendlyName(), getInferredSymbols(), PCB_TRACK::GetItemDescription(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), getMinDist(), SCH_LABEL_BASE::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), SCH_FIELD::GetName(), SCH_SCREEN::GetNeededJunctions(), CONNECTION_SUBGRAPH::GetNetclassForDriver(), CONNECTIVITY_DATA::GetNetItems(), BOARD_ITEM::GetParentFootprint(), GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), TEXT_SEARCH_HANDLER::GetResultCell(), LABEL_SEARCH_HANDLER::GetResultCell(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), SCH_FIELD::GetShownText(), CONVERT_TOOL::getStartEndPoints(), KIGFX::SCH_PAINTER::getTextThickness(), EDA_ITEM::GetTypeDesc(), PCB_EXPR_TYPE_REF::GetValue(), TEARDROP_MANAGER::GetWidth(), PCB_SELECTION_TOOL::grabUnconnected(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), hasDrilledHole(), hash_fp_item(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::highlightNet(), highlightNet(), SCH_FIELD::HitTest(), SCH_LABEL_BASE::HitTest(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRC_RTREE::Insert(), EE_RTREE::insert(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), ARRAY_CREATOR::Invoke(), CONNECTIVITY_DATA::IsConnectedOnLayer(), isCopper(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), PNS_KICAD_IFACE_BASE::IsFlashedOnLayer(), CADSTAR_PCB_ARCHIVE_LOADER::isFootprint(), SCH_FIELD::IsHypertext(), isKeepoutZone(), isMaskAperture(), isNPTHPad(), PCB_TRACK::IsNull(), isNullAperture(), SCH_LINE::IsParallel(), isPlatedFunc(), SCH_FIELD::IsReplaceable(), TEARDROP_MANAGER::IsRound(), PNS::ROUTER::isStartingPointRoutable(), SCH_ITEM::IsType(), itemIsIncludedByFilter(), PCB_SELECTION_TOOL::itemPassesFilter(), CLIPBOARD_IO::Load(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromChainedSegs(), SCH_SCREEN::MarkConnections(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), SCH_FIELD::Matches(), memberOfGroupFunc(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), DIALOG_DRC::OnDRCItemSelected(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), KI_TEST::kitest_cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_BUS_ENTRY_BASE::operator<(), SCH_FIELD::operator<(), SCH_JUNCTION::operator<(), SCH_LINE::operator<(), SCH_SHEET::operator<(), operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), PCB_BITMAP::operator=(), SCH_BITMAP::operator=(), operator=(), SCH_SHEET::operator=(), LIB_ITEM::operator==(), PAD::PAD(), EDIT_TOOL::PadFilter(), PCB_PARSER::parsePCB_SHAPE(), SCH_SEXPR_PARSER::parseSchField(), SCH_EDITOR_CONTROL::Paste(), PCB_CONTROL::Paste(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), BRDITEMS_PLOTTER::PlotPcbGraphicItem(), SCH_FIELD::Print(), DIALOG_GLOBAL_EDIT_TEARDROPS::processItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), CONNECTION_GRAPH::processSubGraphs(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), SCHEMATIC_COMMIT::pushLibEdit(), SCHEMATIC_COMMIT::pushSchEdit(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), BOARD_REANNOTATE_TOOL::ReannotateDuplicates(), SCH_CONNECTION::recacheName(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_BASE_FRAME::RefreshZoomDependentItems(), BOARD::Remove(), CN_CONNECTIVITY_ALGO::Remove(), FOOTPRINT::Remove(), EE_RTREE::remove(), SCH_SCREEN::Remove(), KIGFX::PCB_VIEW::Remove(), PCB_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCornerCondition(), LIB_SYMBOL::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), PCB_SELECTION_TOOL::RequestSelection(), CONNECTION_GRAPH::resolveAllDrivers(), SCHEMATIC::ResolveCrossReference(), PCB_PARSER::resolveGroups(), SCH_LABEL_BASE::ResolveTextVar(), BOARD::ResolveTextVar(), DS_PROXY_UNDO_ITEM::Restore(), SCHEMATIC_COMMIT::Revert(), BOARD_COMMIT::Revert(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), EE_TOOL_BASE< T >::saveCopyInUndoList(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), CLIPBOARD_IO::SaveSelection(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_ITEM::Schematic(), SCH_SCREEN::Schematic(), SYMBOL_SEARCH_HANDLER::Search(), TEXT_SEARCH_HANDLER::Search(), LABEL_SEARCH_HANDLER::Search(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectUnconnected(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_POINT_EDITOR::setAltConstraint(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::ShowFindDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), SCH_EDITOR_CONTROL::SimProbe(), BOARD_COMMIT::Stage(), PNS::LINE_PLACER::Start(), SCH_EDIT_TOOL::Swap(), PCB_GROUP::swapData(), FOOTPRINT::swapData(), PAD::swapData(), PCB_DIM_ALIGNED::swapData(), PCB_DIM_ORTHOGONAL::swapData(), PCB_DIM_RADIAL::swapData(), PCB_DIM_LEADER::swapData(), PCB_DIM_CENTER::swapData(), PCB_TARGET::swapData(), PCB_TEXT::swapData(), PCB_TEXTBOX::swapData(), PCB_TRACK::swapData(), PCB_ARC::swapData(), PCB_VIA::swapData(), ZONE::swapData(), PCB_BITMAP::swapData(), SCH_BITMAP::SwapData(), SCH_FIELD::SwapData(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_SHEET::SwapData(), SCH_SHEET_PIN::SwapData(), SwapData(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), PCB_TRACK::TransformShapeToPolygon(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< T >::updateItem(), SCH_BASE_FRAME::UpdateItem(), PCB_CONTROL::UpdateMessagePanel(), EE_POINT_EDITOR::updateParentItem(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), PCB_GROUP::Visit(), SCH_SHEET::Visit(), GERBER_DRAW_ITEM::Visit(), PCB_TRACK::Visit(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

UpdateDanglingState()

bool SCH_SYMBOL::UpdateDanglingState ( std::vector< DANGLING_END_ITEM > &  aItemList, const SCH_SHEET_PATH *  aPath = nullptr  )

overridevirtual

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

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

Note

This does not test for short circuits.

Parameters

aItemList

is list of all DANGLING_END_ITEM items to be tested.

Returns

true if any pin's state has changed.

Reimplemented from SCH_ITEM.

Definition at line 1911 of file sch_symbol.cpp.

References JUNCTION_END, LABEL_END, m_pins, m_pos, m_transform, NO_CONNECT_END, pin, PIN_END, SHEET_LABEL_END, TRANSFORM::TransformCoordinate(), and WIRE_END.

UpdateFields()

void SCH_SYMBOL::UpdateFields	(	const SCH_SHEET_PATH *	aPath,
		bool	aUpdateStyle,
		bool	aUpdateRef,
		bool	aUpdateOtherFields,
		bool	aResetRef,
		bool	aResetOtherFields
	)

Restore fields to the original library values.

Parameters

aUpdateStyle	selects whether fields should update the position and text attributes.
aUpdateRef	selects whether the reference field should be updated.
aUpdateOtherFields	selects whether non-reference fields should be updated.
aResetRef	selects whether the reference should be reset to the library value.
aResetOtherFields	selects whether non-reference fields should be reset to library values.

Definition at line 990 of file sch_symbol.cpp.

References AddField(), DATASHEET_FIELD, FindField(), FOOTPRINT_FIELD, GetDatasheet(), GetFieldById(), GetFieldCount(), SCH_FIELD::ImportValues(), m_part, m_pos, MANDATORY_FIELDS, REFERENCE_FIELD, SetFootprintFieldText(), SetRef(), EDA_TEXT::SetText(), EDA_TEXT::SetTextPos(), SetValueFieldText(), UnescapeString(), and VALUE_FIELD.

Referenced by SCH_SYMBOL().

UpdatePins()

void SCH_SYMBOL::UpdatePins

(

)

Updates the cache of SCH_PIN objects for each pin.

Definition at line 339 of file sch_symbol.cpp.

References m_convert, m_part, m_pinMap, m_pins, and pin.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), operator=(), SCH_EDIT_FRAME::PutDataInPreviousState(), SetConvert(), SetLibSymbol(), SwapData(), and TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE().

UpdatePrefix()

void SCH_SYMBOL::UpdatePrefix

(

)

Set the prefix based on the current reference designator.

Definition at line 790 of file sch_symbol.cpp.

References GetField(), EDA_TEXT::GetText(), REFERENCE_FIELD, and SetPrefix().

Referenced by SCH_SHEET_LIST::UpdateSymbolInstanceData().

UpdateUnit()

void SCH_SYMBOL::UpdateUnit

(

int

aUnit

)

Change the unit number to aUnit without setting any internal flags.

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

Note

This also set the modified flag bit

Parameters

aUnit

is the new unit to select.

Definition at line 398 of file sch_symbol.cpp.

References m_unit.

Referenced by SetUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

UseLibIdLookup()

bool SCH_SYMBOL::UseLibIdLookup ( ) const

inline

Definition at line 193 of file sch_symbol.h.

References m_schLibSymbolName.

Referenced by SCH_SEXPR_PLUGIN::Format(), NETLIST_EXPORTER_XML::makeSymbols(), and SCH_SEXPR_PLUGIN::saveSymbol().

ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

Return the bounding box of the item covering all its layers.

Returns

the current bounding box.

Implements KIGFX::VIEW_ITEM.

Reimplemented in LIB_PIN, SCH_PIN, GERBER_DRAW_ITEM, DS_PROXY_VIEW_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, EDIT_POINTS, FOOTPRINT, PAD, PCB_DIMENSION_BASE, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TEXT, PCB_TRACK, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, and MY_DRAWING.

Definition at line 254 of file eda_item.cpp.

References EDA_ITEM::GetBoundingBox().

Referenced by EDIT_TOOL::doMoveSelection(), GERBVIEW_FRAME::GetDocumentExtents(), EDIT_TOOL::Rotate(), and PCB_SHAPE::ViewBBox().

ViewDraw()

virtual void KIGFX::VIEW_ITEM::ViewDraw ( int  aLayer, VIEW *  aView  ) const

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

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

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Reimplemented in DS_PROXY_VIEW_ITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, EDIT_POINTS, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, MY_DRAWING, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::ORIGIN_VIEWITEM, KIGFX::VIEW_GROUP, and KIGFX::VIEW_OVERLAY.

Definition at line 108 of file view_item.h.

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

ViewGetLayers()

void SCH_SYMBOL::ViewGetLayers ( int  aLayers[], int &  aCount  ) const

overridevirtual

Return the layers the item is drawn on (which may be more than its "home" layer)

Reimplemented from SCH_ITEM.

Definition at line 248 of file sch_symbol.cpp.

References LAYER_DANGLING, LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LAYER_FIELDS, LAYER_OP_CURRENTS, LAYER_REFERENCEPART, LAYER_SELECTION_SHADOWS, and LAYER_VALUEPART.

ViewGetLOD()

virtual double KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer, VIEW *  aView  ) const

inlinevirtualinherited

Return the level of detail (LOD) of the item.

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

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Returns

the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in SCH_LINE, GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, PAD, PCB_BITMAP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 134 of file view_item.h.

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), EE_GRID_HELPER::queryVisible(), and PCB_GRID_HELPER::queryVisible().

viewPrivData()

VIEW_ITEM_DATA * KIGFX::VIEW_ITEM::viewPrivData ( ) const

inlineinherited

Definition at line 140 of file view_item.h.

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::draw(), KIGFX::VIEW::HasItem(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsVisible(), KIGFX::QUERY_VISITOR< CONTAINER >::operator()(), KIGFX::VIEW::UPDATE_COLOR_VISITOR::operator()(), KIGFX::VIEW::UPDATE_DEPTH_VISITOR::operator()(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), KIGFX::VIEW::RECACHE_ITEM_VISITOR::operator()(), KIGFX::VIEW::CLEAR_LAYER_CACHE_VISITOR::operator()(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

Visit()

INSPECT_RESULT SCH_SYMBOL::Visit ( INSPECTOR  inspector, void *  testData, const std::vector< KICAD_T > &  aScanTypes  )

overridevirtual

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

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

Parameters

inspector	An INSPECTOR instance to use in the inspection.
testData	Arbitrary data used by the inspector.
aScanTypes	Which KICAD_T types are of interest and the order in which they should be processed.

Returns

#SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else #SCAN_CONTINUE, and determined by the inspector.

Reimplemented from EDA_ITEM.

Definition at line 2016 of file sch_symbol.cpp.

References DATASHEET_FIELD, FOOTPRINT_FIELD, GetConvert(), GetField(), GetUnit(), m_fields, m_part, m_pins, pin, REFERENCE_FIELD, SCH_FIELD_LOCATE_DATASHEET_T, SCH_FIELD_LOCATE_FOOTPRINT_T, SCH_FIELD_LOCATE_REFERENCE_T, SCH_FIELD_LOCATE_VALUE_T, SCH_FIELD_T, SCH_LOCATE_ANY_T, SCH_PIN_T, SCH_SYMBOL_LOCATE_POWER_T, SCH_SYMBOL_T, and VALUE_FIELD.

XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS  aMask )

inlineinherited

Definition at line 124 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by EE_SELECTION_TOOL::selectMultiple().

Member Data Documentation

m_connected_items

std::map<SCH_SHEET_PATH, SCH_ITEM_SET, SHEET_PATH_CMP> SCH_ITEM::m_connected_items

protectedinherited

Store pointers to other items that are connected to this one, per sheet.

Definition at line 504 of file sch_item.h.

Referenced by SCH_ITEM::AddConnectionTo(), SCH_ITEM::ConnectedItems(), and SCH_LABEL_BASE::IsType().

m_connection_map

std::unordered_map<SCH_SHEET_PATH, SCH_CONNECTION*> SCH_ITEM::m_connection_map

protectedinherited

Store connectivity information, per sheet.

Definition at line 507 of file sch_item.h.

Referenced by SCH_ITEM::Connection(), SCH_ITEM::InitializeConnection(), SCH_ITEM::SetConnectionGraph(), and SCH_ITEM::~SCH_ITEM().

m_connections

EDA_ITEMS SCH_ITEM::m_connections

protectedinherited

Definition at line 498 of file sch_item.h.

Referenced by SCH_ITEM::ClearConnections(), and SCH_ITEM::~SCH_ITEM().

m_connectivity_dirty

bool SCH_ITEM::m_connectivity_dirty

protectedinherited

Definition at line 509 of file sch_item.h.

Referenced by SCH_ITEM::IsConnectivityDirty(), SCH_ITEM::operator=(), SCH_ITEM::SCH_ITEM(), and SCH_ITEM::SetConnectivityDirty().

m_convert

int SCH_SYMBOL::m_convert

private

The alternate body style for symbols that have more than one body style defined.

Primarily used for symbols that have a De Morgan conversion.

Definition at line 791 of file sch_symbol.h.

Referenced by doGetBoundingBox(), GetConvert(), GetDrawItem(), GetLibPins(), Init(), operator=(), Print(), PrintBackground(), SCH_SYMBOL(), SetConvert(), SwapData(), and UpdatePins().

m_DNP

bool SCH_SYMBOL::m_DNP

private

True if symbol is set to 'Do Not Populate'.

Definition at line 819 of file sch_symbol.h.

Referenced by GetDNP(), Plot(), Print(), SCH_SYMBOL(), SetDNP(), and SwapData().

m_fields

std::vector<SCH_FIELD> SCH_SYMBOL::m_fields

private

Variable length list of fields.

Definition at line 809 of file sch_symbol.h.

Referenced by AddField(), AddHierarchicalReference(), AddSheetPathReferenceEntryIfMissing(), ClearAnnotation(), doGetBoundingBox(), FindField(), GetContextualTextVars(), GetField(), GetFieldById(), GetFieldByName(), GetFieldCount(), GetFields(), GetFieldText(), Init(), MirrorHorizontally(), MirrorVertically(), Move(), operator=(), Plot(), Print(), RemoveField(), ResolveTextVar(), Rotate(), RunOnChildren(), SCH_SYMBOL(), SetFields(), SetFootprintFieldText(), SetRef(), SetValueFieldText(), SwapData(), and Visit().

m_fieldsAutoplaced

FIELDS_AUTOPLACED SCH_ITEM::m_fieldsAutoplaced

protectedinherited

Definition at line 499 of file sch_item.h.

Referenced by SCH_LABEL_BASE::AutoplaceFields(), SCH_DIRECTIVE_LABEL::AutoplaceFields(), SCH_SHEET::AutoplaceFields(), AutoplaceFields(), SCH_ITEM::ClearFieldsAutoplaced(), SCH_ITEM::GetFieldsAutoplaced(), SCH_ITEM::operator=(), SCH_SHEET::Resize(), SCH_SHEET::Rotate(), SCH_LABEL_BASE::Rotate90(), SCH_ITEM::SCH_ITEM(), SCH_SHEET::SCH_SHEET(), SCH_SYMBOL(), SCH_ITEM::SetFieldsAutoplaced(), SCH_LABEL_BASE::SwapData(), and SCH_SHEET::SwapData().

m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 480 of file eda_item.h.

Referenced by EDA_ITEM::ClearFlags(), LIB_TEXT::Clone(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), EDA_ITEM::HasFlag(), LIB_ITEM::HitTest(), LIB_SHAPE::HitTest(), LIB_TEXT::HitTest(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), HitTest(), LIB_PIN::HitTest(), SCH_PIN::HitTest(), ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsBrightened(), SCH_ITEM::IsConnected(), EDA_ITEM::IsEntered(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsRollover(), EDA_ITEM::IsSelected(), EDA_ITEM::IsShownAsBitmap(), SCH_LINE::MirrorHorizontally(), SCH_LINE::MirrorVertically(), EDA_ITEM::operator=(), SCH_LINE::Rotate(), EDA_ITEM::SetFlags(), PCB_SHAPE::swapData(), PCB_BITMAP::swapData(), and EDA_ITEM::XorFlags().

m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 159 of file view_item.h.

Referenced by KIGFX::VIEW_ITEM::GetForcedTransparency(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), and KIGFX::VIEW_ITEM::SetForcedTransparency().

m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 479 of file eda_item.h.

Referenced by ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsForceVisible(), EDA_ITEM::operator=(), EDA_ITEM::SetForceVisible(), PCB_SHAPE::swapData(), and PCB_BITMAP::swapData().

m_inBom

bool SCH_SYMBOL::m_inBom

private

True to include in bill of materials export.

Definition at line 817 of file sch_symbol.h.

Referenced by GetIncludeInBom(), Init(), SCH_SYMBOL(), SetIncludeInBom(), and SwapData().

m_instanceReferences

std::vector<SCH_SYMBOL_INSTANCE> SCH_SYMBOL::m_instanceReferences

private

Definition at line 823 of file sch_symbol.h.

Referenced by AddHierarchicalReference(), AddSheetPathReferenceEntryIfMissing(), ClearAnnotation(), GetInstance(), GetInstanceReferences(), GetRef(), GetUnitSelection(), IsAnnotated(), operator=(), RemoveAllInstances(), RemoveInstance(), ReplaceInstanceSheetPath(), SCH_SYMBOL(), SetRef(), SetUnitSelection(), SortInstances(), and SwapData().

m_isInNetlist

bool SCH_SYMBOL::m_isInNetlist

private

True if the symbol should appear in the netlist.

Definition at line 816 of file sch_symbol.h.

Referenced by Init(), IsInNetlist(), SCH_SYMBOL(), and SetRef().

m_layer

SCH_LAYER_ID SCH_ITEM::m_layer

protectedinherited

Definition at line 497 of file sch_item.h.

Referenced by SCH_ITEM::CanConnect(), SCH_LINE::CanConnect(), SCH_LINE::doIsConnected(), SCH_LINE::GetItemDescription(), SCH_ITEM::GetLayer(), SCH_LINE::GetMenuImage(), SCH_LINE::GetPenWidth(), Init(), SCH_LINE::IsConnectable(), SCH_ITEM::IsType(), SCH_LINE::IsType(), SCH_ITEM::operator=(), SCH_BUS_ENTRY_BASE::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_BUS_ENTRY_BASE::Print(), SCH_FIELD::Print(), SCH_LABEL_BASE::Print(), SCH_TEXT::Print(), SCH_TEXTBOX::Print(), SCH_BITMAP::SCH_BITMAP(), SCH_BUS_BUS_ENTRY::SCH_BUS_BUS_ENTRY(), SCH_BUS_WIRE_ENTRY::SCH_BUS_WIRE_ENTRY(), SCH_DIRECTIVE_LABEL::SCH_DIRECTIVE_LABEL(), SCH_GLOBALLABEL::SCH_GLOBALLABEL(), SCH_HIERLABEL::SCH_HIERLABEL(), SCH_ITEM::SCH_ITEM(), SCH_JUNCTION::SCH_JUNCTION(), SCH_LABEL::SCH_LABEL(), SCH_LINE::SCH_LINE(), SCH_PIN::SCH_PIN(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), SCH_TEXTBOX::SCH_TEXTBOX(), SCH_ITEM::SetLayer(), SCH_FIELD::SwapData(), SCH_LINE::SwapData(), SCH_SHAPE::SwapData(), SCH_TEXT::SwapData(), SCH_TEXTBOX::SwapData(), SCH_JUNCTION::ViewGetLayers(), SCH_LINE::ViewGetLayers(), and SCH_TEXT::ViewGetLayers().

m_lib_id

LIB_ID SCH_SYMBOL::m_lib_id

private

Name and library the symbol was loaded from, i.e. 74xx:74LS00.

Definition at line 789 of file sch_symbol.h.

Referenced by GetLibId(), GetMsgPanelInfo(), GetSchSymbolLibraryName(), operator=(), ResolveTextVar(), SCH_SYMBOL(), SetLibId(), and SwapData().

m_onBoard

bool SCH_SYMBOL::m_onBoard

private

True to include in netlist when updating board.

Definition at line 818 of file sch_symbol.h.

Referenced by GetIncludeOnBoard(), Init(), SCH_SYMBOL(), SetIncludeOnBoard(), and SwapData().

m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 478 of file eda_item.h.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::DoHypertextAction(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), SCH_FIELD::GetDrawRotation(), SCH_FIELD::GetMenuImage(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_FIELD::GetName(), LIB_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParent(), EDA_ITEM::GetParent(), PAD::GetParent(), PAD::GetParentAsString(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), LIB_FIELD::HitTest(), SCH_FIELD::IsHypertext(), SCH_FIELD::IsReplaceable(), SCH_PIN::IsStacked(), SCH_FIELD::Matches(), EDA_ITEM::operator=(), LIB_FIELD::operator=(), PAD::PAD(), SCH_FIELD::Plot(), SCH_FIELD::Print(), SCH_FIELD::Replace(), SCH_LABEL_BASE::ResolveTextVar(), SCH_SYMBOL(), SCH_FIELD::SetId(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), SCH_FIELD::SetPosition(), PCB_SHAPE::swapData(), and PCB_BITMAP::swapData().

m_part

std::unique_ptr< LIB_SYMBOL > SCH_SYMBOL::m_part

private

a flattened copy of the LIB_SYMBOL from the PROJECT's libraries.

Definition at line 811 of file sch_symbol.h.

Referenced by doGetBoundingBox(), GetAllLibPins(), GetDatasheet(), GetDescription(), GetDrawItem(), GetKeyWords(), GetLibPins(), GetLibSymbolRef(), GetMsgPanelInfo(), GetUnitCount(), GetUnitDisplayName(), HasUnitDisplayName(), IsMissingLibSymbol(), IsPower(), operator=(), Plot(), PlotPins(), Print(), PrintBackground(), SCH_SYMBOL(), SetLibSymbol(), SwapData(), UpdateFields(), UpdatePins(), and Visit().

m_pinMap

std::unordered_map<LIB_PIN*, unsigned> SCH_SYMBOL::m_pinMap

private

library pin pointer : SCH_PIN's index

Definition at line 814 of file sch_symbol.h.

Referenced by GetPin(), and UpdatePins().

m_pins

std::vector<std::unique_ptr<SCH_PIN> > SCH_SYMBOL::m_pins

private

a SCH_PIN for every LIB_PIN (all units)

Definition at line 813 of file sch_symbol.h.

Referenced by ClearAnnotation(), ClearBrightenedPins(), doIsConnected(), GetConnectionPoints(), GetEndPoints(), GetPin(), GetPins(), GetRawPins(), HasBrightenedPins(), IsMovableFromAnchorPoint(), IsPointClickableAnchor(), RunOnChildren(), SetRef(), SwapData(), UpdateDanglingState(), UpdatePins(), and Visit().

m_pos

VECTOR2I SCH_SYMBOL::m_pos

private

Definition at line 788 of file sch_symbol.h.

Referenced by doGetBoundingBox(), doIsConnected(), GetConnectionPoints(), GetDrawItem(), GetPinPhysicalPosition(), GetPosition(), Init(), IsMovableFromAnchorPoint(), MirrorHorizontally(), MirrorVertically(), Move(), operator<(), operator=(), Plot(), PlotPins(), Print(), PrintBackground(), Rotate(), SCH_SYMBOL(), SetPosition(), SwapData(), UpdateDanglingState(), and UpdateFields().

m_prefix

wxString SCH_SYMBOL::m_prefix

private

C, R, U, Q etc - the first character(s) which typically indicate what the symbol is.

Determined, upon placement, from the library symbol. Created upon file load, by the first non-digits in the reference fields.

Definition at line 794 of file sch_symbol.h.

Referenced by ClearAnnotation(), GetPrefix(), GetRef(), Init(), SCH_SYMBOL(), SetPrefix(), SetRef(), and SetUnitSelection().

m_schLibSymbolName

wxString SCH_SYMBOL::m_schLibSymbolName

private

The name used to look up a symbol in the symbol library embedded in a schematic.

By default this is the same as LIB_ID::GetLibItemName(). However, schematics allow for multiple variants of the same library symbol. Set this member in order to preserve the link to the original symbol library. If empty, LIB_ID::GetLibItemName() should be used.

Definition at line 806 of file sch_symbol.h.

Referenced by GetSchSymbolLibraryName(), SCH_SYMBOL(), SetSchSymbolLibraryName(), SwapData(), and UseLibIdLookup().

m_storedPos

VECTOR2I SCH_ITEM::m_storedPos

protectedinherited

Definition at line 500 of file sch_item.h.

Referenced by SCH_ITEM::GetStoredPos(), and SCH_ITEM::SetStoredPos().

m_structType

KICAD_T EDA_ITEM::m_structType

privateinherited

Run time identification, keep private so it can never be changed after a ctor sets it.

See comment near SetType() regarding virtual functions.

Definition at line 487 of file eda_item.h.

Referenced by EDA_ITEM::IsType(), EDA_ITEM::operator=(), and EDA_ITEM::Type().

m_transform

TRANSFORM SCH_SYMBOL::m_transform

private

The rotation/mirror transformation.

Definition at line 808 of file sch_symbol.h.

Referenced by doGetBoundingBox(), doIsConnected(), GetConnectionPoints(), GetDrawItem(), GetOrientation(), GetPinPhysicalPosition(), GetTransform(), Init(), operator=(), Print(), PrintBackground(), SCH_SYMBOL(), SetOrientation(), SetTransform(), SwapData(), and UpdateDanglingState().

m_unit

int SCH_SYMBOL::m_unit

private

The unit for multiple part per package symbols.

Definition at line 790 of file sch_symbol.h.

Referenced by AddHierarchicalReference(), AddSheetPathReferenceEntryIfMissing(), doGetBoundingBox(), GetDrawItem(), GetEndPoints(), GetLibPins(), GetUnit(), GetUnitSelection(), Init(), operator=(), Print(), PrintBackground(), SCH_SYMBOL(), SetRef(), SetUnit(), SwapData(), and UpdateUnit().

m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 475 of file eda_item.h.

Referenced by AddHierarchicalReference(), SCH_SHEET::addInstance(), RC_ITEM::AddItem(), SCH_EDIT_FRAME::AnnotateSymbols(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_EDIT_FRAME::CreateScreens(), ZONE_FILLER_TOOL::DirtyZone(), DRAWING_TOOL::DrawVia(), LIB_SYMBOL::Duplicate(), BOARD_ITEM::Duplicate(), FOOTPRINT::Duplicate(), SCH_ITEM::Duplicate(), FOOTPRINT::DuplicateItem(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), SCH_SHEET_LIST::FillItemMap(), BOARD::FillItemMap(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_PLUGIN::format(), SCH_SEXPR_PLUGIN::Format(), SCH_PIN::GetDefaultNetName(), SCH_SHEET_PATH::GetItem(), BOARD::GetItem(), PAD::GetMsgPanelInfo(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), SCH_SHEET::getPageNumber(), PAD::GetParentAsString(), SCH_MARKER::GetUUID(), PCB_MARKER::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::GetValue(), ZONE::HigherPriority(), SCH_SHEET_PATH::IsContainedWithin(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), LEGACY_PLUGIN::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PCB_EDIT_FRAME::LoadFootprints(), SCH_LEGACY_PLUGIN::loadHierarchy(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), LEGACY_PLUGIN::loadTrackList(), PNS::LOGGER::Log(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), BOARD_ITEM::ptr_cmp::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), PCB_TRACK::cmp_tracks::operator()(), FOOTPRINT::cmp_zones::operator()(), SCH_ITEM::operator<(), operator<(), PAD::PAD(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), PCB_VIA::PCB_VIA(), RemoveInstance(), FIELDS_EDITOR_GRID_DATA_MODEL::RenameColumn(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBusEntry(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN::saveJunction(), SCH_SEXPR_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveNoConnect(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveShape(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN::saveTextBox(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), SCH_SYMBOL(), RC_ITEM::SetItems(), SCH_SHEET::setPageNumber(), FIELDS_EDITOR_GRID_DATA_MODEL::SetValue(), SCH_DRAWING_TOOLS::SingleClickPlace(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), testGroupEqual(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::updatePastedSheet(), SCH_SHEET_LIST::UpdateSymbolInstanceData(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 158 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::OnDestroy(), KIGFX::VIEW::Remove(), KIGFX::VIEW_ITEM::viewPrivData(), and KIGFX::VIEW_ITEM::~VIEW_ITEM().

s_transformToOrientationCache

std::unordered_map< TRANSFORM, int > SCH_SYMBOL::s_transformToOrientationCache

staticprivate

See also

SCH_SYMBOL::GetOrientation

Definition at line 826 of file sch_symbol.h.

Referenced by GetOrientation().

---

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

• sch_symbol.h
• autoplace_fields.cpp
• sch_symbol.cpp