#include <cadstar_sch_archive_parser.h>

Inheritance diagram for CADSTAR_SCH_ARCHIVE_PARSER::SYMDEF_SCM:

Public Member Functions
void	Parse (XNODE aNode, PARSER_CONTEXT aContext) override

wxString	BuildLibName () const

void	ParseIdentifiers (XNODE aNode, PARSER_CONTEXT aContext)

bool	ParseSubNode (XNODE aChildNode, PARSER_CONTEXT aContext)

Public Attributes
std::map< TERMINAL_ID, TERMINAL >	Terminals

std::map< TERMINAL_ID, PIN_NUM_LABEL_LOC >	PinLabelLocations

std::map< TERMINAL_ID, PIN_NUM_LABEL_LOC >	PinNumberLocations

SYMDEF_ID	ID

wxString	ReferenceName
	This is the name which identifies the symbol in the library Multiple components may exist with the same ReferenceName.

wxString	Alternate
	This is in addition to ReferenceName.

POINT	Origin
	Origin of the component (this is used as the reference point when placing the component in the design)

bool	Stub = false
	When the CADSTAR Archive file is exported without the component library, if components on the board are still exported, the Reference and Alternate names will still be exported but the content is replaced with a "STUB" atom, requiring access to the original library for component definition.

long	Version = UNDEFINED_VALUE
	Version is a sequential integer number to identify discrepancies between the library and the design.

std::map< FIGURE_ID, FIGURE >	Figures

std::map< TEXT_ID, TEXT >	Texts

std::map< ATTRIBUTE_ID, TEXT_LOCATION >	TextLocations
	This contains location of any attributes, including designator position.

std::map< ATTRIBUTE_ID, ATTRIBUTE_VALUE >	AttributeValues
	These attributes might also have a location.

Detailed Description

Definition at line 159 of file cadstar_sch_archive_parser.h.

Member Function Documentation

◆ BuildLibName()

wxString CADSTAR_ARCHIVE_PARSER::SYMDEF::BuildLibName ( ) const

inherited

Definition at line 1707 of file cadstar_archive_parser.cpp.

References CADSTAR_ARCHIVE_PARSER::generateLibName().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadComponentLibrary(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef().

◆ Parse()

void CADSTAR_SCH_ARCHIVE_PARSER::SYMDEF_SCM::Parse	(	XNODE *	aNode,
		PARSER_CONTEXT *	aContext
	)

overridevirtual

Implements CADSTAR_ARCHIVE_PARSER::PARSER.

Definition at line 399 of file cadstar_sch_archive_parser.cpp.

References XNODE::GetChildren(), XNODE::GetNext(), CADSTAR_SCH_ARCHIVE_PARSER::TERMINAL::ID, CADSTAR_SCH_ARCHIVE_PARSER::TERMINAL::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::PIN_NUM_LABEL_LOC::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::PIN_NUM_LABEL_LOC::TerminalID, THROW_MISSING_PARAMETER_IO_ERROR, THROW_UNKNOWN_NODE_IO_ERROR, and CADSTAR_ARCHIVE_PARSER::UNDEFINED_VALUE.

Referenced by CADSTAR_SCH_ARCHIVE_PARSER::LIBRARY_SCM::Parse().

◆ ParseIdentifiers()

void CADSTAR_ARCHIVE_PARSER::SYMDEF::ParseIdentifiers	(	XNODE *	aNode,
		PARSER_CONTEXT *	aContext
	)

inherited

Definition at line 1713 of file cadstar_archive_parser.cpp.

References CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), and ID.

◆ ParseSubNode()

bool CADSTAR_ARCHIVE_PARSER::SYMDEF::ParseSubNode	(	XNODE *	aChildNode,
		PARSER_CONTEXT *	aContext
	)

inherited

Definition at line 1723 of file cadstar_archive_parser.cpp.

References CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::AttributeID, CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::AttributeID, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDLong(), CADSTAR_ARCHIVE_PARSER::FIGURE::ID, CADSTAR_ARCHIVE_PARSER::TEXT::ID, CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::Parse(), CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::Parse(), CADSTAR_ARCHIVE_PARSER::FIGURE::Parse(), and CADSTAR_ARCHIVE_PARSER::TEXT::Parse().

Member Data Documentation

◆ Alternate

wxString CADSTAR_ARCHIVE_PARSER::SYMDEF::Alternate

inherited

This is in addition to ReferenceName.

It allows defining different versions, views etc. of the same basic symbol.

Definition at line 947 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryFigures(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances().

◆ AttributeValues

std::map<ATTRIBUTE_ID, ATTRIBUTE_VALUE> CADSTAR_ARCHIVE_PARSER::SYMDEF::AttributeValues

inherited

These attributes might also have a location.

Definition at line 965 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef().

◆ Figures

std::map<FIGURE_ID, FIGURE> CADSTAR_ARCHIVE_PARSER::SYMDEF::Figures

inherited

Definition at line 960 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadComponentLibrary(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryFigures(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef().

◆ ID

SYMDEF_ID CADSTAR_ARCHIVE_PARSER::SYMDEF::ID

inherited

Definition at line 944 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), CADSTAR_SCH_ARCHIVE_PARSER::LIBRARY_SCM::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::LIBRARY::Parse().

◆ Origin

POINT CADSTAR_ARCHIVE_PARSER::SYMDEF::Origin

inherited

Origin of the component (this is used as the reference point when placing the component in the design)

Definition at line 949 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadComponentLibrary(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef().

◆ PinLabelLocations

std::map<TERMINAL_ID, PIN_NUM_LABEL_LOC> CADSTAR_SCH_ARCHIVE_PARSER::SYMDEF_SCM::PinLabelLocations

Definition at line 162 of file cadstar_sch_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef().

◆ PinNumberLocations

std::map<TERMINAL_ID, PIN_NUM_LABEL_LOC> CADSTAR_SCH_ARCHIVE_PARSER::SYMDEF_SCM::PinNumberLocations

Definition at line 163 of file cadstar_sch_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef().

◆ ReferenceName

wxString CADSTAR_ARCHIVE_PARSER::SYMDEF::ReferenceName

inherited

This is the name which identifies the symbol in the library Multiple components may exist with the same ReferenceName.

Definition at line 945 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), and CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryFigures().

◆ Stub

bool CADSTAR_ARCHIVE_PARSER::SYMDEF::Stub = false

inherited

When the CADSTAR Archive file is exported without the component library, if components on the board are still exported, the Reference and Alternate names will still be exported but the content is replaced with a "STUB" atom, requiring access to the original library for component definition.

Definition at line 951 of file cadstar_archive_parser.h.

◆ Terminals

std::map<TERMINAL_ID, TERMINAL> CADSTAR_SCH_ARCHIVE_PARSER::SYMDEF_SCM::Terminals

Definition at line 161 of file cadstar_sch_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef().

◆ TextLocations

std::map<ATTRIBUTE_ID, TEXT_LOCATION> CADSTAR_ARCHIVE_PARSER::SYMDEF::TextLocations

inherited

This contains location of any attributes, including designator position.

Definition at line 962 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef().

◆ Texts

std::map<TEXT_ID, TEXT> CADSTAR_ARCHIVE_PARSER::SYMDEF::Texts

inherited

Definition at line 961 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadComponentLibrary(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef().

◆ Version

long CADSTAR_ARCHIVE_PARSER::SYMDEF::Version = UNDEFINED_VALUE

inherited

Version is a sequential integer number to identify discrepancies between the library and the design.

Definition at line 957 of file cadstar_archive_parser.h.

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

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ BuildLibName()

◆ Parse()

◆ ParseIdentifiers()

◆ ParseSubNode()

Member Data Documentation

◆ Alternate

◆ AttributeValues

◆ Figures

◆ ID

◆ Origin

◆ PinLabelLocations

◆ PinNumberLocations

◆ ReferenceName

◆ Stub

◆ Terminals

◆ TextLocations

◆ Texts

◆ Version