#include <cadstar_pcb_archive_parser.h>
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 | |
| SYMDEF_TYPE | Type = SYMDEF_TYPE::COMPONENT |
| long | SymHeight = 0 |
| The Height of the component (3D height in z direction) | |
| std::vector< COMPONENT_COPPER > | ComponentCoppers |
| std::map< COMP_AREA_ID, COMPONENT_AREA > | ComponentAreas |
| std::map< PAD_ID, COMPONENT_PAD > | ComponentPads |
| std::map< DIMENSION_ID, DIMENSION > | Dimensions |
| inside "DIMENSIONS" subnode | |
| 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 785 of file cadstar_pcb_archive_parser.h.
Member Function Documentation
◆ BuildLibName()
|
inherited |
Definition at line 1732 of file cadstar_archive_parser.cpp.
References Alternate, CADSTAR_ARCHIVE_PARSER::generateLibName(), and ReferenceName.
Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadComponentLibrary(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef().
◆ Parse()
|
overridevirtual |
Implements CADSTAR_ARCHIVE_PARSER::PARSER.
Definition at line 1569 of file cadstar_pcb_archive_parser.cpp.
References CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT, ComponentAreas, ComponentCoppers, ComponentPads, Dimensions, XNODE::GetChildren(), XNODE::GetNext(), CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDLong(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_AREA::ID, CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::ID, CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::IsDimension(), CADSTAR_PCB_ARCHIVE_PARSER::JUMPER, CADSTAR_ARCHIVE_PARSER::SYMDEF::Origin, pad, CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_AREA::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_COPPER::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::Parse(), CADSTAR_ARCHIVE_PARSER::SYMDEF::ParseIdentifiers(), CADSTAR_ARCHIVE_PARSER::SYMDEF::ParseSubNode(), CADSTAR_ARCHIVE_PARSER::SYMDEF::ReferenceName, CADSTAR_PCB_ARCHIVE_PARSER::STARPOINT, CADSTAR_ARCHIVE_PARSER::SYMDEF::Stub, SymHeight, CADSTAR_PCB_ARCHIVE_PARSER::TESTPOINT, THROW_MISSING_PARAMETER_IO_ERROR, Type, CADSTAR_ARCHIVE_PARSER::UNDEFINED_VALUE, and WARN_UNKNOWN_NODE_IO_ERROR.
Referenced by CADSTAR_PCB_ARCHIVE_PARSER::LIBRARY::Parse().
◆ ParseIdentifiers()
|
inherited |
Definition at line 1738 of file cadstar_archive_parser.cpp.
References Alternate, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), ID, and ReferenceName.
Referenced by CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::Parse(), and CADSTAR_SCH_ARCHIVE_PARSER::SYMDEF_SCM::Parse().
◆ ParseSubNode()
|
inherited |
Definition at line 1748 of file cadstar_archive_parser.cpp.
References CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::AttributeID, CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::AttributeID, AttributeValues, Figures, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDLong(), CADSTAR_ARCHIVE_PARSER::FIGURE::ID, CADSTAR_ARCHIVE_PARSER::TEXT::ID, Origin, CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::Parse(), CADSTAR_ARCHIVE_PARSER::FIGURE::Parse(), CADSTAR_ARCHIVE_PARSER::TEXT::Parse(), CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::Parse(), Stub, TextLocations, Texts, and Version.
Referenced by CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::Parse(), and CADSTAR_SCH_ARCHIVE_PARSER::SYMDEF_SCM::Parse().
Member Data Documentation
◆ Alternate
|
inherited |
This is in addition to ReferenceName.
It allows defining different versions, views etc. of the same basic symbol.
Definition at line 951 of file cadstar_archive_parser.h.
Referenced by BuildLibName(), CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryFigures(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), and ParseIdentifiers().
◆ AttributeValues
|
inherited |
These attributes might also have a location.
Definition at line 969 of file cadstar_archive_parser.h.
Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), and ParseSubNode().
◆ ComponentAreas
| std::map<COMP_AREA_ID, COMPONENT_AREA> CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::ComponentAreas |
Definition at line 791 of file cadstar_pcb_archive_parser.h.
Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas(), and Parse().
◆ ComponentCoppers
| std::vector<COMPONENT_COPPER> CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::ComponentCoppers |
Definition at line 790 of file cadstar_pcb_archive_parser.h.
Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), and Parse().
◆ ComponentPads
| std::map<PAD_ID, COMPONENT_PAD> CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::ComponentPads |
Definition at line 792 of file cadstar_pcb_archive_parser.h.
Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryPads(), and Parse().
◆ Dimensions
| std::map<DIMENSION_ID, DIMENSION> CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::Dimensions |
inside "DIMENSIONS" subnode
Definition at line 793 of file cadstar_pcb_archive_parser.h.
Referenced by Parse().
◆ Figures
Definition at line 964 of file cadstar_archive_parser.h.
Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadComponentLibrary(), CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryFigures(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), and ParseSubNode().
◆ ID
|
inherited |
Definition at line 948 of file cadstar_archive_parser.h.
Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), CADSTAR_PCB_ARCHIVE_PARSER::LIBRARY::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::LIBRARY_SCM::Parse(), and ParseIdentifiers().
◆ Origin
|
inherited |
Origin of the component (this is used as the reference point when placing the component in the design)
Definition at line 953 of file cadstar_archive_parser.h.
Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadComponentLibrary(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMDEF_SCM::Parse(), and ParseSubNode().
◆ ReferenceName
|
inherited |
This is the name which identifies the symbol in the library Multiple components may exist with the same ReferenceName.
Definition at line 949 of file cadstar_archive_parser.h.
Referenced by BuildLibName(), CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryFigures(), CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::Parse(), and ParseIdentifiers().
◆ Stub
|
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 955 of file cadstar_archive_parser.h.
Referenced by CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMDEF_SCM::Parse(), and ParseSubNode().
◆ SymHeight
| long CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::SymHeight = 0 |
The Height of the component (3D height in z direction)
Definition at line 788 of file cadstar_pcb_archive_parser.h.
Referenced by Parse().
◆ TextLocations
|
inherited |
This contains location of any attributes, including designator position.
Definition at line 966 of file cadstar_archive_parser.h.
Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), and ParseSubNode().
◆ Texts
◆ Type
| SYMDEF_TYPE CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::Type = SYMDEF_TYPE::COMPONENT |
Definition at line 787 of file cadstar_pcb_archive_parser.h.
Referenced by Parse().
◆ Version
|
inherited |
Version is a sequential integer number to identify discrepancies between the library and the design.
Definition at line 961 of file cadstar_archive_parser.h.
Referenced by ParseSubNode().
The documentation for this struct was generated from the following files:
