SCH_SHEET_VARIANT Class Reference

Variant information for a schematic sheet. More...

#include <sch_sheet_path.h>

Inheritance diagram for SCH_SHEET_VARIANT:

Public Member Functions
	SCH_SHEET_VARIANT ()
virtual	~SCH_SHEET_VARIANT ()=default
void	InitializeAttributes (const SCH_SHEET &aSymbol)

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 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 129 of file sch_sheet_path.h.

Constructor & Destructor Documentation

SCH_SHEET_VARIANT()

SCH_SHEET_VARIANT::SCH_SHEET_VARIANT ( )

inline

Definition at line 132 of file sch_sheet_path.h.

References VARIANT::VARIANT().

~SCH_SHEET_VARIANT()

virtual SCH_SHEET_VARIANT::~SCH_SHEET_VARIANT ( )

virtualdefault

Member Function Documentation

InitializeAttributes()

void SCH_SHEET_VARIANT::InitializeAttributes

(

const SCH_SHEET &

aSymbol

)

Member Data Documentation

m_DNP

bool VARIANT::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

bool 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

bool 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

std::map<wxString, wxString> 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

wxString VARIANT::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 file:

• sch_sheet_path.h