Variant information for a schematic symbol. More...
#include <sch_sheet_path.h>
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()
|
inline |
Definition at line 81 of file sch_sheet_path.h.
References VARIANT::VARIANT().
◆ ~SCH_SYMBOL_VARIANT()
|
virtualdefault |
Member Function Documentation
◆ InitializeAttributes()
| void SCH_SYMBOL_VARIANT::InitializeAttributes | ( | const SCH_SYMBOL & | aSymbol | ) |
Definition at line 98 of file sch_sheet_path.cpp.
References SCH_SYMBOL::GetDNP(), SCH_SYMBOL::GetExcludedFromBOM(), SCH_SYMBOL::GetExcludedFromSim(), VARIANT::m_DNP, VARIANT::m_ExcludedFromBOM, and VARIANT::m_ExcludedFromSim.
Referenced by SCH_SYMBOL::SetDNP(), SCH_SYMBOL::SetExcludedFromBOM(), and SCH_SYMBOL::SetExcludedFromSim().
Member Data Documentation
◆ m_DNP
|
inherited |
Definition at line 63 of file sch_sheet_path.h.
Referenced by SCH_SYMBOL_VARIANT::InitializeAttributes(), SCH_IO_KICAD_SEXPR_PARSER::parseSchematicSymbol(), SCH_IO_KICAD_SEXPR_PARSER::parseSheet(), SCH_SYMBOL::SetDNP(), and VARIANT().
◆ m_ExcludedFromBOM
|
inherited |
Definition at line 62 of file sch_sheet_path.h.
Referenced by SCH_SYMBOL_VARIANT::InitializeAttributes(), SCH_IO_KICAD_SEXPR_PARSER::parseSchematicSymbol(), SCH_IO_KICAD_SEXPR_PARSER::parseSheet(), SCH_SYMBOL::SetExcludedFromBOM(), and VARIANT().
◆ m_ExcludedFromSim
|
inherited |
Definition at line 61 of file sch_sheet_path.h.
Referenced by SCH_SYMBOL_VARIANT::InitializeAttributes(), SCH_IO_KICAD_SEXPR_PARSER::parseSchematicSymbol(), SCH_IO_KICAD_SEXPR_PARSER::parseSheet(), SCH_SYMBOL::SetExcludedFromSim(), and VARIANT().
◆ m_Fields
|
inherited |
Definition at line 64 of file sch_sheet_path.h.
Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_IO_KICAD_SEXPR_PARSER::parseSchematicSymbol(), and SCH_IO_KICAD_SEXPR_PARSER::parseSheet().
◆ m_Name
|
inherited |
Definition at line 60 of file sch_sheet_path.h.
Referenced by SCH_SYMBOL::AddVariant(), SCH_IO_KICAD_SEXPR_PARSER::parseSchematicSymbol(), SCH_IO_KICAD_SEXPR_PARSER::parseSheet(), and VARIANT().
The documentation for this class was generated from the following files:
