KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SCH_SYMBOL_VARIANT Class Reference

Variant information for a schematic symbol. More...

#include <sch_sheet_path.h>

Inheritance diagram for SCH_SYMBOL_VARIANT:
VARIANT

Public Member Functions

 SCH_SYMBOL_VARIANT (const wxString &aName=wxEmptyString)
 
void InitializeAttributes (const SCH_SYMBOL &aSymbol)
 
virtual ~SCH_SYMBOL_VARIANT ()=default
 

Public Attributes

wxString m_Name
 
bool m_ExcludedFromSim
 
bool m_ExcludedFromBOM
 
bool m_DNP
 
std::map< wxString, wxString > m_Fields
 

Detailed Description

Variant information for a schematic symbol.

Schematic symbol variants are a set of field and/or properties differentials against the default symbol values. Each symbol instance may contain 0 or more variants.

Note
The two exceptions to this are the REFERENCE field and the #SYMBOL::m_excludeFromBoard property. Changing either of these would effectively be a new board. They are immutable and will always be the symbol default value.

Definition at line 78 of file sch_sheet_path.h.

Constructor & Destructor Documentation

◆ SCH_SYMBOL_VARIANT()

SCH_SYMBOL_VARIANT::SCH_SYMBOL_VARIANT ( const wxString & aName = wxEmptyString)
inline

Definition at line 81 of file sch_sheet_path.h.

References VARIANT::VARIANT().

◆ ~SCH_SYMBOL_VARIANT()

virtual SCH_SYMBOL_VARIANT::~SCH_SYMBOL_VARIANT ( )
virtualdefault

Member Function Documentation

◆ InitializeAttributes()

Member Data Documentation

◆ m_DNP

◆ m_ExcludedFromBOM

◆ m_ExcludedFromSim

◆ m_Fields

std::map<wxString, wxString> VARIANT::m_Fields
inherited

◆ m_Name


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