#include <cadstar_pcb_archive_parser.h>

Inheritance diagram for CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB:

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

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) More...

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

SYMDEF_ID	ID

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

wxString	Alternate
	This is in addition to ReferenceName. More...

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

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

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

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

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

Detailed Description

Definition at line 774 of file cadstar_pcb_archive_parser.h.

Member Function Documentation

◆ Parse()

void CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::Parse	(	XNODE *	aNode,
		PARSER_CONTEXT *	aContext
	)

overridevirtual

Implements CADSTAR_ARCHIVE_PARSER::PARSER.

Definition at line 1500 of file cadstar_pcb_archive_parser.cpp.

 {
     wxASSERT( aNode->GetName() == wxT( "SYMDEF" ) );
 
     ParseIdentifiers( aNode, aContext );
 
     wxString rest;
 
     if( ReferenceName.StartsWith( wxT( "JUMPERNF" ), &rest ) )
         Type = SYMDEF_TYPE::JUMPER;
     else if( ReferenceName.StartsWith( wxT( "STARPOINTNF" ), &rest ) )
         Type = SYMDEF_TYPE::STARPOINT;
     else if( ReferenceName == wxT( "TESTPOINT" ) )
         Type = SYMDEF_TYPE::TESTPOINT;
     else
         Type = SYMDEF_TYPE::COMPONENT;
 
     XNODE* cNode = aNode->GetChildren();
 
     for( ; cNode; cNode = cNode->GetNext() )
     {
         wxString cNodeName = cNode->GetName();
 
         if( ParseSubNode( cNode, aContext ) )
         {
             continue;
         }
         else if( cNodeName == wxT( "SYMHEIGHT" ) )
         {
             SymHeight = GetXmlAttributeIDLong( cNode, 0 );
         }
         else if( cNodeName == wxT( "COMPCOPPER" ) )
         {
             COMPONENT_COPPER compcopper;
             compcopper.Parse( cNode, aContext );
             ComponentCoppers.push_back( compcopper );
         }
         else if( cNodeName == wxT( "COMPAREA" ) )
         {
             COMPONENT_AREA area;
             area.Parse( cNode, aContext );
             ComponentAreas.insert( std::make_pair( area.ID, area ) );
         }
         else if( cNodeName == wxT( "PAD" ) )
         {
             COMPONENT_PAD pad;
             pad.Parse( cNode, aContext );
             ComponentPads.insert( std::make_pair( pad.ID, pad ) );
         }
         else if( cNodeName == wxT( "DIMENSIONS" ) )
         {
             XNODE* dimensionNode = cNode->GetChildren();
 
             for( ; dimensionNode; dimensionNode = dimensionNode->GetNext() )
             {
                 if( DIMENSION::IsDimension( dimensionNode ) )
                 {
                     DIMENSION dim;
                     dim.Parse( dimensionNode, aContext );
                     Dimensions.insert( std::make_pair( dim.ID, dim ) );
                 }
                 else
                 {
                     THROW_UNKNOWN_NODE_IO_ERROR( dimensionNode->GetName(), cNodeName );
                 }
             }
         }
         else
         {
             THROW_UNKNOWN_NODE_IO_ERROR( cNodeName, aNode->GetName() );
         }
     }
 
     if( !Stub && !Origin.IsFullySpecified() )
         THROW_MISSING_PARAMETER_IO_ERROR( wxT( "PT" ), aNode->GetName() );
 }

Referenced by CADSTAR_PCB_ARCHIVE_PARSER::LIBRARY::Parse().

◆ ParseIdentifiers()

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

inherited

Definition at line 1590 of file cadstar_archive_parser.cpp.

 {
     wxASSERT( aNode->GetName() == wxT( "SYMDEF" ) );
 
     ID            = GetXmlAttributeIDString( aNode, 0 );
     ReferenceName = GetXmlAttributeIDString( aNode, 1 );
     Alternate     = GetXmlAttributeIDString( aNode, 2 );
 }

References CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString().

◆ ParseSubNode()

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

inherited

Definition at line 1600 of file cadstar_archive_parser.cpp.

 {
     wxString cNodeName = aChildNode->GetName();
 
     if( cNodeName == wxT( "PT" ) )
     {
         Origin.Parse( aChildNode, aContext );
     }
     else if( cNodeName == wxT( "STUB" ) )
     {
         Stub = true;
     }
     else if( cNodeName == wxT( "VERSION" ) )
     {
         Version = GetXmlAttributeIDLong( aChildNode, 0 );
     }
     else if( cNodeName == wxT( "FIGURE" ) )
     {
         FIGURE figure;
         figure.Parse( aChildNode, aContext );
         Figures.insert( std::make_pair( figure.ID, figure ) );
     }
     else if( cNodeName == wxT( "TEXT" ) )
     {
         TEXT txt;
         txt.Parse( aChildNode, aContext );
         Texts.insert( std::make_pair( txt.ID, txt ) );
     }
     else if( cNodeName == wxT( "TEXTLOC" ) )
     {
         TEXT_LOCATION textloc;
         textloc.Parse( aChildNode, aContext );
         TextLocations.insert( std::make_pair( textloc.AttributeID, textloc ) );
     }
     else if( cNodeName == wxT( "ATTR" ) )
     {
         ATTRIBUTE_VALUE attrVal;
         attrVal.Parse( aChildNode, aContext );
         AttributeValues.insert( std::make_pair( attrVal.AttributeID, attrVal ) );
     }
     else
     {
         return false;
     }
 
     return true;
 }

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 901 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::getSymDefFromName(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponentLibrary(), 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 919 of file cadstar_archive_parser.h.

◆ ComponentAreas

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

Definition at line 780 of file cadstar_pcb_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas().

◆ ComponentCoppers

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

Definition at line 779 of file cadstar_pcb_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers().

◆ ComponentPads

std::map<PAD_ID, COMPONENT_PAD> CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::ComponentPads

Definition at line 781 of file cadstar_pcb_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), and CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryPads().

◆ Dimensions

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

inside "DIMENSIONS" subnode

Definition at line 782 of file cadstar_pcb_archive_parser.h.

◆ Figures

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

inherited

Definition at line 914 of file cadstar_archive_parser.h.

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

◆ ID

SYMDEF_ID CADSTAR_ARCHIVE_PARSER::SYMDEF::ID

inherited

Definition at line 898 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 903 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::loadSchematicSymbolInstances().

◆ 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 899 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::getSymDefFromName(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponentLibrary(), 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 905 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 777 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 916 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances().

◆ Texts

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

inherited

Definition at line 915 of file cadstar_archive_parser.h.

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

◆ Type

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

Definition at line 776 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 911 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

◆ Parse()

◆ ParseIdentifiers()

◆ ParseSubNode()

Member Data Documentation

◆ Alternate

◆ AttributeValues

◆ ComponentAreas

◆ ComponentCoppers

◆ ComponentPads

◆ Dimensions

◆ Figures

◆ ID

◆ Origin

◆ ReferenceName

◆ Stub

◆ SymHeight

◆ TextLocations

◆ Texts

◆ Type

◆ Version