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 () const

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

void	RemoveInstance (const SCH_SHEET_PATH &aInstancePath)

void	SortInstances (bool(*aSortFunction)(const SCH_SYMBOL_INSTANCE &aLhs, const SCH_SYMBOL_INSTANCE &aRhs))

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

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

const SCH_FIELD *	GetFieldByName (const wxString &aFieldName) const

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, bool aCaseInsensitive=false)
	Search for a SCH_FIELD with aFieldName. 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	GetExcludedFromSim () const override

void	SetExcludedFromSim (bool aExclude) override

bool	GetExcludedFromBOM () const

void	SetExcludedFromBOM (bool aIncludeInBOM)

bool	GetExcludedFromBoard () const

void	SetExcludedFromBoard (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...

void	SwapFlags (SCH_ITEM *aItem)
	Swap the non-temp and non-edit flags. 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

const KIFONT::METRICS &	GetFontMetrics () 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 bool	HasCachedDriverName () const

virtual const wxString &	GetCachedDriverName () const

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	ClearEditFlags ()

EDA_ITEM_FLAGS	GetTempFlags () const

void	ClearTempFlags ()

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 , SCH_PIN >	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_excludedFromSim
	True to exclude from simulation. More...

bool	m_excludedFromBOM
	True to exclude from bill of materials export. More...

bool	m_excludedFromBoard
	True to exclude from 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 99 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 107 of file sch_symbol.cpp.

References LIB_SYMBOL::Flatten(), UTIL::GetRefDesPrefix(), UTIL::GetRefDesUnannotated(), Init(), m_convert, m_DNP, m_excludedFromBoard, m_excludedFromBOM, m_excludedFromSim, m_lib_id, 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 147 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 163 of file sch_symbol.cpp.

References m_convert, m_DNP, m_excludedFromBoard, m_excludedFromBOM, m_excludedFromSim, m_fields, SCH_ITEM::m_fieldsAutoplaced, m_instanceReferences, m_isInNetlist, m_lib_id, EDA_ITEM::m_parent, m_part, m_pins, m_pos, m_prefix, m_schLibSymbolName, m_transform, m_unit, EDA_ITEM::m_Uuid, pin, 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 203 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 988 of file sch_symbol.cpp.

References m_fields.

Referenced by BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), LTSPICE_SCH_PARSER::CreateFields(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_ALTIUM_PLUGIN::ParseParameter(), 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 618 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 665 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 1501 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 455 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 659 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 1457 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(), SYMBOL_EDIT_FRAME::FocusOnItem(), 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 2444 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 288 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 385 of file sch_item.h.

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 137 of file eda_item.h.

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

Referenced by BOARD::Add(), FOOTPRINT::Add(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::PutDataInPreviousState(), BOARD_COMMIT::Revert(), SCH_ITEM::SwapFlags(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )

inlineinherited

Definition at line 446 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_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConnectBoardShapes(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), 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(), SCH_COMMIT::pushSchEdit(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), EDA_ITEM::SetIsShownAsBitmap(), 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_COMMIT::Stage(), 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 149 of file eda_item.h.

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState(), and SCH_ITEM::SwapFlags().

◆ 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 236 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 197 of file sch_item.cpp.

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), 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::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(), CONNECTION_SUBGRAPH::ResolveDrivers(), 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 424 of file sch_item.h.

◆ doGetBoundingBox()

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

private

Definition at line 1725 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 252 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 2272 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_EDIT_FRAME::AddCopyForRepeatItem(), 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`,
		bool	aCaseInsensitive = `false`
	)

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.
aCaseInsensitive	ignore the filed name case if true.

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

Definition at line 1010 of file sch_symbol.cpp.

References m_fields, and MANDATORY_FIELDS.

Referenced by BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), LTSPICE_SCH_PARSER::CreateFields(), NETLIST_EXPORTER_ALLEGRO::getGroupField(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_ALTIUM_PLUGIN::ParseParameter(), 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 PCBEXPR_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 1131 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 1776 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<(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), 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 1770 of file sch_symbol.cpp.

References doGetBoundingBox().

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

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

References doGetBoundingBox().

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

◆ GetCachedDriverName()

const wxString & SCH_ITEM::GetCachedDriverName ( ) const

virtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 254 of file sch_item.cpp.

Referenced by CONNECTION_SUBGRAPH::GetNameForDriver().

◆ 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 2046 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 1231 of file sch_symbol.cpp.

References m_fields, and MANDATORY_FIELDS.

Referenced by DIALOG_TEXT_PROPERTIES::getContextualTextVars(), and SCH_FIELD::OnScintillaCharAdded().

◆ GetConvert()

int SCH_SYMBOL::GetConvert ( ) const

inline

◆ GetDatasheet()

wxString SCH_SYMBOL::GetDatasheet ( ) const

Return the documentation text for the given part alias.

Definition at line 329 of file sch_symbol.cpp.

References m_part.

Referenced by UpdateFields().

◆ GetDefaultFont()

const wxString & SCH_ITEM::GetDefaultFont ( ) const

inherited

Definition at line 323 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 311 of file sch_symbol.cpp.

References m_part.

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

◆ GetDNP()

bool SCH_SYMBOL::GetDNP ( ) const

inline

◆ 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 2070 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.

◆ GetEffectiveNetClass()

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

inherited

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

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

◆ GetExcludedFromBoard()

bool SCH_SYMBOL::GetExcludedFromBoard ( ) const

inline

Definition at line 744 of file sch_symbol.h.

References m_excludedFromBoard.

Referenced by BACK_ANNOTATE::checkForUnusedSymbols(), NETLIST_EXPORTER_ALLEGRO::extractComponentsInfo(), FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), CONNECTION_SUBGRAPH::GetDriverPriority(), GetMsgPanelInfo(), SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_XML::makeListOfNets(), NETLIST_EXPORTER_XML::makeSymbols(), ResolveTextVar(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), SCH_EDIT_TOOL::ToggleAttribute(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ GetExcludedFromBOM()

bool SCH_SYMBOL::GetExcludedFromBOM ( ) const

inline

Definition at line 741 of file sch_symbol.h.

References m_excludedFromBOM.

Referenced by BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), GetMsgPanelInfo(), SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_XML::makeListOfNets(), NETLIST_EXPORTER_XML::makeSymbols(), FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), ResolveTextVar(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), SCH_EDIT_TOOL::ToggleAttribute(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetExcludedFromSim()

bool SCH_SYMBOL::GetExcludedFromSim ( ) const

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 738 of file sch_symbol.h.

References m_excludedFromSim.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), GetMsgPanelInfo(), SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), ResolveTextVar(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), ERC_TESTER::TestSimModelIssues(), SCH_EDIT_TOOL::ToggleAttribute(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetField() [1/2]

const SCH_FIELD * SCH_SYMBOL::GetField ( MANDATORY_FIELD_T aFieldNdx ) const

Definition at line 919 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 913 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 925 of file sch_symbol.cpp.

References m_fields.

Referenced by SCH_SYMBOL(), and UpdateFields().

◆ GetFieldByName() [1/2]

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

References m_fields.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::getFieldShownText(), and FIELDS_EDITOR_GRID_DATA_MODEL::updateDataStoreSymbolField().

◆ GetFieldByName() [2/2]

const SCH_FIELD * SCH_SYMBOL::GetFieldByName ( const wxString & aFieldName ) const

Definition at line 949 of file sch_symbol.cpp.

References m_fields.

◆ GetFieldCount()

int SCH_SYMBOL::GetFieldCount ( ) const

inline

Return the number of fields in this symbol.

Definition at line 479 of file sch_symbol.h.

References m_fields.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), BACK_ANNOTATE::applyChangelist(), 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 422 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 423 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 973 of file sch_symbol.cpp.

References m_fields.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), BACK_ANNOTATE::applyChangelist(), 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(), DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsAdded(), DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsChanged(), 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_UI::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 443 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 961 of file sch_symbol.cpp.

References m_fields.

◆ 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(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), LIB_PIN::GetMsgPanelInfo(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), LIB_SYMBOL::LIB_SYMBOL(), EE_SELECTION_TOOL::Main(), 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(), 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 246 of file eda_item.h.

References EDA_ITEM::GetPosition().

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

◆ GetFontMetrics()

const KIFONT::METRICS & SCH_ITEM::GetFontMetrics ( ) const

inherited

Definition at line 331 of file sch_item.cpp.

References KIFONT::METRICS::Default(), and SCH_ITEM::Schematic().

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_FIELD::getFontMetrics(), SCH_TEXT::getFontMetrics(), SCH_TEXTBOX::getFontMetrics(), SCH_FIELD::GetRenderCache(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), and SCH_FIELD::Print().

◆ GetFootprintFieldText()

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

Definition at line 897 of file sch_symbol.cpp.

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

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

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 155 of file view_item.h.

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

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in SCH_LINE, PCB_SHAPE, PCB_TEXTBOX, PCB_TRACK, and ZONE.

Definition at line 329 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 522 of file sch_symbol.h.

References GetAllLibPins().

◆ GetInstance()

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

Definition at line 565 of file sch_symbol.cpp.

References m_instanceReferences.

Referenced by SCH_SHEET_PATH::AddNewSymbolInstances().

◆ GetInstanceReferences()

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

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 2084 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 320 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 257 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_LINE::GetFriendlyName(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), GetNetNavigatorItemText(), 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(), CONNECTION_GRAPH::updateItemConnectivity(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetLibId()

const LIB_ID & SCH_SYMBOL::GetLibId ( ) const

inline

Definition at line 173 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::LoadSchematicFile(), 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 1124 of file sch_symbol.cpp.

References m_convert, m_part, and m_unit.

Referenced by NETLIST_EXPORTER_ALLEGRO::extractComponentsInfo(), and SCH_SCREEN::GetPin().

◆ GetLibSymbolRef() [1/2]

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

inline

Definition at line 190 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(), NETLIST_EXPORTER_ALLEGRO::getGroupField(), SCH_SCREEN::GetPin(), highlightNet(), IsSymbolLikePowerGlobalLabel(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), NETLIST_EXPORTER_XML::makeSymbols(), netList(), DIALOG_SYMBOL_PROPERTIES::onUpdateEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::onUpdateEditSymbol(), SCH_DRAWING_TOOLS::PlaceSymbol(), ERC_TESTER::TestLibSymbolIssues(), NETLIST_EXPORTER_ALLEGRO::toAllegroPackages(), 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 191 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 1904 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 1788 of file sch_symbol.cpp.

References _, DESCRIPTION_FIELD, dummy, KIUI::EllipsizeStatusText(), UTF8::empty(), FOOTPRINT_FIELD, SCH_EDIT_FRAME::GetCurrentSheet(), GetDNP(), EDA_ITEM::GetEditFlags(), GetExcludedFromBoard(), GetExcludedFromBOM(), GetExcludedFromSim(), GetField(), 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 1646 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 239 of file sch_item.cpp.

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

◆ 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_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(), EE_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDIT_FRAME::onNetNavigatorSelection(), SCH_FIELD::OnScintillaCharAdded(), SCH_COMMIT::parentObject(), SCH_FIELD::Print(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_COMMIT::Revert(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_ITEM::Schematic(), SCH_SCREEN::Schematic(), SCH_SHEET::SearchHierarchy(), PCB_SELECTION_TOOL::select(), SCH_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_ENTRY_BASE, 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 274 of file sch_item.h.

Referenced by EE_RTREE::contains(), KIGFX::SCH_PAINTER::getLineWidth(), EE_RTREE::insert(), 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 1112 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 1142 of file sch_symbol.cpp.

References m_pinMap.

◆ GetPinPhysicalPosition()

VECTOR2I SCH_SYMBOL::GetPinPhysicalPosition ( const LIB_PIN * Pin ) const

Definition at line 2037 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 1154 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::RecalculateConnections(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), ResolveTextVar(), 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

◆ GetPrefix()

wxString SCH_SYMBOL::GetPrefix ( ) const

inline

Definition at line 272 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 540 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 720 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().

◆ GetSchSymbolLibraryName()

wxString SCH_SYMBOL::GetSchSymbolLibraryName ( ) const

Definition at line 293 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 255 of file eda_item.h.

References EDA_ITEM::GetPosition().

◆ GetStoredPos()

VECTOR2I & SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 220 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 476 of file sch_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

References CANDIDATE, IS_LINKED, EDA_ITEM::m_flags, SELECTED_BY_DRAG, and SKIP_STRUCT.

Referenced by EDA_ITEM::ClearTempFlags(), and SCH_ITEM::SwapFlags().

◆ GetTransform() [1/2]

TRANSFORM & SCH_SYMBOL::GetTransform ( )

inline

◆ GetTransform() [2/2]

const TRANSFORM & SCH_SYMBOL::GetTransform ( ) const

inline

Definition at line 282 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 320 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 226 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 473 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 482 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 839 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 881 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(), SCH_REFERENCE::SCH_REFERENCE(), NETLIST_EXPORTER_ALLEGRO::toAllegroPackages(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ HasBrightenedPins()

bool SCH_SYMBOL::HasBrightenedPins ( )

Definition at line 2432 of file sch_symbol.cpp.

References m_pins, and pin.

Referenced by SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ HasCachedDriverName()

virtual bool SCH_ITEM::HasCachedDriverName ( ) const

inlinevirtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 433 of file sch_item.h.

Referenced by CONNECTION_SUBGRAPH::GetNameForDriver().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

◆ 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 474 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 490 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 2256 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 2244 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 205 of file sch_symbol.cpp.

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

References SCH_ITEM::Connection(), SCH_ITEM::m_connection_map, SCH_CONNECTION::Reset(), 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 798 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(), SYMBOL_EDIT_FRAME::FocusOnItem(), 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 657 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

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

◆ 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 191 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 250 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 2300 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 240 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 242 of file sch_symbol.cpp.

References m_part.

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

◆ 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 266 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_TOOL::AutoplaceFields(), LIB_PIN::CalcEdit(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), 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_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_MOVE_TOOL::getConnectedDragItems(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), SCH_SCREEN::IsTerminalPoint(), EE_POINT_EDITOR::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 2451 of file sch_symbol.cpp.

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

◆ IsPower()

bool SCH_SYMBOL::IsPower ( ) const

Definition at line 2490 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 756 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 701 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(), SCH_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(), SCH_COMMIT::Stage(), GERBVIEW_SELECTION_TOOL::unselect(), SCH_FIND_REPLACE_TOOL::UpdateFind(), HIERARCHY_PANE::UpdateHierarchySelection(), PCB_FIELD::ViewGetLOD(), 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 164 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 2472 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 165 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(), LABEL_SEARCH_HANDLER::Search(), 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 292 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 312 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 1965 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 123 of file eda_item.cpp.

References CTX_SEARCH, EDA_COMBINED_MATCHER::Find(), EDA_SEARCH_DATA::findString, EDA_ITEM::IsReplaceable(), isWordChar(), 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 1910 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 1928 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 623 of file sch_symbol.h.

References m_fields, and m_pos.

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 2201 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 249 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 2164 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 2207 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 2186 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 2306 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 2384 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_DNP_MARKER, 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 2403 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 510 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_DNP_MARKER, 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 498 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.

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

References m_fields, and MANDATORY_FIELDS.

Referenced by BACK_ANNOTATE::applyChangelist().

◆ RemoveField() [2/2]

void SCH_SYMBOL::RemoveField ( SCH_FIELD * aField )

inline

Definition at line 441 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 589 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 340 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 399 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 186 of file eda_item.cpp.

References EDA_SEARCH_DATA::findString, isWordChar(), 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().

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

References _, GetDescription(), GetDNP(), GetExcludedFromBoard(), GetExcludedFromBOM(), GetExcludedFromSim(), GetFootprintFieldText(), GetKeyWords(), SCHEMATIC::GetOperatingPoint(), GetPins(), GetRef(), TEMPLATES::GetTemplateFieldNames(), LIB_ID::GetUniStringLibItemName(), LIB_ID::GetUniStringLibNickname(), GetUnitSelection(), SCH_SHEET_PATH::Last(), SCH_CONNECTION::LocalName(), m_fields, m_lib_id, SCHEMATIC_SETTINGS::m_TemplateFieldNames, MANDATORY_FIELDS, SCH_CONNECTION::Name(), pin, REFERENCE_FIELD, SCHEMATIC::ResolveCrossReference(), SCH_SHEET::ResolveTextVar(), SCH_ITEM::Schematic(), SCHEMATIC::Settings(), and LIB_SYMBOL::SubReference().

Referenced by KIGFX::SCH_PAINTER::expandLibItemTextVars(), FIELDS_EDITOR_GRID_DATA_MODEL::getFieldShownText(), 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 1946 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 1102 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::createNewSheetPin(), 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_ITEM::GetFontMetrics(), 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(), SCH_FIELD::OnScintillaCharAdded(), Plot(), SCH_COMMIT::pushSchEdit(), SCH_LABEL_BASE::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), ResolveTextVar(), SCH_COMMIT::Revert(), 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 SCH_PROPERTIES_PANEL::valueChanged(), and 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(), SYMBOL_EDIT_FRAME::FocusOnItem(), 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 164 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 428 of file sch_item.h.

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_LINE::BreakAt(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LINE::MergeOverlap(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_COMMIT::Revert(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetConvert()

void SCH_SYMBOL::SetConvert ( int aConvert )

Definition at line 454 of file sch_symbol.cpp.

References m_convert, and UpdatePins().

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

◆ SetDNP()

void SCH_SYMBOL::SetDNP ( bool aDNP )

inline

Definition at line 748 of file sch_symbol.h.

References m_DNP.

Referenced by BACK_ANNOTATE::applyChangelist(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), SCH_EDIT_TOOL::SetAttribute(), FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), SCH_EDIT_TOOL::ToggleAttribute(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_TOOL::UnsetAttribute().

◆ SetExcludedFromBoard()

void SCH_SYMBOL::SetExcludedFromBoard ( bool aIncludeOnBoard )

inline

Definition at line 745 of file sch_symbol.h.

References m_excludedFromBoard.

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), SCH_EDIT_TOOL::SetAttribute(), FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), SCH_EDIT_TOOL::ToggleAttribute(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_TOOL::UnsetAttribute().

◆ SetExcludedFromBOM()

void SCH_SYMBOL::SetExcludedFromBOM ( bool aIncludeInBOM )

inline

Definition at line 742 of file sch_symbol.h.

References m_excludedFromBOM.

Referenced by BACK_ANNOTATE::applyChangelist(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), SCH_EDIT_TOOL::SetAttribute(), FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), SCH_EDIT_TOOL::ToggleAttribute(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_TOOL::UnsetAttribute().

◆ SetExcludedFromSim()

void SCH_SYMBOL::SetExcludedFromSim ( bool aExclude )

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 739 of file sch_symbol.h.

References m_excludedFromSim.

Referenced by SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), SCH_EDIT_TOOL::SetAttribute(), FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), SCH_EDIT_TOOL::ToggleAttribute(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_TOOL::UnsetAttribute().

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )

inlineinherited

Definition at line 445 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.

◆ SetFootprintFieldText()

void SCH_SYMBOL::SetFootprintFieldText ( const wxString & aFootprint )

Definition at line 907 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 150 of file view_item.h.

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

References EDA_ITEM::m_forceVisible.

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

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 156 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 436 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 264 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 287 of file sch_symbol.cpp.

References m_lib_id.

Referenced by SCH_SCREENS::ChangeSymbolLibNickname(), CADSTAR_SCH_ARCHIVE_PLUGIN::LoadSchematicFile(), 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 302 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 245 of file sch_item.h.

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 64 of file eda_item.cpp.

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), and EDA_ITEM::SetModified().

◆ 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 1519 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::AddPrimitivePoly(), 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(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), LIB_SYMBOL::Flatten(), FOOTPRINT::FootprintNeedsUpdate(), 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=(), SCH_SEXPR_PARSER::parseLibSymbol(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), PAD_TOOL::RecombinePad(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), 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(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetPosition()

void SCH_SYMBOL::SetPosition ( const VECTOR2I & aPosition )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 704 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 274 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 762 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(), SCH_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 186 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(), GERBVIEW_SELECTION_TOOL::selectVisually(), and SCH_COMMIT::Stage().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( const VECTOR2I & aPos )

inlineinherited

Definition at line 221 of file sch_item.h.

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::doMoveSelection().

◆ 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 478 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 466 of file sch_symbol.cpp.

References m_transform.

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

References 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 855 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 874 of file sch_symbol.cpp.

References m_instanceReferences.

◆ SetValueFieldText()

void SCH_SYMBOL::SetValueFieldText ( const wxString & aValue )

Definition at line 891 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 428 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 611 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 1179 of file sch_symbol.cpp.

References m_convert, m_DNP, m_excludedFromBoard, m_excludedFromBOM, m_excludedFromSim, m_fields, m_instanceReferences, m_lib_id, m_part, m_pins, m_pos, m_schLibSymbolName, m_transform, m_unit, pin, SCH_SYMBOL_T, EDA_ITEM::SetParent(), SCH_ITEM::SwapFlags(), EDA_ITEM::Type(), and UpdatePins().

◆ SwapFlags()

void SCH_ITEM::SwapFlags ( SCH_ITEM * aItem )

inherited

Swap the non-temp and non-edit flags.

Definition at line 267 of file sch_item.cpp.

References EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearTempFlags(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetTempFlags(), EDA_ITEM::m_flags, and EDA_ITEM::SetFlags().

Referenced by SCH_BITMAP::SwapData(), SCH_BUS_ENTRY_BASE::SwapData(), SCH_FIELD::SwapData(), SCH_JUNCTION::SwapData(), SCH_LINE::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_SHAPE::SwapData(), SCH_SHEET::SwapData(), SwapData(), and SCH_TEXT::SwapData().

◆ 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.

◆ 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 1987 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 1033 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(), SCH_FIELD::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 338 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 812 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 448 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 188 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 273 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 113 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 251 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_FIELD, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 139 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 145 of file view_item.h.

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 2092 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 517 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 520 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 511 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 522 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 771 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 800 of file sch_symbol.h.

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

◆ m_excludedFromBoard

bool SCH_SYMBOL::m_excludedFromBoard

private

True to exclude from netlist when updating board.

Definition at line 799 of file sch_symbol.h.

Referenced by GetExcludedFromBoard(), Init(), SCH_SYMBOL(), SetExcludedFromBoard(), and SwapData().

◆ m_excludedFromBOM

bool SCH_SYMBOL::m_excludedFromBOM

private

True to exclude from bill of materials export.

Definition at line 798 of file sch_symbol.h.

Referenced by GetExcludedFromBOM(), Init(), SCH_SYMBOL(), SetExcludedFromBOM(), and SwapData().

◆ m_excludedFromSim

bool SCH_SYMBOL::m_excludedFromSim

private

True to exclude from simulation.

Definition at line 797 of file sch_symbol.h.

Referenced by GetExcludedFromSim(), Init(), SCH_SYMBOL(), SetExcludedFromSim(), and SwapData().

◆ m_fields

std::vector<SCH_FIELD> SCH_SYMBOL::m_fields

private

Variable length list of fields.

Definition at line 789 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(), SetFootprintFieldText(), SetRef(), SetValueFieldText(), SwapData(), and Visit().

◆ m_fieldsAutoplaced

FIELDS_AUTOPLACED SCH_ITEM::m_fieldsAutoplaced

protectedinherited

Definition at line 512 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 487 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::GetTempFlags(), 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(), SCH_ITEM::SwapFlags(), and EDA_ITEM::XorFlags().

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 164 of file view_item.h.

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

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 486 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_instanceReferences

std::vector<SCH_SYMBOL_INSTANCE> SCH_SYMBOL::m_instanceReferences

private

Definition at line 804 of file sch_symbol.h.

Referenced by AddHierarchicalReference(), AddSheetPathReferenceEntryIfMissing(), ClearAnnotation(), GetInstance(), GetInstanceReferences(), GetRef(), GetUnitSelection(), IsAnnotated(), operator=(), RemoveInstance(), 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 796 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 510 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 769 of file sch_symbol.h.

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

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 485 of file eda_item.h.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::DoHypertextAction(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), PCB_FIELD::GetCanonicalName(), SCH_FIELD::GetDrawRotation(), SCH_FIELD::GetMenuImage(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_FIELD::GetName(), PCB_FIELD::GetName(), LIB_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParent(), EDA_ITEM::GetParent(), BOARD_ITEM::GetParentAsString(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), LIB_FIELD::HitTest(), 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 791 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*, SCH_PIN*> SCH_SYMBOL::m_pinMap

private

library pin pointer : SCH_PIN's index

Definition at line 794 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 793 of file sch_symbol.h.

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

◆ m_pos

VECTOR2I SCH_SYMBOL::m_pos

private

Definition at line 768 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 774 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 786 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 513 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 494 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 788 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 770 of file sch_symbol.h.

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

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 482 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 163 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::OnDestroy(), KIGFX::VIEW::Remove(), 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 807 of file sch_symbol.h.

Referenced by GetOrientation().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCH_SYMBOL() [1/4]

◆ SCH_SYMBOL() [2/4]

◆ SCH_SYMBOL() [3/4]

◆ SCH_SYMBOL() [4/4]

◆ ~SCH_SYMBOL()

Member Function Documentation

◆ AddConnectionTo()

◆ AddField()

◆ AddHierarchicalReference() [1/2]

◆ AddHierarchicalReference() [2/2]

◆ AddSheetPathReferenceEntryIfMissing()

◆ AutoAutoplaceFields()

◆ AutoplaceFields()

◆ CanConnect()

◆ ClassOf()

◆ ClearAnnotation()

◆ ClearBrightened()

◆ ClearBrightenedPins()

◆ ClearCaches()

◆ ClearConnections()

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ ConnectedItems()

◆ Connection()

◆ ConnectionPropagatesTo()

◆ doGetBoundingBox()

◆ DoHypertextAction()

◆ doIsConnected()

◆ Duplicate()

◆ FindField()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAllLibPins()

◆ GetBodyAndPinsBoundingBox()

◆ GetBodyBoundingBox()

◆ GetBoundingBox()

◆ GetCachedDriverName()

◆ GetClass()

◆ GetConnectionPoints()

◆ GetContextualTextVars()

◆ GetConvert()

◆ GetDatasheet()

◆ GetDefaultFont()

◆ GetDescription()

◆ GetDNP()

◆ GetDrawItem()

◆ GetEditFlags()

◆ GetEffectiveNetClass()

◆ GetEndPoints()

◆ GetExcludedFromBoard()

◆ GetExcludedFromBOM()

◆ GetExcludedFromSim()

◆ GetField() [1/2]

◆ GetField() [2/2]

◆ GetFieldById()

◆ GetFieldByName() [1/2]

◆ GetFieldByName() [2/2]

◆ GetFieldCount()

◆ GetFields() [1/3]

◆ GetFields() [2/3]

◆ GetFields() [3/3]

◆ GetFieldsAutoplaced()

◆ GetFieldText()

◆ GetFlags()

◆ GetFocusPosition()