Variant information for a schematic sheet. More...
#include <sch_sheet_path.h>
Public Member Functions | |
| SCH_SHEET_VARIANT (const wxString &aName=wxEmptyString) | |
| virtual | ~SCH_SHEET_VARIANT ()=default |
| void | InitializeAttributes (const SCH_SHEET &aSheet) |
Public Attributes | |
| wxString | m_Name |
| wxString | m_Description |
| bool | m_ExcludedFromSim |
| bool | m_ExcludedFromBOM |
| bool | m_ExcludedFromBoard |
| bool | m_ExcludedFromPosFiles |
| bool | m_DNP |
| std::map< wxString, wxString > | m_Fields |
Detailed Description
Variant information for a schematic sheet.
Schematic sheet variants are a set of field and/or properties differentials against the default sheet values. Each sheet instance may contain 0 or more variants.
- Note
- The exceptions to this are the SHEET_NAME and SHEET_FILENAME fields and the #SCH_SHEET::m_excludeFromBoard property. Changing any of these would effectively be a new board. They are immutable and will always be the sheet default value.
Definition at line 134 of file sch_sheet_path.h.
Constructor & Destructor Documentation
◆ SCH_SHEET_VARIANT()
|
inline |
Definition at line 137 of file sch_sheet_path.h.
References VARIANT::VARIANT().
◆ ~SCH_SHEET_VARIANT()
|
virtualdefault |
Member Function Documentation
◆ InitializeAttributes()
| void SCH_SHEET_VARIANT::InitializeAttributes | ( | const SCH_SHEET & | aSheet | ) |
Definition at line 108 of file sch_sheet_path.cpp.
References SCH_SHEET::GetDNP(), SCH_SHEET::GetExcludedFromBoard(), SCH_SHEET::GetExcludedFromBOM(), SCH_SHEET::GetExcludedFromSim(), VARIANT::m_DNP, VARIANT::m_ExcludedFromBoard, VARIANT::m_ExcludedFromBOM, VARIANT::m_ExcludedFromPosFiles, and VARIANT::m_ExcludedFromSim.
Referenced by SCH_SHEET::SetDNP(), SCH_SHEET::SetExcludedFromBOM(), SCH_SHEET::SetExcludedFromSim(), and SCH_SHEET::SetFieldText().
Member Data Documentation
◆ m_Description
|
inherited |
Definition at line 63 of file sch_sheet_path.h.
◆ m_DNP
|
inherited |
Definition at line 68 of file sch_sheet_path.h.
Referenced by SCH_SHEET_VARIANT::InitializeAttributes(), SCH_SYMBOL_VARIANT::InitializeAttributes(), SCH_IO_KICAD_SEXPR_PARSER::parseSchematicSymbol(), SCH_IO_KICAD_SEXPR_PARSER::parseSheet(), SCH_SHEET::SetDNP(), SCH_SYMBOL::SetDNP(), and VARIANT().
◆ m_ExcludedFromBoard
|
inherited |
Definition at line 66 of file sch_sheet_path.h.
Referenced by SCH_SHEET_VARIANT::InitializeAttributes(), SCH_SYMBOL_VARIANT::InitializeAttributes(), SCH_IO_KICAD_SEXPR_PARSER::parseSchematicSymbol(), SCH_IO_KICAD_SEXPR_PARSER::parseSheet(), SCH_SYMBOL::SetExcludedFromBoard(), and VARIANT().
◆ m_ExcludedFromBOM
|
inherited |
Definition at line 65 of file sch_sheet_path.h.
Referenced by SCH_SHEET_VARIANT::InitializeAttributes(), SCH_SYMBOL_VARIANT::InitializeAttributes(), SCH_IO_KICAD_SEXPR_PARSER::parseSchematicSymbol(), SCH_IO_KICAD_SEXPR_PARSER::parseSheet(), SCH_SHEET::SetExcludedFromBOM(), SCH_SYMBOL::SetExcludedFromBOM(), and VARIANT().
◆ m_ExcludedFromPosFiles
|
inherited |
Definition at line 67 of file sch_sheet_path.h.
Referenced by SCH_SHEET_VARIANT::InitializeAttributes(), SCH_SYMBOL_VARIANT::InitializeAttributes(), SCH_IO_KICAD_SEXPR_PARSER::parseSchematicSymbol(), SCH_IO_KICAD_SEXPR_PARSER::parseSheet(), SCH_SYMBOL::SetExcludedFromPosFiles(), and VARIANT().
◆ m_ExcludedFromSim
|
inherited |
Definition at line 64 of file sch_sheet_path.h.
Referenced by SCH_SHEET_VARIANT::InitializeAttributes(), SCH_SYMBOL_VARIANT::InitializeAttributes(), SCH_IO_KICAD_SEXPR_PARSER::parseSchematicSymbol(), SCH_IO_KICAD_SEXPR_PARSER::parseSheet(), SCH_SHEET::SetExcludedFromSim(), SCH_SYMBOL::SetExcludedFromSim(), and VARIANT().
◆ m_Fields
|
inherited |
Definition at line 69 of file sch_sheet_path.h.
Referenced by SCH_IO_KICAD_SEXPR_PARSER::parseSchematicSymbol(), SCH_IO_KICAD_SEXPR_PARSER::parseSheet(), SCH_SHEET::SetFieldText(), SCH_SYMBOL::SetFieldText(), and SCH_SYMBOL::SetValueFieldText().
◆ m_Name
|
inherited |
Definition at line 62 of file sch_sheet_path.h.
Referenced by SCH_SHEET::AddVariant(), SCH_SYMBOL::AddVariant(), SCH_SHEET::CopyVariant(), SCH_SYMBOL::CopyVariant(), SCH_IO_KICAD_SEXPR_PARSER::parseSchematicSymbol(), SCH_IO_KICAD_SEXPR_PARSER::parseSheet(), SCH_SHEET::RenameVariant(), SCH_SYMBOL::RenameVariant(), and VARIANT().
The documentation for this class was generated from the following files:
