Holds all the data relating to one schematic. More...

#include <schematic.h>

Inheritance diagram for SCHEMATIC:

Public Member Functions
	SCHEMATIC (PROJECT *aPrj)

virtual	~SCHEMATIC ()

virtual wxString	GetClass () const override
	Return the class name. More...

void	Reset ()
	Initialize this schematic to a blank one, unloading anything existing. More...

PROJECT &	Prj () const override
	Return a reference to the project this schematic is part of. More...

void	SetProject (PROJECT *aPrj)

const std::map< wxString, wxString > *	GetProperties ()

SCH_SHEET_LIST	GetSheets () const override
	Builds and returns an updated schematic hierarchy TODO: can this be cached? More...

SCH_SHEET &	Root () const

void	SetRoot (SCH_SHEET *aRootSheet)
	Initialize the schematic with a new root sheet. More...

bool	IsValid () const
	A simple test if the schematic is loaded, not a complete one. More...

SCH_SCREEN *	RootScreen () const
	Helper to retrieve the screen of the root sheet. More...

bool	ResolveTextVar (wxString *token, int aDepth) const

wxString	GetFileName () const override
	Helper to retrieve the filename from the root sheet screen. More...

SCH_SHEET_PATH &	CurrentSheet () const override

void	SetCurrentSheet (const SCH_SHEET_PATH &aPath) override

CONNECTION_GRAPH *	ConnectionGraph () const override

SCHEMATIC_SETTINGS &	Settings () const

ERC_SETTINGS &	ErcSettings () const

std::vector< SCH_MARKER * >	ResolveERCExclusions ()

std::shared_ptr< BUS_ALIAS >	GetBusAlias (const wxString &aLabel) const
	Return a pointer to a bus alias object for the given label, or null if one doesn't exist. More...

std::set< wxString >	GetNetClassAssignmentCandidates ()
	Return the set of netname candidates for netclass assignment. More...

bool	ResolveCrossReference (wxString *token, int aDepth) const
	Resolves text vars that refer to other items. More...

std::map< wxString, std::set< int > > &	GetPageRefsMap ()

std::map< int, wxString >	GetVirtualPageToSheetNamesMap () const

std::map< int, wxString >	GetVirtualPageToSheetPagesMap () const

wxString	ConvertRefsToKIIDs (const wxString &aSource) const

wxString	ConvertKIIDsToRefs (const wxString &aSource) const

SCH_SHEET_LIST &	GetFullHierarchy () const
	Return the full schematic flattened hierarchical sheet list. More...

void	SetLegacySymbolInstanceData ()
	Update the symbol value and footprint instance data for legacy designs. More...

KICAD_T	Type () const
	Returns the type of object. More...

EDA_ITEM *	GetParent () const

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsDragging () const

bool	IsWireImage () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsResized () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetWireImage ()

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

virtual bool	IsType (const std::vector< KICAD_T > &aScanTypes) const
	Check whether the item is one of the listed types. More...

void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...

bool	IsForceVisible () const

virtual void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
	Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...

virtual bool	HitTest (const VECTOR2I &aPosition, int aAccuracy=0) const
	Test if aPosition is inside or on the boundary of this item. More...

virtual bool	HitTest (const BOX2I &aRect, bool aContained, int aAccuracy=0) const
	Test if aRect intersects this item. More...

virtual const BOX2I	GetBoundingBox () const
	Return the orthogonal bounding box of this object for display purposes. More...

virtual VECTOR2I	GetPosition () const

virtual void	SetPosition (const VECTOR2I &aPos)

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

virtual EDA_ITEM *	Clone () const
	Create a duplicate of this item with linked list members set to NULL. More...

virtual INSPECT_RESULT	Visit (INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes)
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...

wxString	GetTypeDesc ()
	Return a translated description of the type for this EDA_ITEM for display in user facing messages. More...

virtual wxString	GetSelectMenuText (UNITS_PROVIDER *aUnitsProvider) const
	Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...

virtual BITMAPS	GetMenuImage () const
	Return a pointer to an image to be used in menus. More...

virtual bool	Matches (const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData. 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 bool	IsReplaceable () const
	Override this method in any derived object that supports test find and replace. More...

bool	operator< (const EDA_ITEM &aItem) const
	Test if another item is less than this object. More...

virtual const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers. More...

virtual void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the all the layers within the VIEW the object is painted on. More...

virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Draw the parts of the object belonging to layer aLayer. More...

virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Return the level of detail (LOD) of the item. More...

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)

template<typename T >
bool	Set (const wxString &aProperty, T aValue)

wxAny	Get (PROPERTY_BASE *aProperty) 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
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
EDA_ITEM_FLAGS	m_status

EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

Private Attributes
PROJECT *	m_project

SCH_SHEET *	m_rootSheet
	The top-level sheet in this schematic hierarchy (or potentially the only one) More...

SCH_SHEET_PATH *	m_currentSheet
	The sheet path of the sheet currently being edited or displayed. More...

CONNECTION_GRAPH *	m_connectionGraph
	Holds and calculates connectivity information of this schematic. More...

std::map< wxString, std::set< int > >	m_labelToPageRefsMap
	Holds a map of labels to the page sequence (virtual page number) that they appear on. More...

std::map< wxString, wxString >	m_properties
	Properties for text variable substitution (and perhaps other uses in future). More...

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

Friends
class	SCH_EDIT_FRAME

Detailed Description

Holds all the data relating to one schematic.

A schematic may consist of one or more sheets (and one root sheet) Right now, Eeschema can have only one schematic open at a time, but this could change. Please keep this possibility in mind when adding to this object.

Definition at line 59 of file schematic.h.

Constructor & Destructor Documentation

◆ SCHEMATIC()

SCHEMATIC::SCHEMATIC ( PROJECT * aPrj )

Definition at line 32 of file schematic.cpp.

 :
 EDA_ITEM( nullptr, SCHEMATIC_T ),
 m_project( nullptr ),
 m_rootSheet( nullptr )
{
 m_currentSheet = new SCH_SHEET_PATH();
 m_connectionGraph = new CONNECTION_GRAPH( this );
 
 SetProject( aPrj );
}

References m_connectionGraph, m_currentSheet, and SetProject().

◆ ~SCHEMATIC()

SCHEMATIC::~SCHEMATIC ( )

virtual

Definition at line 44 of file schematic.cpp.

{
 delete m_currentSheet;
 delete m_connectionGraph;
}

References m_connectionGraph, and m_currentSheet.

Member Function Documentation

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 122 of file eda_item.h.

122{ ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:143

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:66

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 160 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

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

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 143 of file eda_item.h.

143{ m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:498

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), 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_TEST_PROVIDER_COURTYARD_CLEARANCE_ON_MOVE::Init(), EE_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetIsShownAsBitmap(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 121 of file eda_item.h.

121{ ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Item was manually selected by the user.

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 155 of file eda_item.h.

 {
 ClearFlags( CANDIDATE | SELECTED_BY_DRAG | IS_LINKED | SKIP_STRUCT | DO_NOT_DRAW );
 }

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

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

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * EDA_ITEM::Clone ( ) const

virtualinherited

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 in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, KIGFX::ORIGIN_VIEWITEM, PCB_GROUP, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, NETINFO_ITEM, PAD, PCB_BITMAP, PCB_DIM_ALIGNED, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIM_LEADER, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_ARC, PCB_VIA, ZONE, and FP_ZONE.

Definition at line 82 of file eda_item.cpp.

{
 wxCHECK_MSG( false, nullptr, wxT( "Clone not implemented in derived class " ) + GetClass() +
 wxT( ". Bad programmer!" ) );
}

References EDA_ITEM::GetClass().

Referenced by SCH_EDIT_FRAME::AddCopyForRepeatItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_DIMENSION_BASE::GetEffectiveShape(), LIB_SYMBOL::LIB_SYMBOL(), new_clone(), LIB_SYMBOL::operator=(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), LIB_SYMBOL::SetConversion(), LIB_SYMBOL::SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), COMMIT::Stage(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ConnectionGraph()

CONNECTION_GRAPH * SCHEMATIC::ConnectionGraph ( ) const

inlineoverridevirtual

Implements SCHEMATIC_IFACE.

Definition at line 129 of file schematic.h.

 {
 return m_connectionGraph;
 }

References m_connectionGraph.

Referenced by DIALOG_MIGRATE_BUSES::getProposedLabels(), DIALOG_MIGRATE_BUSES::loadGraphData(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::RecalculateConnections(), DIALOG_ERC::testErc(), ERC_TESTER::TestMultUnitPinConflicts(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and SCH_SCREENS::UpdateSymbolLinks().

◆ ConvertKIIDsToRefs()

wxString SCHEMATIC::ConvertKIIDsToRefs ( const wxString & aSource ) const

Definition at line 387 of file schematic.cpp.

{
 wxString newbuf;
 size_t sourceLen = aSource.length();
 
 for( size_t i = 0; i < sourceLen; ++i )
 {
 if( aSource[i] == '$' && i + 1 < sourceLen && aSource[i+1] == '{' )
 {
 wxString token;
 bool isCrossRef = false;
 
 for( i = i + 2; i < sourceLen; ++i )
 {
 if( aSource[i] == '}' )
 break;
 
 if( aSource[i] == ':' )
 isCrossRef = true;
 
 token.append( aSource[i] );
 }
 
 if( isCrossRef )
 {
 SCH_SHEET_LIST sheetList = GetSheets();
 wxString remainder;
 wxString ref = token.BeforeFirst( ':', &remainder );
 
 SCH_SHEET_PATH refSheetPath;
 SCH_ITEM* refItem = sheetList.GetItem( KIID( ref ), &refSheetPath );
 
 if( refItem && refItem->Type() == SCH_SYMBOL_T )
 {
 SCH_SYMBOL* refSymbol = static_cast<SCH_SYMBOL*>( refItem );
 token = refSymbol->GetRef( &refSheetPath, true ) + ":" + remainder;
 }
 }
 
 newbuf.append( "${" + token + "}" );
 }
 else
 {
 newbuf.append( aSource[i] );
 }
 }
 
 return newbuf;
}

References SCH_SHEET_LIST::GetItem(), SCH_SYMBOL::GetRef(), GetSheets(), SCH_SYMBOL_T, and EDA_ITEM::Type().

Referenced by DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ ConvertRefsToKIIDs()

wxString SCHEMATIC::ConvertRefsToKIIDs ( const wxString & aSource ) const

Definition at line 319 of file schematic.cpp.

{
 wxString newbuf;
 size_t sourceLen = aSource.length();
 
 for( size_t i = 0; i < sourceLen; ++i )
 {
 if( aSource[i] == '$' && i + 1 < sourceLen && aSource[i+1] == '{' )
 {
 wxString token;
 bool isCrossRef = false;
 int nesting = 0;
 
 for( i = i + 2; i < sourceLen; ++i )
 {
 if( aSource[i] == '{'
 && ( aSource[i-1] == '_' || aSource[i-1] == '^' || aSource[i-1] == '~' ) )
 {
 nesting++;
 }
 
 if( aSource[i] == '}' )
 {
 nesting--;
 
 if( nesting < 0 )
 break;
 }
 
 if( aSource[i] == ':' )
 isCrossRef = true;
 
 token.append( aSource[i] );
 }
 
 if( isCrossRef )
 {
 SCH_SHEET_LIST sheetList = GetSheets();
 wxString remainder;
 wxString ref = token.BeforeFirst( ':', &remainder );
 SCH_REFERENCE_LIST references;
 
 sheetList.GetSymbols( references );
 
 for( size_t jj = 0; jj < references.GetCount(); jj++ )
 {
 SCH_SYMBOL* refSymbol = references[ jj ].GetSymbol();
 
 if( ref == refSymbol->GetRef( &references[ jj ].GetSheetPath(), true ) )
 {
 token = refSymbol->m_Uuid.AsString() + ":" + remainder;
 break;
 }
 }
 }
 
 newbuf.append( "${" + token + "}" );
 }
 else
 {
 newbuf.append( aSource[i] );
 }
 }
 
 return newbuf;
}

References KIID::AsString(), SCH_REFERENCE_LIST::GetCount(), SCH_SYMBOL::GetRef(), GetSheets(), SCH_SHEET_LIST::GetSymbols(), and EDA_ITEM::m_Uuid.

Referenced by DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ CurrentSheet()

SCH_SHEET_PATH & SCHEMATIC::CurrentSheet ( ) const

inlineoverridevirtual

◆ ErcSettings()

ERC_SETTINGS & SCHEMATIC::ErcSettings ( ) const

Definition at line 179 of file schematic.cpp.

{
 wxASSERT( m_project );
 return *m_project->GetProjectFile().m_ErcSettings;
}

References PROJECT::GetProjectFile(), PROJECT_FILE::m_ErcSettings, and m_project.

Referenced by PANEL_SETUP_PINMAP::changeErrorLevel(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), CONNECTION_GRAPH::ercCheckHierSheets(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckNoConnects(), SHEETLIST_ERC_ITEMS_PROVIDER::GetCount(), SCH_MARKER::GetSeverity(), SCH_EDIT_FRAME::GetSeverity(), DIALOG_ERC::OnERCItemRClick(), DIALOG_ERC::OnRunERCClick(), PANEL_SETUP_PINMAP::reBuildMatrixPanel(), SCH_EDIT_FRAME::RecordERCExclusions(), PANEL_SETUP_PINMAP::ResetPanel(), ResolveERCExclusions(), CONNECTION_GRAPH::RunERC(), SHEETLIST_ERC_ITEMS_PROVIDER::SetSeverities(), DIALOG_ERC::testErc(), ERC_TESTER::TestPinToPin(), and DIALOG_ERC::writeReport().

◆ Get() [1/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 std::optional<T> ret;
 
 if( prop )
 {
 const void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
 if( object )
 ret = prop->get<T>( object );
 }
 
 return ret;
 }

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

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

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

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

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( !object )
 throw std::runtime_error( "Could not cast INSPECTABLE to the requested type" );
 
 return aProperty->get<T>( object );
 }

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

◆ GetBoundingBox()

const BOX2I EDA_ITEM::GetBoundingBox ( ) const

virtualinherited

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 in LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_SYMBOL, LIB_TEXT, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, GBR_LAYOUT, GERBER_DRAW_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, BOARD, FOOTPRINT, FP_TEXT, NETINFO_ITEM, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TRACK, ZONE, and DS_DRAW_ITEM_BASE.

Definition at line 74 of file eda_item.cpp.

{
 // return a zero-sized box per default. derived classes should override
 // this
 return BOX2I( VECTOR2I( 0, 0 ), VECTOR2I( 0, 0 ) );
}

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CN_ITEM::BBox(), SCH_EDIT_TOOL::ChangeTextType(), TEST_BOARD_ITEM_FIXTURE::CompareItems(), TEST_EE_ITEM_FIXTURE::CompareItems(), EE_RTREE::contains(), BOARD_COMMIT::dirtyIntersectingZones(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), SCH_DRAWING_TOOLS::DrawSheet(), enclosedByAreaFunc(), PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindNext(), LIB_ITEM::GetBoundingBox(), GetBoundingBoxes(), BOARD_ITEM::GetCenter(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), EE_SELECTION_TOOL::GuessSelectionCandidates(), EE_RTREE::insert(), intersectsAreaFunc(), SCH_SCREEN::MarkConnections(), SCH_EDIT_TOOL::Mirror(), DRC_RTREE::QueryColliding(), EE_RTREE::remove(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges(), GERBVIEW_SELECTION::ViewBBox(), and EDA_ITEM::ViewBBox().

◆ GetBusAlias()

std::shared_ptr< BUS_ALIAS > SCHEMATIC::GetBusAlias ( const wxString & aLabel ) const

Return a pointer to a bus alias object for the given label, or null if one doesn't exist.

Definition at line 225 of file schematic.cpp.

{
 for( const SCH_SHEET_PATH& sheet : GetSheets() )
 {
 for( const std::shared_ptr<BUS_ALIAS>& alias : sheet.LastScreen()->GetBusAliases() )
 {
 if( alias->GetName() == aLabel )
 return alias;
 }
 }
 
 return nullptr;
}

References GetSheets().

◆ GetClass()

virtual wxString SCHEMATIC::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 66 of file schematic.h.

 {
 return wxT( "SCHEMATIC" );
 }

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 147 of file eda_item.h.

 {
 constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
 | IS_CHANGED | IS_WIRE_IMAGE | STRUCT_DELETED );
 
 return m_flags & mask;
 }

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

◆ GetFileName()

wxString SCHEMATIC::GetFileName ( void ) const

overridevirtual

Helper to retrieve the filename from the root sheet screen.

Implements SCHEMATIC_IFACE.

Definition at line 166 of file schematic.cpp.

{
 return IsValid() ? m_rootSheet->GetScreen()->GetFileName() : wxString( wxEmptyString );
}

References SCH_SCREEN::GetFileName(), SCH_SHEET::GetScreen(), IsValid(), and m_rootSheet.

Referenced by SCH_EDIT_FRAME::GetCurrentFileName(), GetRescueLibraryFileName(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), NETLIST_DIALOG::OnRunExternSpiceCommand(), DIALOG_BOM::OnRunGenerator(), ResolveTextVar(), SCH_EDITOR_CONTROL::Revert(), SCH_SHEET_LIST::TestForRecursion(), SCH_SHEET_PATH::TestForRecursion(), and NETLIST_DIALOG::TransferDataFromWindow().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 144 of file eda_item.h.

144{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), collidesWithArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), LIB_SYMBOL::LIB_SYMBOL(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD_TOOL::RecombinePad(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 256 of file eda_item.h.

256{ return GetPosition(); }

EDA_ITEM::GetPosition

virtual VECTOR2I GetPosition() const

Definition: eda_item.h:249

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetFullHierarchy()

SCH_SHEET_LIST & SCHEMATIC::GetFullHierarchy ( ) const

Return the full schematic flattened hierarchical sheet list.

Definition at line 438 of file schematic.cpp.

{
 static SCH_SHEET_LIST hierarchy;
 
 hierarchy.clear();
 hierarchy.BuildSheetList( m_rootSheet, false );
 
 return hierarchy;
}

References SCH_SHEET_LIST::BuildSheetList(), and m_rootSheet.

Referenced by DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ GetMenuImage()

BITMAPS EDA_ITEM::GetMenuImage ( ) const

virtualinherited

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 in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_DIM_ALIGNED, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIM_LEADER, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 269 of file eda_item.cpp.

{
 return BITMAPS::dummy_item;
}

References dummy_item.

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ GetMsgPanelInfo()

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

inlinevirtualinherited

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

Parameters

aList is the list to populate.

Reimplemented in LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, GERBER_DRAW_ITEM, DS_DRAW_ITEM_BASE, PCB_GROUP, BOARD, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, NETINFO_ITEM, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_DIM_ALIGNED, PCB_DIM_LEADER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 211 of file eda_item.h.

212 {

213 }

Referenced by SCH_SHAPE::GetMsgPanelInfo(), EDA_DRAW_FRAME::SetMsgPanel(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), and FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel().

◆ GetNetClassAssignmentCandidates()

std::set< wxString > SCHEMATIC::GetNetClassAssignmentCandidates ( )

Return the set of netname candidates for netclass assignment.

The list will include both composite names (buses) and atomic net names. Names are fetched from available labels, power pins, etc.

Definition at line 240 of file schematic.cpp.

{
 std::set<wxString> names;
 
 for( const auto& [ key, subgraphList ] : m_connectionGraph->GetNetMap() )
 {
 CONNECTION_SUBGRAPH* firstSubgraph = subgraphList[0];
 
 if( !firstSubgraph->m_driver_connection->IsBus()
 && firstSubgraph->GetDriverPriority() >= CONNECTION_SUBGRAPH::PRIORITY::PIN )
 {
 names.insert( key.Name );
 }
 }
 
 return names;
}

References CONNECTION_SUBGRAPH::GetDriverPriority(), CONNECTION_GRAPH::GetNetMap(), SCH_CONNECTION::IsBus(), m_connectionGraph, CONNECTION_SUBGRAPH::m_driver_connection, and CONNECTION_SUBGRAPH::PIN.

Referenced by SCH_EDITOR_CONTROL::AssignNetclass(), and DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP().

◆ GetPageRefsMap()

std::map< wxString, std::set< int > > & SCHEMATIC::GetPageRefsMap ( )

inline

Definition at line 160 of file schematic.h.

160{ return m_labelToPageRefsMap; }

SCHEMATIC::m_labelToPageRefsMap

std::map< wxString, std::set< int > > m_labelToPageRefsMap

Holds a map of labels to the page sequence (virtual page number) that they appear on.

Definition: schematic.h:209

References m_labelToPageRefsMap.

Referenced by SCH_LABEL_BASE::GetIntersheetRefs(), SCH_EDIT_FRAME::RecomputeIntersheetRefs(), and SCH_GLOBALLABEL::ResolveTextVar().

◆ GetParent()

EDA_ITEM * EDA_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 99 of file eda_item.h.

99{ return m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:496

References EDA_ITEM::m_parent.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::editFieldText(), SCH_FIELD::GetFieldColor(), getInferredSymbols(), SCH_PIN::GetParentSymbol(), EE_SELECTION_TOOL::highlight(), highlightNet(), SCH_FIELD::HitTest(), SCH_PIN::IsStacked(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), BOARD_COMMIT::parentObject(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_EDITOR_CONTROL::ReplaceAll(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_ITEM::Schematic(), SCH_SCREEN::Schematic(), SCH_SHEET::SearchHierarchy(), PCB_SELECTION_TOOL::select(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), EE_SELECTION_TOOL::unhighlight(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), EE_TOOL_BASE< T >::updateItem(), and SCH_BASE_FRAME::UpdateItem().

◆ GetPosition()

virtual VECTOR2I EDA_ITEM::GetPosition ( ) const

inlinevirtualinherited

Reimplemented in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, GERBER_DRAW_ITEM, DELETED_BOARD_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, KIGFX::ORIGIN_VIEWITEM, PCB_GROUP, BOARD, FOOTPRINT, FP_TEXT, NETINFO_ITEM, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TRACK, PCB_ARC, PCB_VIA, and ZONE.

Definition at line 249 of file eda_item.h.

249{ return VECTOR2I(); }

Referenced by SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::ChangeTextType(), TEST_BOARD_ITEM_FIXTURE::CompareItems(), TEST_EE_ITEM_FIXTURE::CompareItems(), PCB_GRID_HELPER::computeAnchors(), EE_GRID_HELPER::computeAnchors(), SCH_EDIT_FRAME::DeleteJunction(), KIGFX::PCB_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNetclassConflicts(), CONNECTION_GRAPH::ercCheckNoConnects(), PCB_SELECTION_TOOL::FindItem(), GERBVIEW_SELECTION::GetCenter(), EDA_ITEM::GetFocusPosition(), getMinDist(), SCH_FIELD::GetParentPosition(), EDA_ITEM::GetSortPosition(), PCB_SELECTION::GetTopLeftItem(), EE_SELECTION::GetTopLeftItem(), BOARD_ITEM::GetX(), BOARD_ITEM::GetY(), SCH_MOVE_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_EDITOR_CONTROL::nextMatch(), DIALOG_MIGRATE_BUSES::onItemSelected(), BOARD::cmp_items::operator()(), SCH_ITEM::operator<(), SCH_EDITOR_CONTROL::Paste(), PL_EDIT_TOOL::Paste(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::PositionRelative(), BACK_ANNOTATE::processNetNameChange(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), RC_ITEM::ShowReport(), SCH_EDIT_TOOL::Swap(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_MISC::testTextVars(), TransformItem(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), EDIT_TOOL::updateModificationPoint(), PL_EDIT_TOOL::updateModificationPoint(), and EE_POINT_EDITOR::updatePoints().

◆ GetProperties()

const std::map< wxString, wxString > * SCHEMATIC::GetProperties ( )

inline

Definition at line 78 of file schematic.h.

78{ return &m_properties; }

SCHEMATIC::m_properties

std::map< wxString, wxString > m_properties

Properties for text variable substitution (and perhaps other uses in future).

Definition: schematic.h:214

References m_properties.

Referenced by KIGFX::SCH_VIEW::DisplaySheet(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), and SCH_PRINTOUT::PrintPage().

◆ GetSelectMenuText()

wxString EDA_ITEM::GetSelectMenuText ( UNITS_PROVIDER * aUnitsProvider ) const

virtualinherited

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

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

Returns: The menu text string.

Reimplemented in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, DELETED_SHEET_ITEM, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, GERBER_DRAW_ITEM, DELETED_BOARD_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, BOARD, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 108 of file eda_item.cpp.

{
 wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
 GetClass() );
 
 return wxString( wxT( "Undefined menu text for " ) + GetClass() );
}

References EDA_ITEM::GetClass().

Referenced by CONNECTION_GRAPH::collectAllDriverValues(), DIALOG_GROUP_PROPERTIES::DoAddMember(), SELECTION_TOOL::doSelectionMenu(), DRC_ENGINE::EvalRules(), BOARD_INSPECTION_TOOL::getItemDescription(), PCB_MARKER::GetMsgPanelInfo(), RC_TREE_MODEL::GetValue(), RC_ITEM::ShowReport(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetSheets()

SCH_SHEET_LIST SCHEMATIC::GetSheets ( ) const

inlineoverridevirtual

Builds and returns an updated schematic hierarchy TODO: can this be cached?

Returns: a SCH_SHEET_LIST containing the schematic hierarchy

Implements SCHEMATIC_IFACE.

Definition at line 85 of file schematic.h.

 {
 return SCH_SHEET_LIST( m_rootSheet );
 }

References m_rootSheet.

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

265{ return GetPosition(); }

References EDA_ITEM::GetPosition().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 126 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 139 of file eda_item.h.

139{ return m_status; }

References EDA_ITEM::m_status.

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( )

inherited

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

Definition at line 301 of file eda_item.cpp.

{
 //@see EDA_ITEM_DESC for definition of ENUM_MAP<KICAD_T>
 wxString typeDescr = ENUM_MAP<KICAD_T>::Instance().ToString( Type() );
 
 return wxGetTranslation( typeDescr );
}

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

Referenced by PROPERTIES_PANEL::update().

◆ GetVirtualPageToSheetNamesMap()

std::map< int, wxString > SCHEMATIC::GetVirtualPageToSheetNamesMap ( ) const

Definition at line 292 of file schematic.cpp.

{
 std::map<int, wxString> namesMap;
 
 for( const SCH_SHEET_PATH& sheet : GetSheets() )
 {
 if( sheet.size() == 1 )
 namesMap[sheet.GetVirtualPageNumber()] = _( "<root sheet>" );
 else
 namesMap[sheet.GetVirtualPageNumber()] = sheet.Last()->GetName();
 }
 
 return namesMap;
}

References _, and GetSheets().

Referenced by SCH_LABEL_BASE::GetIntersheetRefs().

◆ GetVirtualPageToSheetPagesMap()

std::map< int, wxString > SCHEMATIC::GetVirtualPageToSheetPagesMap ( ) const

Definition at line 308 of file schematic.cpp.

{
 std::map<int, wxString> pagesMap;
 
 for( const SCH_SHEET_PATH& sheet : GetSheets() )
 pagesMap[sheet.GetVirtualPageNumber()] = sheet.GetPageNumber();
 
 return pagesMap;
}

References GetSheets().

Referenced by SCH_LABEL_BASE::GetIntersheetRefs(), and SCH_GLOBALLABEL::ResolveTextVar().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 145 of file eda_item.h.

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

References EDA_ITEM::m_flags.

Referenced by GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), SCH_MOVE_TOOL::Main(), SCH_SCREEN::MarkConnections(), SCH_MOVE_TOOL::moveItem(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< T >::saveCopyInUndoList().

◆ HitTest() [1/2]

virtual bool EDA_ITEM::HitTest	(	const BOX2I &	aRect,
		bool	aContained,
		int	aAccuracy = `0`
	)		const

inlinevirtualinherited

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 in LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, DS_DRAW_ITEM_BASE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, FOOTPRINT, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, PCB_ARC, ZONE, and GERBER_DRAW_ITEM.

Definition at line 235 of file eda_item.h.

 {
 return false; // derived classes should override this function
 }

◆ HitTest() [2/2]

virtual bool EDA_ITEM::HitTest	(	const VECTOR2I &	aPosition,
		int	aAccuracy = `0`
	)		const

inlinevirtualinherited

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 in RATSNEST_VIEW_ITEM, SCH_SHEET, FP_TEXT, FP_TEXTBOX, PCB_DIMENSION_BASE, PCB_TEXT, PCB_TEXTBOX, LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, DS_DRAW_ITEM_BASE, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, FOOTPRINT, PAD, PCB_BITMAP, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TRACK, PCB_ARC, PCB_VIA, ZONE, and GERBER_DRAW_ITEM.

Definition at line 222 of file eda_item.h.

 {
 return false; // derived classes should override this function
 }

Referenced by PCB_GRID_HELPER::AlignToNearestPad(), PL_SELECTION_TOOL::guessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), LIB_ITEM::HitTest(), DS_DRAW_ITEM_BASE::HitTest(), EE_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_SELECTION_TOOL::selectionContains(), and PCB_SELECTION_TOOL::selectMultiple().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

110{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 105 of file eda_item.h.

105{ return m_flags & IS_DRAGGING; }

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

108{ return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:73

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 203 of file eda_item.h.

203{ return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:497

References EDA_ITEM::m_forceVisible.

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

102{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

104{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

103{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

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

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

Reimplemented in LIB_TEXTBOX, SCH_FIELD, SCH_LABEL, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 420 of file eda_item.h.

420{ return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 109 of file eda_item.h.

109{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 112 of file eda_item.h.

 {
 return ( m_flags & ( IS_ROLLOVER | IS_MOVING ) ) == IS_ROLLOVER;
 }

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

107{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_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(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), 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_MOVE_TOOL::Main(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), KIGFX::SCH_PAINTER::nonCached(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), EE_SELECTION_TOOL::RebuildSelection(), PCB_SELECTION_TOOL::RebuildSelection(), RENDER_3D_OPENGL::renderFootprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), GERBVIEW_SELECTION_TOOL::unselect(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 175 of file eda_item.h.

175{ return m_flags & IS_SHOWN_AS_BITMAP; }

IS_SHOWN_AS_BITMAP

#define IS_SHOWN_AS_BITMAP

Definition: eda_item_flags.h:55

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsType()

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

inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

Returns: true if the item type is contained in the list aScanTypes

Reimplemented in SCH_FIELD, SCH_ITEM, SCH_LABEL_BASE, SCH_LINE, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, and PCB_VIA.

Definition at line 183 of file eda_item.h.

 {
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == SCH_LOCATE_ANY_T || scanType == m_structType )
 return true;
 }
 
 return false;
 }

References EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_FIELD::GetCanonicalName(), KIGFX::SCH_PAINTER::getLineWidth(), SCH_FIELD::GetName(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_FIELD::GetShownText(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_ITEM::IsType(), FP_TEXT::IsType(), FP_TEXTBOX::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), PCB_SHAPE::IsType(), PCB_TEXT::IsType(), PCB_TEXTBOX::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), SCH_FIELD::SetId(), SCH_BASE_FRAME::UpdateItem(), and EDA_ITEM::Visit().

◆ IsValid()

bool SCHEMATIC::IsValid ( ) const

inline

A simple test if the schematic is loaded, not a complete one.

Definition at line 106 of file schematic.h.

 {
 return m_rootSheet != nullptr;
 }

References m_rootSheet.

Referenced by SCH_EDIT_FRAME::canCloseWindow(), GetFileName(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_SEXPR_PLUGIN::Load(), SCH_LEGACY_PLUGIN::Load(), and RootScreen().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

106{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

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

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

References CONTINUE, QUIT, and 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 322 of file eda_item.h.

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

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

◆ Matches() [1/2]

virtual bool EDA_ITEM::Matches	(	const EDA_SEARCH_DATA &	aSearchData,
		void *	aAuxData
	)		const

inlinevirtualinherited

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 in SCH_MARKER, LIB_TEXTBOX, SCH_FIELD, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, FP_TEXT, FP_TEXTBOX, NETINFO_ITEM, PCB_MARKER, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 382 of file eda_item.h.

 {
 return false;
 }

Referenced by SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_EDITOR_CONTROL::HasMatch(), SCH_MARKER::Matches(), LIB_TEXTBOX::Matches(), SCH_FIELD::Matches(), SCH_PIN::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_TEXTBOX::Matches(), FP_TEXT::Matches(), FP_TEXTBOX::Matches(), NETINFO_ITEM::Matches(), PCB_MARKER::Matches(), PCB_TEXT::Matches(), PCB_TEXTBOX::Matches(), ZONE::Matches(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_EDITOR_CONTROL::UpdateFind().

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

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 
 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( aSearchData.searchAndReplace && !IsReplaceable() )
 return false;
 
 if( !aSearchData.matchCase )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 return false;
 
 ii = next;
 next += searchText.length();
 
 bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 
 if( startOK && endOK )
 return true;
 else
 ii++;
 }
 
 return false;
 }
 else if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

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

◆ operator<()

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

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

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

◆ Prj()

PROJECT & SCHEMATIC::Prj ( ) const

inlineoverridevirtual

Return a reference to the project this schematic is part of.

Implements SCHEMATIC_IFACE.

Definition at line 75 of file schematic.h.

75{ return *m_project; }

References m_project.

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_VIEW::DisplaySheet(), SCH_ITEM::GetEffectiveNetClass(), SCH_ALTIUM_PLUGIN::getLibFileName(), SCH_EAGLE_PLUGIN::getLibFileName(), SCH_ALTIUM_PLUGIN::getLibName(), SCH_EAGLE_PLUGIN::getLibName(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_SEXPR_PLUGIN::Load(), SCH_LEGACY_PLUGIN::Load(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_EAGLE_PLUGIN::loadLibrary(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_ALTIUM_PLUGIN::ParseParameter(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), ResolveTextVar(), SCH_SHEET::ResolveTextVar(), ERC_TESTER::TestLibSymbolIssues(), ERC_TESTER::TestTextVars(), and SCH_SCREEN::UpdateSymbolLinks().

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 165 of file eda_item.h.

165{ return false; }

◆ 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_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 409 of file eda_item.h.

 {
 return false;
 }

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

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 wxString result;
 bool replaced = false;
 
 if( !aSearchData.matchCase )
 {
 text = text.Upper();
 searchText = searchText.Upper();
 }
 
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 {
 result += aText.Mid( ii, wxString::npos );
 break;
 }
 
 if( next > ii )
 result += aText.Mid( ii, next - ii );
 
 ii = next;
 next += searchText.length();
 
 bool startOK;
 bool endOK;
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 }
 else
 {
 startOK = true;
 endOK = true;
 }
 
 if( startOK && endOK )
 {
 result += aSearchData.replaceString;
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }
 
 aText = result;
 return replaced;
}

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

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

◆ Reset()

void SCHEMATIC::Reset ( )

Initialize this schematic to a blank one, unloading anything existing.

Definition at line 51 of file schematic.cpp.

{
 // Assume project already saved
 if( m_project )
 {
 PROJECT_FILE& project = m_project->GetProjectFile();
 
 delete project.m_ErcSettings;
 delete project.m_SchematicSettings;
 
 project.m_ErcSettings = nullptr;
 project.m_SchematicSettings = nullptr;
 
 m_project = nullptr; // clear the project, so we don't do this again when setting a new one
 }
 
 delete m_rootSheet;
 
 m_rootSheet = nullptr;
 
 m_connectionGraph->Reset();
 m_currentSheet->clear();
}

References SCH_SHEET_PATH::clear(), PROJECT::GetProjectFile(), m_connectionGraph, m_currentSheet, m_project, m_rootSheet, project, and CONNECTION_GRAPH::Reset().

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_FRAME::doCloseWindow(), KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::OpenProjectFiles(), KI_TEST::SCHEMATIC_TEST_FIXTURE::~SCHEMATIC_TEST_FIXTURE(), and TEST_NGSPICE_HELPERS::~TEST_NGSPICE_HELPERS().

◆ ResolveCrossReference()

bool SCHEMATIC::ResolveCrossReference	(	wxString *	token,
		int	aDepth
	)		const

Resolves text vars that refer to other items.

Note that the actual resolve is delegated to the symbol/sheet in question. This routine just does the look-up and delegation.

Definition at line 259 of file schematic.cpp.

{
 SCH_SHEET_LIST sheetList = GetSheets();
 wxString remainder;
 wxString ref = token->BeforeFirst( ':', &remainder );
 SCH_SHEET_PATH sheetPath;
 SCH_ITEM* refItem = sheetList.GetItem( KIID( ref ), &sheetPath );
 
 if( refItem && refItem->Type() == SCH_SYMBOL_T )
 {
 SCH_SYMBOL* refSymbol = static_cast<SCH_SYMBOL*>( refItem );
 
 if( refSymbol->ResolveTextVar( &remainder, aDepth + 1 ) )
 *token = remainder;
 else
 *token = refSymbol->GetRef( &sheetPath, true ) + ":" + remainder;
 
 return true; // Cross-reference is resolved whether or not the actual textvar was
 }
 else if( refItem && refItem->Type() == SCH_SHEET_T )
 {
 SCH_SHEET* refSheet = static_cast<SCH_SHEET*>( refItem );
 
 if( refSheet->ResolveTextVar( &remainder, aDepth + 1 ) )
 *token = remainder;
 
 return true; // Cross-reference is resolved whether or not the actual textvar was
 }
 
 return false;
}

References SCH_SHEET_LIST::GetItem(), SCH_SYMBOL::GetRef(), GetSheets(), SCH_SHEET::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_SHEET_T, SCH_SYMBOL_T, and EDA_ITEM::Type().

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

◆ ResolveERCExclusions()

std::vector< SCH_MARKER * > SCHEMATIC::ResolveERCExclusions ( )

Definition at line 186 of file schematic.cpp.

{
 SCH_SHEET_LIST sheetList = GetSheets();
 ERC_SETTINGS& settings = ErcSettings();
 
 for( const SCH_SHEET_PATH& sheet : sheetList )
 {
 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_MARKER_T ) )
 {
 SCH_MARKER* marker = static_cast<SCH_MARKER*>( item );
 auto it = settings.m_ErcExclusions.find( marker->Serialize() );
 
 if( it != settings.m_ErcExclusions.end() )
 {
 marker->SetExcluded( true );
 settings.m_ErcExclusions.erase( it );
 }
 }
 }
 
 std::vector<SCH_MARKER*> newMarkers;
 
 for( const wxString& exclusionData : settings.m_ErcExclusions )
 {
 SCH_MARKER* marker = SCH_MARKER::Deserialize( exclusionData );
 
 if( marker )
 {
 marker->SetExcluded( true );
 newMarkers.push_back( marker );
 }
 }
 
 settings.m_ErcExclusions.clear();
 
 return newMarkers;
}

References SCH_MARKER::Deserialize(), ErcSettings(), GetSheets(), ERC_SETTINGS::m_ErcExclusions, SCH_MARKER_T, SCH_MARKER::Serialize(), and MARKER_BASE::SetExcluded().

◆ ResolveTextVar()

bool SCHEMATIC::ResolveTextVar	(	wxString *	token,
		int	aDepth
	)		const

Definition at line 123 of file schematic.cpp.

{
 if( !CurrentSheet().empty() )
 {
 if( token->IsSameAs( wxT( "#" ) ) )
 {
 *token = CurrentSheet().GetPageNumber();
 return true;
 }
 else if( token->IsSameAs( wxT( "##" ) ) )
 {
 *token = wxString::Format( "%i", Root().CountSheets() );
 return true;
 }
 else if( token->IsSameAs( wxT( "SHEETPATH" ) ) )
 {
 *token = CurrentSheet().PathHumanReadable();
 return true;
 }
 else if( token->IsSameAs( wxT( "SHEETNAME" ) ) )
 {
 *token = CurrentSheet().Last()->GetName();
 return true;
 }
 else if( token->IsSameAs( wxT( "FILENAME" ) ) )
 {
 wxFileName fn( GetFileName() );
 *token = fn.GetFullName();
 return true;
 }
 else if( token->IsSameAs( wxT( "PROJECTNAME" ) ) )
 {
 *token = Prj().GetProjectName();
 return true;
 }
 
 return CurrentSheet().LastScreen()->GetTitleBlock().TextVarResolver( token, m_project );
 }
 
 return false;
}

References CurrentSheet(), empty(), Format(), GetFileName(), SCH_SHEET::GetName(), SCH_SHEET_PATH::GetPageNumber(), PROJECT::GetProjectName(), SCH_SCREEN::GetTitleBlock(), SCH_SHEET_PATH::Last(), SCH_SHEET_PATH::LastScreen(), m_project, SCH_SHEET_PATH::PathHumanReadable(), Prj(), Root(), and TITLE_BLOCK::TextVarResolver().

Referenced by DIALOG_PLOT_SCHEMATIC::getOutputPath(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), and SCH_TEXTBOX::GetShownText().

◆ Root()

SCH_SHEET & SCHEMATIC::Root ( ) const

inline

Definition at line 90 of file schematic.h.

 {
 return *m_rootSheet;
 }

References m_rootSheet.

Referenced by DIALOG_SYMBOL_REMAP::backupProject(), SCH_NAVIGATE_TOOL::CanGoUp(), SCH_SCREENS::ClearAnnotationOfNewSheetPaths(), DIALOG_PLOT_SCHEMATIC::createDXFFiles(), DIALOG_PLOT_SCHEMATIC::createHPGLFiles(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::createPSFiles(), SCH_EDIT_FRAME::CreateScreens(), DIALOG_PLOT_SCHEMATIC::createSVGFiles(), DIALOG_ERC::deleteAllMarkers(), SHEETLIST_ERC_ITEMS_PROVIDER::DeleteItem(), SCH_EDIT_FRAME::doAutoSave(), SCH_EDITOR_CONTROL::FindNext(), SCH_PRINTOUT::GetPageInfo(), HIERARCHY_NAVIG_PANEL::getRootString(), getSymbols(), SCH_PRINTOUT::HasPage(), SCH_EDIT_FRAME::importFile(), EE_SELECTION_TOOL::Init(), SCH_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_SHEET::IsRootSheet(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_SEXPR_PLUGIN::Load(), SCH_LEGACY_PLUGIN::Load(), KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), DIALOG_SCH_IMPORT_SETTINGS::OnBrowseClicked(), DIALOG_ERC::OnERCItemRClick(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), SCH_EDITOR_CONTROL::ReplaceAll(), SCH_EDITOR_CONTROL::rescueProject(), SCH_EDITOR_CONTROL::RescueSymbols(), ResolveTextVar(), SCH_EDITOR_CONTROL::Revert(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SetSheetNumberAndCount(), ERC_TESTER::TestConflictingBusAliases(), ERC_TESTER::TestDuplicateSheetNames(), DIALOG_ERC::testErc(), ERC_TESTER::TestLibSymbolIssues(), ERC_TESTER::TestOffGridEndpoints(), DIALOG_PRINT_USING_PRINTER::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_BUSES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), PANEL_SETUP_BUSES::TransferDataToWindow(), HIERARCHY_NAVIG_PANEL::UpdateHierarchyTree(), LEGACY_RESCUER::WriteRescueLibrary(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

◆ RootScreen()

SCH_SCREEN * SCHEMATIC::RootScreen ( ) const

Helper to retrieve the screen of the root sheet.

Definition at line 117 of file schematic.cpp.

{
 return IsValid() ? m_rootSheet->GetScreen() : nullptr;
}

References SCH_SHEET::GetScreen(), IsValid(), and m_rootSheet.

Referenced by SCH_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::CreateArchiveLibraryCacheFile(), SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_FRAME::doCloseWindow(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::ResolveERCExclusions(), SCH_EDIT_FRAME::SaveProject(), and SCH_EDIT_FRAME::SaveProjectSettings().

◆ Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 66 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 void* object = nullptr;
 
 if( prop )
 {
 object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
 if( object )
 prop->set<T>( object, aValue );
 }
 
 return object != nullptr;
 }

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 54 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( object )
 aProperty->set<T>( object, aValue );
 
 return object != nullptr;
 }

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( object )
 aProperty->setter( object, aValue );
 
 return object != nullptr;
 }

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

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

119{ SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:142

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetCurrentSheet()

void SCHEMATIC::SetCurrentSheet ( const SCH_SHEET_PATH & aPath )

inlineoverridevirtual

Implements SCHEMATIC_IFACE.

Definition at line 124 of file schematic.h.

 {
 *m_currentSheet = aPath;
 }

References m_currentSheet.

Referenced by SCH_EDITOR_CONTROL::FindNext(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), DIALOG_MIGRATE_BUSES::onItemSelected(), SCH_EDIT_FRAME::SetCurrentSheet(), EE_SELECTION_TOOL::SyncSelection(), and ERC_TESTER::TestTextVars().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 142 of file eda_item.h.

142{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

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

201{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 167 of file eda_item.h.

 {
 if( aBitmap )
 SetFlags( IS_SHOWN_AS_BITMAP );
 else
 ClearFlags( IS_SHOWN_AS_BITMAP );
 }

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

◆ SetLegacySymbolInstanceData()

void SCHEMATIC::SetLegacySymbolInstanceData ( )

Update the symbol value and footprint instance data for legacy designs.

Prior to schematic file format version 20200828 and legacy file format version, only symbol reference field and unit were saved in the instance data. The value and footprint fields must be carried forward from the original symbol to prevent data loss.

Definition at line 449 of file schematic.cpp.

{
 SCH_SCREENS screens( m_rootSheet );
 
 screens.SetLegacySymbolInstanceData();
}

References m_rootSheet, and SCH_SCREENS::SetLegacySymbolInstanceData().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 64 of file eda_item.cpp.

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

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

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

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and PCB_DIMENSION_BASE.

Definition at line 100 of file eda_item.h.

100{ m_parent = aParent; }

References EDA_ITEM::m_parent.

◆ SetPosition()

virtual void EDA_ITEM::SetPosition ( const VECTOR2I & aPos )

inlinevirtualinherited

Reimplemented in DELETED_SHEET_ITEM, DELETED_BOARD_ITEM, PCB_GROUP, PCB_VIA, LIB_PIN, SCH_SHAPE, GERBER_DRAW_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, BOARD, FOOTPRINT, FP_TEXT, NETINFO_ITEM, PAD, PCB_DIMENSION_BASE, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TRACK, PCB_ARC, ZONE, LIB_ITEM, LIB_SHAPE, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, KIGFX::ORIGIN_VIEWITEM, and PCB_BITMAP.

Definition at line 250 of file eda_item.h.

250{};

Referenced by BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), DRAWING_TOOL::DrawVia(), FOOTPRINT::GetFpPadsLocalBbox(), SCH_EAGLE_PLUGIN::moveLabels(), PL_DRAWING_TOOLS::PlaceItem(), PlotStandardLayer(), BOARD_ITEM::SetX(), BOARD_ITEM::SetY(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDIT_TOOL::Swap(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetProject()

void SCHEMATIC::SetProject ( PROJECT * aPrj )

Definition at line 76 of file schematic.cpp.

{
 if( m_project )
 {
 PROJECT_FILE& project = m_project->GetProjectFile();
 
 delete project.m_ErcSettings;
 delete project.m_SchematicSettings;
 
 project.m_ErcSettings = nullptr;
 project.m_SchematicSettings = nullptr;
 }
 
 m_project = aPrj;
 
 if( m_project )
 {
 PROJECT_FILE& project = m_project->GetProjectFile();
 project.m_ErcSettings = new ERC_SETTINGS( &project, "erc" );
 project.m_SchematicSettings = new SCHEMATIC_SETTINGS( &project, "schematic" );
 
 project.m_SchematicSettings->LoadFromFile();
 project.m_SchematicSettings->m_NgspiceSimulatorSettings->LoadFromFile();
 project.m_ErcSettings->LoadFromFile();
 }
}

References PROJECT::GetProjectFile(), m_project, and project.

Referenced by SCH_EDIT_FRAME::CreateScreens(), KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::OpenProjectFiles(), SCHEMATIC(), and TEST_NGSPICE_HELPERS::TEST_NGSPICE_HELPERS().

◆ SetRoot()

void SCHEMATIC::SetRoot ( SCH_SHEET * aRootSheet )

Initialize the schematic with a new root sheet.

This is typically done by calling a file loader that returns the new root sheet As a side-effect, takes care of some post-load initialization.

Parameters

aRootSheet is the new root sheet for this schematic.

Definition at line 104 of file schematic.cpp.

{
 wxCHECK_RET( aRootSheet, "Call to SetRoot with null SCH_SHEET!" );
 
 m_rootSheet = aRootSheet;
 
 m_currentSheet->clear();
 m_currentSheet->push_back( m_rootSheet );
 
 m_connectionGraph->Reset();
}

References SCH_SHEET_PATH::clear(), m_connectionGraph, m_currentSheet, m_rootSheet, SCH_SHEET_PATH::push_back(), and CONNECTION_GRAPH::Reset().

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_FRAME::importFile(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), and SCH_EDIT_FRAME::OpenProjectFiles().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

118{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetState()

void EDA_ITEM::SetState	(	EDA_ITEM_FLAGS	type,
		bool	state
	)

inlineinherited

Definition at line 131 of file eda_item.h.

 {
 if( state )
 m_status |= type; // state = ON or OFF
 else
 m_status &= ~type;
 }

References EDA_ITEM::m_status.

Referenced by LEGACY_PLUGIN::loadTrackList(), and TRACKS_CLEANER::mergeCollinearSegments().

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 140 of file eda_item.h.

140{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ Settings()

SCHEMATIC_SETTINGS & SCHEMATIC::Settings ( ) const

Definition at line 172 of file schematic.cpp.

{
 wxASSERT( m_project );
 return *m_project->GetProjectFile().m_SchematicSettings;
}

References PROJECT::GetProjectFile(), m_project, and PROJECT_FILE::m_SchematicSettings.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::CommonSettingsChanged(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), SCH_DRAWING_TOOLS::DrawShape(), SCH_JUNCTION::getEffectiveShape(), SCH_LABEL_BASE::GetLabelBoxExpansion(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_SHAPE::GetPenWidth(), SCH_SHEET::GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SCH_TEXT::GetTextOffset(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_ANNOTATE::InitValues(), NETLIST_DIALOG::InstallPageSpice(), NETLIST_DIALOG::InstallPageSpiceModel(), PANEL_EESCHEMA_ANNOTATION_OPTIONS::loadEEschemaSettings(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), SCH_EDIT_FRAME::LoadProjectSettings(), NETLIST_DIALOG::NETLIST_DIALOG(), NETLIST_DIALOG::NetlistUpdateOpt(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), NETLIST_DIALOG::OnRunExternSpiceCommand(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceSymbol(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_EDIT_FRAME::RecomputeIntersheetRefs(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataToWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), and DIALOG_ANNOTATE::~DIALOG_ANNOTATE().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 117 of file eda_item.h.

117{ SetFlags( IS_WIRE_IMAGE ); }

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

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

438{ return *aLeft < *aRight; }

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

97{ return m_structType; }

References EDA_ITEM::m_structType.

◆ 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, FP_TEXT, PAD, PCB_DIMENSION_BASE, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TRACK, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, and MY_DRAWING.

Definition at line 254 of file eda_item.cpp.

{
 // Basic fallback
 return GetBoundingBox();
}

References EDA_ITEM::GetBoundingBox().

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), EDIT_TOOL::Rotate(), PCB_DIMENSION_BASE::ViewBBox(), 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 106 of file view_item.h.

107 {}

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

◆ ViewGetLayers()

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

overridevirtualinherited

Return the all the layers within the VIEW the object is painted on.

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

Parameters

aLayers[]	is the output layer index array.
aCount	is the number of layer indices in aLayers[].

Implements KIGFX::VIEW_ITEM.

Reimplemented in LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_SYMBOL, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_ITEM, SCH_JUNCTION, SCH_LABEL_BASE, SCH_GLOBALLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, GERBER_DRAW_ITEM, BOARD_ITEM, DS_DRAW_ITEM_BASE, DS_PROXY_VIEW_ITEM, KIGFX::ORIGIN_VIEWITEM, PCB_GROUP, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, EDIT_POINTS, FOOTPRINT, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_MARKER, PCB_TRACK, PCB_VIA, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, ZONE, and MY_DRAWING.

Definition at line 261 of file eda_item.cpp.

{
 // Basic fallback
 aCount = 1;
 aLayers[0] = 0;
}

◆ 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 GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, ZONE, and FP_ZONE.

Definition at line 132 of file view_item.h.

 {
 // By default always show the item
 return 0.0;
 }

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

◆ Visit()

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

virtualinherited

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 in PCB_GROUP, LIB_SYMBOL, SCH_SHEET, SCH_SYMBOL, GBR_LAYOUT, GERBER_DRAW_ITEM, GERBER_FILE_IMAGE, FOOTPRINT, PCB_TRACK, SCH_LABEL_BASE, and BOARD.

Definition at line 91 of file eda_item.cpp.

{
#if 0 && defined(DEBUG)
 std::cout << GetClass().mb_str() << ' ';
#endif
 
 if( IsType( aScanTypes ) )
 {
 if( INSPECT_RESULT::QUIT == inspector( this, testData ) )
 return INSPECT_RESULT::QUIT;
 }
 
 return INSPECT_RESULT::CONTINUE;
}

References CONTINUE, EDA_ITEM::GetClass(), EDA_ITEM::IsType(), and QUIT.

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

Friends And Related Function Documentation

◆ SCH_EDIT_FRAME

friend class SCH_EDIT_FRAME

friend

Definition at line 187 of file schematic.h.

Member Data Documentation

◆ m_connectionGraph

CONNECTION_GRAPH* SCHEMATIC::m_connectionGraph

private

Holds and calculates connectivity information of this schematic.

Definition at line 203 of file schematic.h.

Referenced by ConnectionGraph(), GetNetClassAssignmentCandidates(), Reset(), SCHEMATIC(), SetRoot(), and ~SCHEMATIC().

◆ m_currentSheet

SCH_SHEET_PATH* SCHEMATIC::m_currentSheet

private

The sheet path of the sheet currently being edited or displayed.

Note that this was moved here from SCH_EDIT_FRAME because currently many places in the code want to know the current sheet. Potentially this can be moved back to the UI code once the only places that want to know it are UI-related

Definition at line 200 of file schematic.h.

Referenced by CurrentSheet(), Reset(), SCHEMATIC(), SetCurrentSheet(), SetRoot(), and ~SCHEMATIC().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 498 of file eda_item.h.

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

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 497 of file eda_item.h.

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

◆ m_labelToPageRefsMap

std::map<wxString, std::set<int> > SCHEMATIC::m_labelToPageRefsMap

private

Holds a map of labels to the page sequence (virtual page number) that they appear on.

It is used for updating global label intersheet references.

Definition at line 209 of file schematic.h.

Referenced by GetPageRefsMap().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 496 of file eda_item.h.

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

◆ m_project

PROJECT* SCHEMATIC::m_project

private

Definition at line 189 of file schematic.h.

Referenced by ErcSettings(), Prj(), Reset(), ResolveTextVar(), SetProject(), and Settings().

◆ m_properties

std::map<wxString, wxString> SCHEMATIC::m_properties

private

Properties for text variable substitution (and perhaps other uses in future).

Definition at line 214 of file schematic.h.

Referenced by GetProperties().

◆ m_rootSheet

SCH_SHEET* SCHEMATIC::m_rootSheet

private

The top-level sheet in this schematic hierarchy (or potentially the only one)

Definition at line 192 of file schematic.h.

Referenced by GetFileName(), GetFullHierarchy(), GetSheets(), IsValid(), Reset(), Root(), RootScreen(), SetLegacySymbolInstanceData(), and SetRoot().

◆ m_status

EDA_ITEM_FLAGS EDA_ITEM::m_status

protectedinherited

Definition at line 495 of file eda_item.h.

Referenced by EDA_ITEM::GetState(), EDA_ITEM::GetStatus(), EDA_ITEM::operator=(), EDA_ITEM::SetState(), EDA_ITEM::SetStatus(), and PCB_SHAPE::SwapData().

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

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

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 492 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 151 of file view_item.h.

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

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 Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SCHEMATIC()

◆ ~SCHEMATIC()

Member Function Documentation

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ ConnectionGraph()

◆ ConvertKIIDsToRefs()

◆ ConvertRefsToKIIDs()

◆ CurrentSheet()

◆ ErcSettings()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBoundingBox()

◆ GetBusAlias()

◆ GetClass()

◆ GetEditFlags()

◆ GetFileName()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFullHierarchy()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetNetClassAssignmentCandidates()

◆ GetPageRefsMap()

◆ GetParent()

◆ GetPosition()

◆ GetProperties()

◆ GetSelectMenuText()

◆ GetSheets()

◆ GetSortPosition()

◆ GetState()

◆ GetStatus()

◆ GetTypeDesc()

◆ GetVirtualPageToSheetNamesMap()

◆ GetVirtualPageToSheetPagesMap()

◆ HasFlag()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ IsBrightened()

◆ IsDragging()

◆ IsEntered()

◆ IsForceVisible()

◆ IsModified()

◆ IsMoving()

◆ IsNew()

◆ IsReplaceable()

◆ IsResized()

◆ IsRollover()

◆ IsSelected()

◆ IsShownAsBitmap()

◆ IsType()

◆ IsValid()

◆ IsWireImage()

◆ IterateForward() [1/2]

◆ IterateForward() [2/2]

◆ Matches() [1/2]

◆ Matches() [2/2]

◆ operator<()

◆ Prj()

◆ RenderAsBitmap()

◆ Replace() [1/2]

◆ Replace() [2/2]

◆ Reset()

◆ ResolveCrossReference()

◆ ResolveERCExclusions()