KiCad PCB EDA Suite
Loading...
Searching...
No Matches
CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB Struct Reference

#include <cadstar_pcb_archive_parser.h>

Inheritance diagram for CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB:
CADSTAR_ARCHIVE_PARSER::SYMDEF CADSTAR_ARCHIVE_PARSER::PARSER

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_COPPERComponentCoppers
 
std::map< COMP_AREA_ID, COMPONENT_AREAComponentAreas
 
std::map< PAD_ID, COMPONENT_PADComponentPads
 
std::map< DIMENSION_ID, DIMENSIONDimensions
 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, FIGUREFigures
 
std::map< TEXT_ID, TEXTTexts
 
std::map< ATTRIBUTE_ID, TEXT_LOCATIONTextLocations
 This contains location of any attributes, including designator position.
 
std::map< ATTRIBUTE_ID, ATTRIBUTE_VALUEAttributeValues
 These attributes might also have a location.
 

Detailed Description

Definition at line 782 of file cadstar_pcb_archive_parser.h.

Member Function Documentation

◆ BuildLibName()

wxString CADSTAR_ARCHIVE_PARSER::SYMDEF::BuildLibName ( ) const
inherited

◆ Parse()

◆ ParseIdentifiers()

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

◆ ParseSubNode()

Member Data Documentation

◆ Alternate

wxString CADSTAR_ARCHIVE_PARSER::SYMDEF::Alternate
inherited

◆ 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().

◆ ComponentAreas

std::map<COMP_AREA_ID, COMPONENT_AREA> CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::ComponentAreas

◆ ComponentCoppers

std::vector<COMPONENT_COPPER> CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::ComponentCoppers

◆ ComponentPads

◆ Dimensions

std::map<DIMENSION_ID, DIMENSION> CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::Dimensions

inside "DIMENSIONS" subnode

Definition at line 790 of file cadstar_pcb_archive_parser.h.

◆ Figures

◆ ID

◆ Origin

◆ 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.

◆ SymHeight

long CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::SymHeight = 0

The Height of the component (3D height in z direction)

Definition at line 785 of file cadstar_pcb_archive_parser.h.

◆ 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

◆ Type

SYMDEF_TYPE CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::Type = SYMDEF_TYPE::COMPONENT

Definition at line 784 of file cadstar_pcb_archive_parser.h.

◆ 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: