#include <cadstar_pcb_archive_loader.h>

Inheritance diagram for CADSTAR_PCB_ARCHIVE_LOADER:

Public Types
enum class	MATERIAL_LAYER_TYPE { CONSTRUCTION , ELECTRICAL , NON_ELECTRICAL }
	Type of layer appropriate for the material being set up. More...

enum class	LAYER_TYPE { UNDEFINED , ALLLAYER , ALLELEC , ALLDOC , NOLAYER , ASSCOMPCOPP , JUMPERLAYER , ELEC , POWER , NONELEC , CONSTRUCTION , DOC }

enum class	LAYER_SUBTYPE { LAYERSUBTYPE_NONE , LAYERSUBTYPE_SILKSCREEN , LAYERSUBTYPE_PLACEMENT , LAYERSUBTYPE_ASSEMBLY , LAYERSUBTYPE_SOLDERRESIST , LAYERSUBTYPE_PASTE , LAYERSUBTYPE_CLEARANCE , LAYERSUBTYPE_ROUT }

enum class	ROUTING_BIAS { UNBIASED , X , Y , ANTI_ROUTE , OBSTACLE }

enum class	EMBEDDING { NONE , ABOVE , BELOW }

enum class	PAD_SHAPE_TYPE { ANNULUS , BULLET , CIRCLE , DIAMOND , FINGER , OCTAGON , RECTANGLE , ROUNDED_RECT , SQUARE }

enum class	PAD_SIDE { MINIMUM , MAXIMUM , THROUGH_HOLE }
	From CADSTAR Help: "This parameter indicates the physical layers on which the selected pad is placed. More...

enum class	SYMDEF_TYPE { COMPONENT , JUMPER , STARPOINT , TESTPOINT }
	A symbol definition can represent a number of different objects in CADSTAR. More...

enum class	TESTLAND_SIDE { NONE , MAX , MIN , BOTH }

enum class	NETSYNCH { UNDEFINED , WARNING , FULL }

typedef wxString	MATERIAL_ID

typedef long	PHYSICAL_LAYER_ID

typedef wxString	COPPERCODE_ID

typedef wxString	PADCODE_ID

typedef wxString	VIACODE_ID

typedef wxString	SPACINGCODE_ID

typedef wxString	LAYERPAIR_ID

typedef wxString	RULESET_ID

typedef wxString	COMP_AREA_ID

typedef long	PAD_ID
	Pad identifier (pin) in the PCB. More...

typedef wxString	DIMENSION_ID

typedef wxString	BOARD_ID

typedef wxString	AREA_ID

typedef wxString	COMPONENT_ID

typedef wxString	TEMPLATE_ID

typedef long	COPPER_TERM_ID

typedef wxString	COPPER_ID

typedef wxString	DRILL_TABLE_ID

typedef wxString	TRUNK_ID

enum class	TEXT_FIELD_NAME { DESIGN_TITLE , SHORT_JOBNAME , LONG_JOBNAME , NUM_OF_SHEETS , SHEET_NUMBER , SHEET_NAME , VARIANT_NAME , VARIANT_DESCRIPTION , REG_USER , COMPANY_NAME , CURRENT_USER , DATE , TIME , MACHINE_NAME , FROM_FILE , DISTANCE , UNITS_SHORT , UNITS_ABBREV , UNITS_FULL , HYPERLINK , NONE }
	These are special fields in text objects enclosed between the tokens '<@' and '>' such as <@[FIELD_NAME][FIELD_VALUE]>. More...

enum class	RESOLUTION { HUNDREDTH_MICRON }

enum class	LINESTYLE { SOLID , DASH , DASHDOT , DASHDOTDOT , DOT }

enum class	VERTEX_TYPE { POINT , CLOCKWISE_ARC , CLOCKWISE_SEMICIRCLE , ANTICLOCKWISE_ARC , ANTICLOCKWISE_SEMICIRCLE }

enum class	SHAPE_TYPE { OPENSHAPE , OUTLINE , SOLID , HATCHED }

enum class	UNITS { DESIGN , THOU , INCH , MICROMETRE , MM , CENTIMETER , METER }

enum class	ANGUNITS { DEGREES , RADIANS }

enum class	GRID_TYPE { FRACTIONALGRID , STEPGRID }

enum class	ALIGNMENT { NO_ALIGNMENT , TOPLEFT , TOPCENTER , TOPRIGHT , CENTERLEFT , CENTERCENTER , CENTERRIGHT , BOTTOMLEFT , BOTTOMCENTER , BOTTOMRIGHT }
	From CADSTAR Help: "Text Alignment enables you to define the position of an alignment origin for all text items in CADSTAR. More...

enum class	JUSTIFICATION { LEFT , CENTER , RIGHT }
	From CADSTAR Help: "Multi Line Text can also be justified as Left, Centre or Right. More...

enum class	READABILITY { BOTTOM_TO_TOP , TOP_TO_BOTTOM }
	Sets the readability direction of text. More...

enum class	ATTROWNER { ALL_ITEMS , AREA , BOARD , COMPONENT , CONNECTION , COPPER , DOCSYMBOL , FIGURE , NET , NETCLASS , PART , PART_DEFINITION , PIN , SIGNALREF , SYMBOL , SYMDEF , TEMPLATE , TESTPOINT }

enum class	ATTRUSAGE { BOTH , COMPONENT , PART_DEFINITION , PART_LIBRARY , SYMBOL , UNDEFINED }

enum class	SWAP_RULE { NO_SWAP , USE_SWAP_LAYER , BOTH }
	Corresponds to "Display when" Item property. More...

typedef wxString	LINECODE_ID

typedef wxString	HATCHCODE_ID

typedef wxString	ROUTECODE_ID

typedef wxString	NETCLASS_ID

typedef wxString	SPACING_CLASS_ID

typedef wxString	TEXTCODE_ID

typedef wxString	LAYER_ID
	ID of a Sheet (if schematic) or board Layer (if PCB) More...

typedef wxString	VARIANT_ID

typedef wxString	ATTRIBUTE_ID

typedef wxString	SYMDEF_ID

typedef wxString	PART_ID

typedef wxString	GATE_ID

typedef long	TERMINAL_ID
	Terminal is the pin identifier in the schematic. More...

typedef long	PART_DEFINITION_PIN_ID
	Pin identifier in the part definition. More...

typedef long	PART_PIN_ID
	Pin identifier in the part. More...

typedef wxString	TEXT_ID

typedef wxString	FIGURE_ID

typedef wxString	GROUP_ID

typedef wxString	REUSEBLOCK_ID

typedef wxString	NET_ID

typedef wxString	NETELEMENT_ID

typedef wxString	DOCUMENTATION_SYMBOL_ID

typedef wxString	COLOR_ID

Public Member Functions
	CADSTAR_PCB_ARCHIVE_LOADER (wxString aFilename, LAYER_MAPPING_HANDLER aLayerMappingHandler, bool aLogLayerWarnings, PROGRESS_REPORTER *aProgressReporter)

	~CADSTAR_PCB_ARCHIVE_LOADER ()

void	Load (BOARD aBoard, PROJECT aProject)
	Loads a CADSTAR PCB Archive file into the KiCad BOARD object given. More...

std::vector< std::unique_ptr< FOOTPRINT > >	LoadLibrary ()
	Parse a CADSTAR PCB Archive and load the footprints contained within. More...

std::vector< FOOTPRINT * >	GetLoadedLibraryFootpints () const
	Return a copy of the loaded library footprints (caller owns the objects) More...

void	Parse (bool aLibrary=false)
	Parses the file. More...

Static Public Member Functions
static PAD_SIDE	GetPadSide (const wxString &aPadSideString)

static TESTLAND_SIDE	ParseTestlandSide (XNODE *aNode)

static wxString	ParseTextFields (const wxString &aTextString, PARSER_CONTEXT *aParserContext)
	Replaces CADSTAR fields for the equivalent in KiCad and stores the field values in aParserContext. More...

static UNITS	ParseUnits (XNODE *aNode)

static ANGUNITS	ParseAngunits (XNODE *aNode)

static ALIGNMENT	ParseAlignment (XNODE *aNode)

static JUSTIFICATION	ParseJustification (XNODE *aNode)

static READABILITY	ParseReadability (XNODE *aNode)

static SWAP_RULE	ParseSwapRule (XNODE *aNode)

static void	InsertAttributeAtEnd (XNODE *aNode, wxString aValue)

static XNODE *	LoadArchiveFile (const wxString &aFileName, const wxString &aFileTypeIdentifier, PROGRESS_REPORTER *aProgressReporter=nullptr)
	Reads a CADSTAR Archive file (S-parameter format) More...

static bool	IsValidAttribute (wxXmlAttribute *aAttribute)

static wxString	GetXmlAttributeIDString (XNODE *aNode, unsigned int aID, bool aIsRequired=true)

static long	GetXmlAttributeIDLong (XNODE *aNode, unsigned int aID, bool aIsRequired=true)

static void	CheckNoChildNodes (XNODE *aNode)

static void	CheckNoNextNodes (XNODE *aNode)

static void	ParseChildEValue (XNODE aNode, PARSER_CONTEXT aContext, EVALUE &aValueToParse)

static std::vector< POINT >	ParseAllChildPoints (XNODE aNode, PARSER_CONTEXT aContext, bool aTestAllChildNodes=false, int aExpectedNumPoints=UNDEFINED_VALUE)
	if no children are present, it just returns an empty vector (without throwing an exception) More...

static std::vector< VERTEX >	ParseAllChildVertices (XNODE aNode, PARSER_CONTEXT aContext, bool aTestAllChildNodes=false)
	if no children are present, it just returns an empty vector (without throwing an exception) More...

static std::vector< CUTOUT >	ParseAllChildCutouts (XNODE aNode, PARSER_CONTEXT aContext, bool aTestAllChildNodes=false)
	if no children are present, it just returns an empty vector (without throwing an exception) More...

static long	GetNumberOfChildNodes (XNODE *aNode)

static long	GetNumberOfStepsForReporting (XNODE *aRootNode, std::vector< wxString > aSubNodeChildrenToCount)

static wxString	EscapeFieldText (const wxString &aFieldText)

static wxString	HandleTextOverbar (wxString aCadstarString)
	Convert a string with CADSTAR overbar characters to equivalent in KiCad. More...

static void	FixTextPositionNoAlignment (EDA_TEXT *aKiCadTextItem)
	Corrects the position of a text element that had NO_ALIGNMENT in CADSTAR. More...

static wxString	generateLibName (const wxString &aRefName, const wxString &aAlternateName)

Public Attributes
wxString	Filename

HEADER	Header

ASSIGNMENTS	Assignments

LIBRARY	Library

PARTS	Parts

LAYOUT	Layout

int	KiCadUnitMultiplier
	Use this value to convert units in this CPA file to KiCad units. More...

Static Public Attributes
static const long	UNDEFINED_VALUE = -1

static const double	TXT_HEIGHT_RATIO = ( 24.0 - 5.0 ) / 24.0
	CADSTAR fonts are drawn on a 24x24 integer matrix, where the each axis goes from 0 to 24. More...

static const std::map< TEXT_FIELD_NAME, wxString >	CADSTAR_TO_KICAD_FIELDS
	Map between CADSTAR fields and KiCad text variables. More...

static const long	FONT_NORMAL = 400

static const long	FONT_BOLD = 700

Protected Member Functions
void	checkPoint ()
	Updates m_progressReporter or throws if user cancelled. More...

Protected Attributes
PARSER_CONTEXT	m_context

PROGRESS_REPORTER *	m_progressReporter

Private Types
using	ASSOCIATED_COPPER_PADS = std::map< PAD_ID, std::vector< PAD_ID > >
	Map of pad anchor points (first) to copper pads (second). More...

Private Member Functions
void	loadBoardStackup ()

void	remapUnsureLayers ()
	Callback m_layerMappingHandler for layers we aren't sure of. More...

void	loadDesignRules ()

void	loadComponentLibrary ()

void	loadGroups ()

void	loadBoards ()

void	loadFigures ()

void	loadTexts ()

void	loadDimensions ()

void	loadAreas ()

void	loadComponents ()

void	loadDocumentationSymbols ()

void	loadTemplates ()

void	loadCoppers ()

void	loadNets ()

void	loadTextVariables ()

void	logBoardStackupWarning (const wxString &aCadstarLayerName, const PCB_LAYER_ID &aKiCadLayer)

void	logBoardStackupMessage (const wxString &aCadstarLayerName, const PCB_LAYER_ID &aKiCadLayer)

void	initStackupItem (const LAYER &aCadstarLayer, BOARD_STACKUP_ITEM *aKiCadItem, int aDielectricSublayer)

void	loadLibraryFigures (const SYMDEF_PCB &aComponent, FOOTPRINT *aFootprint)

void	loadLibraryCoppers (const SYMDEF_PCB &aComponent, FOOTPRINT *aFootprint)

void	loadLibraryAreas (const SYMDEF_PCB &aComponent, FOOTPRINT *aFootprint)

void	loadLibraryPads (const SYMDEF_PCB &aComponent, FOOTPRINT *aFootprint)

void	loadComponentAttributes (const COMPONENT &aComponent, FOOTPRINT *aFootprint)

void	loadNetTracks (const NET_ID &aCadstarNetID, const NET_PCB::ROUTE &aCadstarRoute, long aStartWidth=std::numeric_limits< long >::max(), long aEndWidth=std::numeric_limits< long >::max())

int	loadNetVia (const NET_ID &aCadstarNetID, const NET_PCB::VIA &aCadstarVia)
	Load via and return via size. More...

void	checkAndLogHatchCode (const HATCHCODE_ID &aCadstarHatchcodeID)

void	applyDimensionSettings (const DIMENSION &aCadstarDim, PCB_DIMENSION_BASE *aKiCadDim)

bool	calculateZonePriorities (PCB_LAYER_ID &aLayer)
	Tries to make a best guess as to the zone priorities based on the pour status. More...

void	drawCadstarText (const TEXT &aCadstarText, BOARD_ITEM_CONTAINER *aContainer, const GROUP_ID &aCadstarGroupID=wxEmptyString, const LAYER_ID &aCadstarLayerOverride=wxEmptyString, const VECTOR2I &aMoveVector={ 0, 0 }, const double &aRotationAngle=0.0, const double &aScalingFactor=1.0, const VECTOR2I &aTransformCentre={ 0, 0 }, const bool &aMirrorInvert=false)

void	drawCadstarShape (const SHAPE &aCadstarShape, const PCB_LAYER_ID &aKiCadLayer, const int &aLineThickness, const wxString &aShapeName, BOARD_ITEM_CONTAINER *aContainer, const GROUP_ID &aCadstarGroupID=wxEmptyString, const VECTOR2I &aMoveVector={ 0, 0 }, const double &aRotationAngle=0.0, const double &aScalingFactor=1.0, const VECTOR2I &aTransformCentre={ 0, 0 }, const bool &aMirrorInvert=false)

void	drawCadstarCutoutsAsShapes (const std::vector< CUTOUT > &aCutouts, const PCB_LAYER_ID &aKiCadLayer, const int &aLineThickness, BOARD_ITEM_CONTAINER *aContainer, const GROUP_ID &aCadstarGroupID=wxEmptyString, const VECTOR2I &aMoveVector={ 0, 0 }, const double &aRotationAngle=0.0, const double &aScalingFactor=1.0, const VECTOR2I &aTransformCentre={ 0, 0 }, const bool &aMirrorInvert=false)
	Uses PCB_SHAPEs to draw the cutouts on m_board object. More...

void	drawCadstarVerticesAsShapes (const std::vector< VERTEX > &aCadstarVertices, const PCB_LAYER_ID &aKiCadLayer, const int &aLineThickness, BOARD_ITEM_CONTAINER *aContainer, const GROUP_ID &aCadstarGroupID=wxEmptyString, const VECTOR2I &aMoveVector={ 0, 0 }, const double &aRotationAngle=0.0, const double &aScalingFactor=1.0, const VECTOR2I &aTransformCentre={ 0, 0 }, const bool &aMirrorInvert=false)
	Uses PCB_SHAPE to draw the vertices on m_board object. More...

std::vector< PCB_SHAPE * >	getShapesFromVertices (const std::vector< VERTEX > &aCadstarVertices, BOARD_ITEM_CONTAINER *aContainer=nullptr, const GROUP_ID &aCadstarGroupID=wxEmptyString, const VECTOR2I &aMoveVector={ 0, 0 }, const double &aRotationAngle=0.0, const double &aScalingFactor=1.0, const VECTOR2I &aTransformCentre={ 0, 0 }, const bool &aMirrorInvert=false)
	Returns a vector of pointers to PCB_SHAPE objects. More...

PCB_SHAPE *	getShapeFromVertex (const POINT &aCadstarStartPoint, const VERTEX &aCadstarVertex, BOARD_ITEM_CONTAINER *aContainer=nullptr, const GROUP_ID &aCadstarGroupID=wxEmptyString, const VECTOR2I &aMoveVector={ 0, 0 }, const double &aRotationAngle=0.0, const double &aScalingFactor=1.0, const VECTOR2I &aTransformCentre={ 0, 0 }, const bool &aMirrorInvert=false)
	Returns a pointer to a PCB_SHAPE object. More...

ZONE *	getZoneFromCadstarShape (const SHAPE &aCadstarShape, const int &aLineThickness, BOARD_ITEM_CONTAINER *aParentContainer)

SHAPE_POLY_SET	getPolySetFromCadstarShape (const SHAPE &aCadstarShape, const int &aLineThickness=-1, BOARD_ITEM_CONTAINER *aContainer=nullptr, const VECTOR2I &aMoveVector={ 0, 0 }, const double &aRotationAngle=0.0, const double &aScalingFactor=1.0, const VECTOR2I &aTransformCentre={ 0, 0 }, const bool &aMirrorInvert=false)
	Returns a SHAPE_POLY_SET object from a Cadstar SHAPE. More...

SHAPE_LINE_CHAIN	getLineChainFromShapes (const std::vector< PCB_SHAPE * > &aShapes)
	Returns a SHAPE_LINE_CHAIN object from a series of PCB_SHAPE objects. More...

std::vector< PCB_TRACK * >	makeTracksFromShapes (const std::vector< PCB_SHAPE * > &aShapes, BOARD_ITEM_CONTAINER aParentContainer, NETINFO_ITEM aNet=nullptr, PCB_LAYER_ID aLayerOverride=UNDEFINED_LAYER, int aWidthOverride=-1)
	Returns a vector of pointers to TRACK/ARC objects. More...

void	addAttribute (const ATTRIBUTE_LOCATION &aCadstarAttrLoc, const ATTRIBUTE_ID &aCadstarAttributeID, FOOTPRINT *aFootprint, const wxString &aAttributeValue)
	Adds a CADSTAR Attribute to a KiCad footprint. More...

void	applyRouteOffset (VECTOR2I *aPointToOffset, const VECTOR2I &aRefPoint, const long &aOffsetAmount)
	CADSTAR's Post Processor does an action called "Route Offset" which is applied when a route is wider than the pad on which it is terminating or when there are different widths of route, in order to reduce overlap. More...

void	applyTextCode (EDA_TEXT *aKiCadText, const TEXTCODE_ID &aCadstarTextCodeID)
	Apply cadstar textcode parameters to a KiCad text object. More...

int	getLineThickness (const LINECODE_ID &aCadstarLineCodeID)

COPPERCODE	getCopperCode (const COPPERCODE_ID &aCadstaCopperCodeID)

HATCHCODE	getHatchCode (const HATCHCODE_ID &aCadstarHatchcodeID)

LAYERPAIR	getLayerPair (const LAYERPAIR_ID &aCadstarLayerPairID)

PADCODE	getPadCode (const PADCODE_ID &aCadstarPadCodeID)

PART	getPart (const PART_ID &aCadstarPartID)

ROUTECODE	getRouteCode (const ROUTECODE_ID &aCadstarRouteCodeID)

TEXTCODE	getTextCode (const TEXTCODE_ID &aCadstarTextCodeID)

VIACODE	getViaCode (const VIACODE_ID &aCadstarViaCodeID)

wxString	getAttributeName (const ATTRIBUTE_ID &aCadstarAttributeID)

wxString	getAttributeValue (const ATTRIBUTE_ID &aCadstarAttributeID, const std::map< ATTRIBUTE_ID, ATTRIBUTE_VALUE > &aCadstarAttributeMap)

LAYER_TYPE	getLayerType (const LAYER_ID aCadstarLayerID)

EDA_ANGLE	getHatchCodeAngle (const HATCHCODE_ID &aCadstarHatchcodeID)

PAD *	getKiCadPad (const COMPONENT_PAD &aCadstarPad, FOOTPRINT *aParent)

PAD *&	getPadReference (FOOTPRINT *aFootprint, const PAD_ID aCadstarPadID)

FOOTPRINT *	getFootprintFromCadstarID (const COMPONENT_ID &aCadstarComponentID)

int	getKiCadHatchCodeThickness (const HATCHCODE_ID &aCadstarHatchcodeID)

int	getKiCadHatchCodeGap (const HATCHCODE_ID &aCadstarHatchcodeID)

PCB_GROUP *	getKiCadGroup (const GROUP_ID &aCadstarGroupID)

VECTOR2I	getKiCadPoint (const VECTOR2I &aCadstarPoint)
	Scales, offsets and inverts y axis to make the point usable directly in KiCad. More...

int	getKiCadLength (long long aCadstarLength)

double	getAngleTenthDegree (const long long &aCadstarAngle)

EDA_ANGLE	getAngle (const long long &aCadstarAngle)

double	getAngleDegrees (const long long &aCadstarAngle)

NETINFO_ITEM *	getKiCadNet (const NET_ID &aCadstarNetID)
	Searches m_netMap and returns the NETINFO_ITEM pointer if exists. More...

PCB_LAYER_ID	getKiCadCopperLayerID (unsigned int aLayerNum, bool aDetectMaxLayer=true)

bool	isLayerSet (const LAYER_ID &aCadstarLayerID)

PCB_LAYER_ID	getKiCadLayer (const LAYER_ID &aCadstarLayerID)

LSET	getKiCadLayerSet (const LAYER_ID &aCadstarLayerID)

bool	isFootprint (BOARD_ITEM_CONTAINER *aContainer)

void	addToGroup (const GROUP_ID &aCadstarGroupID, BOARD_ITEM *aKiCadItem)

GROUP_ID	createUniqueGroupID (const wxString &aName)
	Adds a new PCB_GROUP* to m_groupMap. More...

Private Attributes
LAYER_MAPPING_HANDLER	m_layerMappingHandler
	Callback to get layer mapping. More...

bool	m_logLayerWarnings
	Used in loadBoardStackup() More...

BOARD *	m_board

PROJECT *	m_project

std::map< LAYER_ID, PCB_LAYER_ID >	m_layermap
	Map between Cadstar and KiCad Layers. More...

std::map< SYMDEF_ID, FOOTPRINT * >	m_libraryMap
	Map between Cadstar and KiCad components in the library. More...

std::map< GROUP_ID, PCB_GROUP * >	m_groupMap
	Map between Cadstar and KiCad groups. More...

std::map< COMPONENT_ID, FOOTPRINT * >	m_componentMap
	Map between Cadstar and KiCad components on the board. More...

std::map< SYMDEF_ID, ASSOCIATED_COPPER_PADS >	m_librarycopperpads
	Associated copper pads (if any) for each component library definition. More...

std::map< NET_ID, NETINFO_ITEM * >	m_netMap
	Map between Cadstar and KiCad Nets. More...

std::map< std::tuple< ROUTECODE_ID, NETCLASS_ID, SPACING_CLASS_ID >, std::shared_ptr< NETCLASS > >	m_netClassMap
	Map between Cadstar and KiCad classes. More...

std::map< TEMPLATE_ID, ZONE * >	m_zonesMap
	Map between Cadstar and KiCad zones. More...

std::vector< LAYER_ID >	m_powerPlaneLayers
	List of layers that are marked as power plane in CADSTAR. More...

VECTOR2I	m_designCenter
	Used for calculating the required offset to apply to the Cadstar design so that it fits in KiCad canvas. More...

std::set< HATCHCODE_ID >	m_hatchcodesTested
	Used by checkAndLogHatchCode() to avoid multiple duplicate warnings. More...

std::set< PADCODE_ID >	m_padcodesTested
	Used by getKiCadPad() to avoid multiple duplicate warnings. More...

bool	m_doneCopperWarning
	Used by loadCoppers() to avoid multiple duplicate warnings. More...

bool	m_doneSpacingClassWarning
	Used by getKiCadNet() to avoid multiple duplicate warnings. More...

bool	m_doneNetClassWarning
	Used by getKiCadNet() to avoid multiple duplicate warnings. More...

bool	m_doneTearDropWarning

int	m_numNets
	Number of nets loaded so far. More...

int	m_numCopperLayers
	Number of layers in the design. More...

XNODE *	m_rootNode

Detailed Description

Definition at line 41 of file cadstar_pcb_archive_loader.h.

Member Typedef Documentation

◆ AREA_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::AREA_ID

inherited

Definition at line 78 of file cadstar_pcb_archive_parser.h.

◆ ASSOCIATED_COPPER_PADS

using CADSTAR_PCB_ARCHIVE_LOADER::ASSOCIATED_COPPER_PADS = std::map<PAD_ID, std::vector<PAD_ID> >

private

Map of pad anchor points (first) to copper pads (second).

In the vast majority of designs there is only one copper pad, but just in case, making it a vector

Definition at line 120 of file cadstar_pcb_archive_loader.h.

◆ ATTRIBUTE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_ID

inherited

Definition at line 108 of file cadstar_archive_parser.h.

◆ BOARD_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::BOARD_ID

inherited

Definition at line 77 of file cadstar_pcb_archive_parser.h.

◆ COLOR_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::COLOR_ID

inherited

Definition at line 122 of file cadstar_archive_parser.h.

◆ COMP_AREA_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::COMP_AREA_ID

inherited

Definition at line 74 of file cadstar_pcb_archive_parser.h.

◆ COMPONENT_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_ID

inherited

Definition at line 79 of file cadstar_pcb_archive_parser.h.

◆ COPPER_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::COPPER_ID

inherited

Definition at line 82 of file cadstar_pcb_archive_parser.h.

◆ COPPER_TERM_ID

typedef long CADSTAR_PCB_ARCHIVE_PARSER::COPPER_TERM_ID

inherited

Definition at line 81 of file cadstar_pcb_archive_parser.h.

◆ COPPERCODE_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::COPPERCODE_ID

inherited

Definition at line 68 of file cadstar_pcb_archive_parser.h.

◆ DIMENSION_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION_ID

inherited

Definition at line 76 of file cadstar_pcb_archive_parser.h.

◆ DOCUMENTATION_SYMBOL_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL_ID

inherited

Definition at line 121 of file cadstar_archive_parser.h.

◆ DRILL_TABLE_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::DRILL_TABLE_ID

inherited

Definition at line 83 of file cadstar_pcb_archive_parser.h.

◆ FIGURE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::FIGURE_ID

inherited

Definition at line 116 of file cadstar_archive_parser.h.

◆ GATE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::GATE_ID

inherited

Definition at line 111 of file cadstar_archive_parser.h.

◆ GROUP_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::GROUP_ID

inherited

Definition at line 117 of file cadstar_archive_parser.h.

◆ HATCHCODE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::HATCHCODE_ID

inherited

Definition at line 101 of file cadstar_archive_parser.h.

◆ LAYER_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::LAYER_ID

inherited

ID of a Sheet (if schematic) or board Layer (if PCB)

Definition at line 106 of file cadstar_archive_parser.h.

◆ LAYERPAIR_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::LAYERPAIR_ID

inherited

Definition at line 72 of file cadstar_pcb_archive_parser.h.

◆ LINECODE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::LINECODE_ID

inherited

Definition at line 100 of file cadstar_archive_parser.h.

◆ MATERIAL_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::MATERIAL_ID

inherited

Definition at line 66 of file cadstar_pcb_archive_parser.h.

◆ NET_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::NET_ID

inherited

Definition at line 119 of file cadstar_archive_parser.h.

◆ NETCLASS_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::NETCLASS_ID

inherited

Definition at line 103 of file cadstar_archive_parser.h.

◆ NETELEMENT_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::NETELEMENT_ID

inherited

Definition at line 120 of file cadstar_archive_parser.h.

◆ PAD_ID

typedef long CADSTAR_PCB_ARCHIVE_PARSER::PAD_ID

inherited

Pad identifier (pin) in the PCB.

Definition at line 75 of file cadstar_pcb_archive_parser.h.

◆ PADCODE_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::PADCODE_ID

inherited

Definition at line 69 of file cadstar_pcb_archive_parser.h.

◆ PART_DEFINITION_PIN_ID

typedef long CADSTAR_ARCHIVE_PARSER::PART_DEFINITION_PIN_ID

inherited

Pin identifier in the part definition.

Definition at line 113 of file cadstar_archive_parser.h.

◆ PART_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::PART_ID

inherited

Definition at line 110 of file cadstar_archive_parser.h.

◆ PART_PIN_ID

typedef long CADSTAR_ARCHIVE_PARSER::PART_PIN_ID

inherited

Pin identifier in the part.

Definition at line 114 of file cadstar_archive_parser.h.

◆ PHYSICAL_LAYER_ID

typedef long CADSTAR_PCB_ARCHIVE_PARSER::PHYSICAL_LAYER_ID

inherited

Definition at line 67 of file cadstar_pcb_archive_parser.h.

◆ REUSEBLOCK_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::REUSEBLOCK_ID

inherited

Definition at line 118 of file cadstar_archive_parser.h.

◆ ROUTECODE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::ROUTECODE_ID

inherited

Definition at line 102 of file cadstar_archive_parser.h.

◆ RULESET_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::RULESET_ID

inherited

Definition at line 73 of file cadstar_pcb_archive_parser.h.

◆ SPACING_CLASS_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::SPACING_CLASS_ID

inherited

Definition at line 104 of file cadstar_archive_parser.h.

◆ SPACINGCODE_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::SPACINGCODE_ID

inherited

Definition at line 71 of file cadstar_pcb_archive_parser.h.

◆ SYMDEF_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::SYMDEF_ID

inherited

Definition at line 109 of file cadstar_archive_parser.h.

◆ TEMPLATE_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::TEMPLATE_ID

inherited

Definition at line 80 of file cadstar_pcb_archive_parser.h.

◆ TERMINAL_ID

typedef long CADSTAR_ARCHIVE_PARSER::TERMINAL_ID

inherited

Terminal is the pin identifier in the schematic.

Definition at line 112 of file cadstar_archive_parser.h.

◆ TEXT_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::TEXT_ID

inherited

Definition at line 115 of file cadstar_archive_parser.h.

◆ TEXTCODE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::TEXTCODE_ID

inherited

Definition at line 105 of file cadstar_archive_parser.h.

◆ TRUNK_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::TRUNK_ID

inherited

Definition at line 84 of file cadstar_pcb_archive_parser.h.

◆ VARIANT_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::VARIANT_ID

inherited

Definition at line 107 of file cadstar_archive_parser.h.

◆ VIACODE_ID

typedef wxString CADSTAR_PCB_ARCHIVE_PARSER::VIACODE_ID

inherited

Definition at line 70 of file cadstar_pcb_archive_parser.h.

Member Enumeration Documentation

◆ ALIGNMENT

enum class CADSTAR_ARCHIVE_PARSER::ALIGNMENT

stronginherited

From CADSTAR Help: "Text Alignment enables you to define the position of an alignment origin for all text items in CADSTAR.

The alignment origin is a point on or within the text boundary and defines how the text is displayed.

For example, with an alignment of bottom-right the origin will be positioned at the bottom right of the text boundary. This makes it easier to right-align several text items regardless of the length of text displayed.

Text Alignment applies to all CADSTAR text. [...]

Note: Unaligned text operates in the way CADSTAR text always has. In most cases this behaves as Bottom Left alignment, but there are a few exceptions, e.g. pin names. Also unaligned multiline text has an origin Bottom Left of the first line."

◆ ANGUNITS

enum class CADSTAR_ARCHIVE_PARSER::ANGUNITS

stronginherited

Enumerator
DEGREES
RADIANS

Definition at line 519 of file cadstar_archive_parser.h.

◆ ATTROWNER

enum class CADSTAR_ARCHIVE_PARSER::ATTROWNER

stronginherited

Enumerator
ALL_ITEMS
AREA
BOARD
COMPONENT
CONNECTION
COPPER
DOCSYMBOL
FIGURE
NET
NETCLASS
PART	Only library Attributes.
PART_DEFINITION	Only library Attributes.
PIN
SIGNALREF
SYMBOL
SYMDEF
TEMPLATE
TESTPOINT

Definition at line 666 of file cadstar_archive_parser.h.

◆ ATTRUSAGE

enum class CADSTAR_ARCHIVE_PARSER::ATTRUSAGE

stronginherited

Enumerator
BOTH	From CADSTAR Help: Assigned to both Schematic symbols and PCB components, and displayed on Schematic and PCB designs.
COMPONENT	From CADSTAR Help: Assigned to PCB components and displayed on PCB designs.
PART_DEFINITION	From CADSTAR Help: Assigned to Parts library Definitions and displayed by the Library searcher.
PART_LIBRARY	From CADSTAR Help: Only used by non-Cadstar applications.
SYMBOL	From CADSTAR Help: Assigned to Schematic Symbols and displayed on Schematic Designs.
UNDEFINED	Note: It seems that some attribute have no "ATTRUSAGE" defined. It appears that the attributes that fall under this category are the ones associated with the design itself (i.e. not inherited from the library)

Definition at line 689 of file cadstar_archive_parser.h.

◆ EMBEDDING

enum class CADSTAR_PCB_ARCHIVE_PARSER::EMBEDDING

stronginherited

Enumerator
NONE
ABOVE
BELOW

Definition at line 150 of file cadstar_pcb_archive_parser.h.

◆ GRID_TYPE

enum class CADSTAR_ARCHIVE_PARSER::GRID_TYPE

stronginherited

Enumerator

FRACTIONALGRID

Param1 = Units, Param2 = Divisor.

The grid is equal in X and Y dimensions with a step size equal to Param1/Param2

STEPGRID

Param1 = X Step, Param2 = Y Step. A standard x,y grid.

Definition at line 529 of file cadstar_archive_parser.h.

◆ JUSTIFICATION

enum class CADSTAR_ARCHIVE_PARSER::JUSTIFICATION

stronginherited

From CADSTAR Help: "Multi Line Text can also be justified as Left, Centre or Right.

This does not affect the text alignment. Note: Justification of single line text has no effect."

This only affects multiline text

◆ LAYER_SUBTYPE

enum class CADSTAR_PCB_ARCHIVE_PARSER::LAYER_SUBTYPE

stronginherited

Enumerator
LAYERSUBTYPE_NONE
LAYERSUBTYPE_SILKSCREEN
LAYERSUBTYPE_PLACEMENT
LAYERSUBTYPE_ASSEMBLY
LAYERSUBTYPE_SOLDERRESIST
LAYERSUBTYPE_PASTE
LAYERSUBTYPE_CLEARANCE
LAYERSUBTYPE_ROUT

Definition at line 127 of file cadstar_pcb_archive_parser.h.

◆ LAYER_TYPE

enum class CADSTAR_PCB_ARCHIVE_PARSER::LAYER_TYPE

stronginherited

Enumerator
UNDEFINED	Only used for error detection.
ALLLAYER	Inbuilt layer type (cannot be assigned to user layers)
ALLELEC	Inbuilt layer type (cannot be assigned to user layers)
ALLDOC	Inbuilt layer type (cannot be assigned to user layers)
NOLAYER	Inbuilt layer type (cannot be assigned to user layers)
ASSCOMPCOPP	Inbuilt layer type (cannot be assigned to user layers)
JUMPERLAYER	Inbuilt layer type (cannot be assigned to user layers)
ELEC
POWER
NONELEC	This type has subtypes.
CONSTRUCTION
DOC

Definition at line 110 of file cadstar_pcb_archive_parser.h.

◆ LINESTYLE

enum class CADSTAR_ARCHIVE_PARSER::LINESTYLE

stronginherited

Enumerator
SOLID
DASH
DASHDOT
DASHDOTDOT
DOT

Definition at line 288 of file cadstar_archive_parser.h.

◆ MATERIAL_LAYER_TYPE

enum class CADSTAR_PCB_ARCHIVE_PARSER::MATERIAL_LAYER_TYPE

stronginherited

Type of layer appropriate for the material being set up.

Enumerator

CONSTRUCTION

ELECTRICAL

Either.

See also: LAYER_TYPE::ELEC or; LAYER_TYPE::POWER

NON_ELECTRICAL

Definition at line 89 of file cadstar_pcb_archive_parser.h.

◆ NETSYNCH

enum class CADSTAR_PCB_ARCHIVE_PARSER::NETSYNCH

stronginherited

Enumerator
UNDEFINED
WARNING
FULL

Definition at line 1165 of file cadstar_pcb_archive_parser.h.

◆ PAD_SHAPE_TYPE

enum class CADSTAR_PCB_ARCHIVE_PARSER::PAD_SHAPE_TYPE

stronginherited

Enumerator
ANNULUS
BULLET
CIRCLE	Keyword "ROUND".
DIAMOND
FINGER
OCTAGON
RECTANGLE
ROUNDED_RECT	Keyword "ROUNDED".
SQUARE

Definition at line 267 of file cadstar_pcb_archive_parser.h.

◆ PAD_SIDE

enum class CADSTAR_PCB_ARCHIVE_PARSER::PAD_SIDE

stronginherited

From CADSTAR Help: "This parameter indicates the physical layers on which the selected pad is placed.

Note: When you change the Side parameter in PCB Design, the Side assigned to the pad in the library is not overwritten."

Enumerator

MINIMUM

PHYSICAL_LAYER_ID 1 (i.e.

front / top side). Normally used for surface mount devices.

MAXIMUM

The highest PHYSICAL_LAYER_ID currently defined (i.e.

back / bottom side). Normally used for surface mount devices.

THROUGH_HOLE

All physical layers currently defined.

Definition at line 488 of file cadstar_pcb_archive_parser.h.

◆ READABILITY

enum class CADSTAR_ARCHIVE_PARSER::READABILITY

stronginherited

Sets the readability direction of text.

From CADSTAR Help: "Horizontal text will always be displayed from left to right (i.e. never upside down). Vertical text can be set as readable from either the left or right edge of the design."

I.e. Vertical text can either be rotated 90 degrees clockwise or 90 degrees anticlockwise from horizontal. This does not impact vertical text

Enumerator
BOTTOM_TO_TOP	When text is vertical, show it rotated 90 degrees anticlockwise.
TOP_TO_BOTTOM	When text is vertical, show it rotated 90 degrees clockwise.

Definition at line 656 of file cadstar_archive_parser.h.

◆ RESOLUTION

enum class CADSTAR_ARCHIVE_PARSER::RESOLUTION

stronginherited

Enumerator
HUNDREDTH_MICRON

Definition at line 250 of file cadstar_archive_parser.h.

◆ ROUTING_BIAS

enum class CADSTAR_PCB_ARCHIVE_PARSER::ROUTING_BIAS

stronginherited

Enumerator
UNBIASED	Keyword "UNBIASED" (default)
X	Keyword "X_BIASED".
Y	Keyword "Y_BIASED".
ANTI_ROUTE	Keyword "ANTITRACK".
OBSTACLE	Keyword "OBSTACLE".

Definition at line 140 of file cadstar_pcb_archive_parser.h.

◆ SHAPE_TYPE

enum class CADSTAR_ARCHIVE_PARSER::SHAPE_TYPE

stronginherited

Enumerator
OPENSHAPE	Unfilled open shape. Cannot have cutouts.
OUTLINE	Unfilled closed shape.
SOLID	Filled closed shape (solid fill).
HATCHED	Filled closed shape (hatch fill).

Definition at line 475 of file cadstar_archive_parser.h.

◆ SWAP_RULE

enum class CADSTAR_ARCHIVE_PARSER::SWAP_RULE

stronginherited

Corresponds to "Display when" Item property.

From CADSTAR Help: "This parameter enables you to make the visibility of a component outline/area (or an area of component copper, or a string of component text) dependent on the current mirror status of the component. For example, you may require a string of component text to be displayed only when the component is mirrored."

Enumerator
NO_SWAP	Display when Unmirrored.
USE_SWAP_LAYER	Display when Mirrored.
BOTH	Always display (Mirrored and Unmirrored)

Definition at line 846 of file cadstar_archive_parser.h.

◆ SYMDEF_TYPE

enum class CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_TYPE

stronginherited

A symbol definition can represent a number of different objects in CADSTAR.

SYMDEF_TYPE is used in cadstar2kicadplugin to simplify identification of each type.

Enumerator
COMPONENT	Standard PCB Component definition.
JUMPER	From CADSTAR Help: "Jumpers are components used primarily for the purpose of routing. A jumper's two pins are connected with a wire, joining together the nets on either side. Typically, a jumper is used to bridge across other routes where a routing problem is particularly difficult or to make a small modification to a design when most of the routing has been finalised. In CADSTAR, components are designated as jumpers in the component footprint. If the footprint has two pins and the first eight letters of the reference name spell "JUMPERNF" then the component will be treated as a jumper. From CADSTAR 8.0 archive format onwards, jumpers are saved as jumpers. For older archive formats and for most other export formats and post processing, jumpers are treated just as components. When CADSTAR saves a PCB design in an old archive format, the implied connection between the jumper's pins is added as an actual connection. When an old archive or binary PCB design is opened in the latest CADSTAR, any component footprint with two pins and whose first eight letters spell "JUMPERNF" will be treated as a jumper footprint automatically. If there is an actual connection between the pins, it will be removed and one implied from then on. If there isn't an actual connection, the nets connected to the pins will be merged. If a merge is needed and if each net has a user-supplied name (not $...), you will be asked to choose which name to use."
STARPOINT	From CADSTAR Help: "Starpoints are special symbols/components that can be used to electrically connect different nets together, whilst avoiding any of the standard design rule error codes that would normally occur. If the first eleven letters of the reference name spell "STARPOINTNF" then the component will be treated as a starpoint. For a starpoint component to be valid: There must be at least two pads All pads must have the same position All pads must have the same orientation All pads must be on the same side All pad codes must be the same All pads must have the same exit direction All pads must have the same PCB Only Pad setting If a starpoint component is not valid you will get an error message when trying to add it to the PCB component library."
TESTPOINT	From CADSTAR Help: "A testpoint is an area of copper connected to a net. It allows a test probe to investigate the electrical properties of that net. The Testpoint Symbols provided in the CADSTAR libraries are the Alternates for a pre-defined symbol called TESTPOINT." If the ReferenceName equals "TESTPOINT", then the component is treated as such. Note that the library manager does not permit adding a component with the name "TESTPOINT" if it has more than one pad defined.

Definition at line 728 of file cadstar_pcb_archive_parser.h.

◆ TESTLAND_SIDE

enum class CADSTAR_PCB_ARCHIVE_PARSER::TESTLAND_SIDE

stronginherited

Enumerator
NONE
MAX	The highest PHYSICAL_LAYER_ID currently defined (i.e. back / bottom side).
MIN	The lowest PHYSICAL_LAYER_ID currently defined (i.e. front / top side).
BOTH

Definition at line 866 of file cadstar_pcb_archive_parser.h.

◆ TEXT_FIELD_NAME

enum class CADSTAR_ARCHIVE_PARSER::TEXT_FIELD_NAME

stronginherited

These are special fields in text objects enclosed between the tokens '<@' and '>' such as <@[FIELD_NAME][FIELD_VALUE]>.

For example: "<@DESIGN TITLEProject Title@>"

Enumerator
DESIGN_TITLE
SHORT_JOBNAME
LONG_JOBNAME
NUM_OF_SHEETS
SHEET_NUMBER
SHEET_NAME
VARIANT_NAME
VARIANT_DESCRIPTION
REG_USER
COMPANY_NAME
CURRENT_USER
DATE
TIME
MACHINE_NAME
FROM_FILE
DISTANCE
UNITS_SHORT
UNITS_ABBREV
UNITS_FULL
HYPERLINK
NONE	Synthetic for flagging.

Definition at line 143 of file cadstar_archive_parser.h.

◆ UNITS

enum class CADSTAR_ARCHIVE_PARSER::UNITS

stronginherited

Enumerator
DESIGN	Inherits from design units (assumed Assignments->Technology->Units)
THOU
INCH
MICROMETRE
MM
CENTIMETER
METER

Definition at line 504 of file cadstar_archive_parser.h.

◆ VERTEX_TYPE

enum class CADSTAR_ARCHIVE_PARSER::VERTEX_TYPE

stronginherited

Enumerator
POINT
CLOCKWISE_ARC
CLOCKWISE_SEMICIRCLE
ANTICLOCKWISE_ARC
ANTICLOCKWISE_SEMICIRCLE

Definition at line 429 of file cadstar_archive_parser.h.

Constructor & Destructor Documentation

◆ CADSTAR_PCB_ARCHIVE_LOADER()

CADSTAR_PCB_ARCHIVE_LOADER::CADSTAR_PCB_ARCHIVE_LOADER	(	wxString	aFilename,
		LAYER_MAPPING_HANDLER	aLayerMappingHandler,
		bool	aLogLayerWarnings,
		PROGRESS_REPORTER *	aProgressReporter
	)

inlineexplicit

Definition at line 44 of file cadstar_pcb_archive_loader.h.

References m_board, m_designCenter, m_doneCopperWarning, m_doneNetClassWarning, m_doneSpacingClassWarning, m_doneTearDropWarning, m_layerMappingHandler, m_logLayerWarnings, m_numCopperLayers, m_numNets, CADSTAR_ARCHIVE_PARSER::m_progressReporter, m_project, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ ~CADSTAR_PCB_ARCHIVE_LOADER()

CADSTAR_PCB_ARCHIVE_LOADER::~CADSTAR_PCB_ARCHIVE_LOADER ( )

inline

Definition at line 66 of file cadstar_pcb_archive_loader.h.

References m_libraryMap.

Member Function Documentation

◆ addAttribute()

void CADSTAR_PCB_ARCHIVE_LOADER::addAttribute	(	const ATTRIBUTE_LOCATION &	aCadstarAttrLoc,
		const ATTRIBUTE_ID &	aCadstarAttributeID,
		FOOTPRINT *	aFootprint,
		const wxString &	aAttributeValue
	)

private

Adds a CADSTAR Attribute to a KiCad footprint.

Parameters

aCadstarAttrLoc
aCadstarAttributeID
aFootprint
aAttributeValue

Definition at line 3226 of file cadstar_pcb_archive_loader.cpp.

Referenced by loadComponentAttributes().

◆ addToGroup()

void CADSTAR_PCB_ARCHIVE_LOADER::addToGroup	(	const GROUP_ID &	aCadstarGroupID,
		BOARD_ITEM *	aKiCadItem
	)

private

Definition at line 4156 of file cadstar_pcb_archive_loader.cpp.

References PCB_GROUP::AddItem(), and m_groupMap.

Referenced by drawCadstarShape(), drawCadstarText(), getShapeFromVertex(), and loadBoards().

◆ applyDimensionSettings()

void CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings	(	const DIMENSION &	aCadstarDim,
		PCB_DIMENSION_BASE *	aKiCadDim
	)

private

Definition at line 3637 of file cadstar_pcb_archive_loader.cpp.

Referenced by loadDimensions().

◆ applyRouteOffset()

void CADSTAR_PCB_ARCHIVE_LOADER::applyRouteOffset	(	VECTOR2I *	aPointToOffset,
		const VECTOR2I &	aRefPoint,
		const long &	aOffsetAmount
	)

private

CADSTAR's Post Processor does an action called "Route Offset" which is applied when a route is wider than the pad on which it is terminating or when there are different widths of route, in order to reduce overlap.

Parameters

aPointToOffset	Point that we want to offset by aOffsetAmount
aRefPoint	Reference point to use for determine the angle of the offset
aOffsetAmount

Definition at line 3345 of file cadstar_pcb_archive_loader.cpp.

References VECTOR2< T >::EuclideanNorm(), VECTOR2< T >::Resize(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by makeTracksFromShapes().

◆ applyTextCode()

void CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode	(	EDA_TEXT *	aKiCadText,
		const TEXTCODE_ID &	aCadstarTextCodeID
	)

private

Apply cadstar textcode parameters to a KiCad text object.

Definition at line 3366 of file cadstar_pcb_archive_loader.cpp.

References DEFAULT_SIZE_TEXT, getKiCadLength(), getTextCode(), CADSTAR_ARCHIVE_PARSER::TEXTCODE::Height, KiROUND(), CADSTAR_ARCHIVE_PARSER::TEXTCODE::LineWidth, EDA_UNIT_UTILS::Mils2IU(), pcbIUScale, EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), EDA_TEXT::SetVisible(), CADSTAR_ARCHIVE_PARSER::TXT_HEIGHT_RATIO, CADSTAR_ARCHIVE_PARSER::TEXTCODE::Width, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by addAttribute(), applyDimensionSettings(), and drawCadstarText().

◆ calculateZonePriorities()

bool CADSTAR_PCB_ARCHIVE_LOADER::calculateZonePriorities ( PCB_LAYER_ID & aLayer )

private

Tries to make a best guess as to the zone priorities based on the pour status.

Definition at line 3714 of file cadstar_pcb_archive_loader.cpp.

References ARC_HIGH_DEF, SHAPE_POLY_SET::Area(), CADSTAR_PCB_ARCHIVE_PARSER::Assignments, SHAPE_POLY_SET::BooleanIntersection(), SHAPE_POLY_SET::BooleanSubtract(), CADSTAR_ARCHIVE_PARSER::checkPoint(), CADSTAR_PCB_ARCHIVE_PARSER::ASSIGNMENTS::Codedefs, LSET::Contains(), BOARD::GetDesignSettings(), ZONE::GetFilledPolysList(), getKiCadLength(), ZONE::GetLayerSet(), ZONE::GetLocalClearance(), CADSTAR_PCB_ARCHIVE_PARSER::TEMPLATE::ID, SHAPE_POLY_SET::Inflate(), CADSTAR_PCB_ARCHIVE_PARSER::Layout, m_board, BOARD_DESIGN_SETTINGS::m_MinClearance, m_zonesMap, ZONE::Outline(), SHAPE_POLY_SET::PM_FAST, CADSTAR_PCB_ARCHIVE_PARSER::CODEDEFS_PCB::SpacingCodes, and CADSTAR_PCB_ARCHIVE_PARSER::LAYOUT::Templates.

Referenced by Load().

◆ checkAndLogHatchCode()

void CADSTAR_PCB_ARCHIVE_LOADER::checkAndLogHatchCode ( const HATCHCODE_ID & aCadstarHatchcodeID )

private

Definition at line 3573 of file cadstar_pcb_archive_loader.cpp.

References _, EDA_ANGLE::AsDegrees(), getAngle(), getHatchCode(), getKiCadLength(), CADSTAR_ARCHIVE_PARSER::HATCHCODE::Hatches, m_hatchcodesTested, and CADSTAR_ARCHIVE_PARSER::HATCHCODE::Name.

Referenced by getHatchCodeAngle(), getKiCadHatchCodeGap(), and getKiCadHatchCodeThickness().

◆ CheckNoChildNodes()

void CADSTAR_ARCHIVE_PARSER::CheckNoChildNodes ( XNODE * aNode )

staticinherited

Parameters

aNode

Exceptions

IO_ERROR if a child node was found

Definition at line 2626 of file cadstar_archive_parser.cpp.

References XNODE::GetChildren(), and THROW_UNKNOWN_NODE_IO_ERROR.

Referenced by CADSTAR_ARCHIVE_PARSER::ATTRNAME::COLUMNORDER::Parse(), CADSTAR_ARCHIVE_PARSER::ATTRNAME::COLUMNWIDTH::Parse(), CADSTAR_ARCHIVE_PARSER::REUSEBLOCKREF::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::GATE::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::PIN_EQUIVALENCE::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::SWAP_GATE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::LAYERDEFS::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::SPACINGCODE::REASSIGN::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_COPPER::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_AREA::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::PAD_EXITS::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::AREA::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::NET_PCB::PIN::Parse().

◆ CheckNoNextNodes()

void CADSTAR_ARCHIVE_PARSER::CheckNoNextNodes ( XNODE * aNode )

staticinherited

Parameters

aNode

Exceptions

IO_ERROR if a node adjacent to aNode was found

Definition at line 2633 of file cadstar_archive_parser.cpp.

References XNODE::GetNext(), XNODE::GetParent(), and THROW_UNKNOWN_NODE_IO_ERROR.

Referenced by CADSTAR_SCH_ARCHIVE_PARSER::TERMINAL_SHAPE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMBOLVARIANT::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::CADSTAR_PAD_SHAPE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::PADREASSIGN::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::VIAREASSIGN::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::LAYERPAIR::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::TEXTFORMAT::Parse().

◆ checkPoint()

void CADSTAR_ARCHIVE_PARSER::checkPoint ( )

protectedinherited

Updates m_progressReporter or throws if user cancelled.

Definition at line 2816 of file cadstar_archive_parser.cpp.

References _, PROGRESS_REPORTER::AdvanceProgress(), PROGRESS_REPORTER::KeepRefreshing(), CADSTAR_ARCHIVE_PARSER::m_progressReporter, and THROW_IO_ERROR.

Referenced by calculateZonePriorities(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), loadCoppers(), CADSTAR_SCH_ARCHIVE_LOADER::LoadPartsLib(), CADSTAR_SCH_ARCHIVE_LOADER::loadPartsLibrary(), CADSTAR_SCH_ARCHIVE_PARSER::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ createUniqueGroupID()

CADSTAR_PCB_ARCHIVE_LOADER::GROUP_ID CADSTAR_PCB_ARCHIVE_LOADER::createUniqueGroupID ( const wxString & aName )

private

Adds a new PCB_GROUP* to m_groupMap.

Parameters

aName Name to give the group. If name already exists, append "_1", "_2", etc. to the end to ensure it is unique

Returns

Definition at line 4166 of file cadstar_pcb_archive_loader.cpp.

References BOARD::Add(), m_board, m_groupMap, and PCB_GROUP::SetName().

Referenced by loadBoards(), and loadDocumentationSymbols().

◆ drawCadstarCutoutsAsShapes()

void CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarCutoutsAsShapes	(	const std::vector< CUTOUT > &	aCutouts,
		const PCB_LAYER_ID &	aKiCadLayer,
		const int &	aLineThickness,
		BOARD_ITEM_CONTAINER *	aContainer,
		const GROUP_ID &	aCadstarGroupID = `wxEmptyString`,
		const VECTOR2I &	aMoveVector = `{ 0, 0 }`,
		const double &	aRotationAngle = `0.0`,
		const double &	aScalingFactor = `1.0`,
		const VECTOR2I &	aTransformCentre = `{ 0, 0 }`,
		const bool &	aMirrorInvert = `false`
	)

private

Uses PCB_SHAPEs to draw the cutouts on m_board object.

Parameters

aVertices
aKiCadLayer	KiCad layer to draw on
aLineThickness	Thickness of line to draw with
aContainer	to draw on (e.g. m_board)
aCadstarGroupID	to add the shapes to
aMoveVector	move shapes by this amount (in KiCad coordinates)
aRotationAngle	rotate shapes by this amount (in tenth degrees)
aScalingFactor	scale shapes by this amount
aTransformCentre	around which all transforms are applied (KiCad coordinates)
aMirrorInvert	if true, mirrors the shapes

Definition at line 2809 of file cadstar_pcb_archive_loader.cpp.

References drawCadstarVerticesAsShapes().

Referenced by drawCadstarShape().

◆ drawCadstarShape()

void CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape	(	const SHAPE &	aCadstarShape,
		const PCB_LAYER_ID &	aKiCadLayer,
		const int &	aLineThickness,
		const wxString &	aShapeName,
		BOARD_ITEM_CONTAINER *	aContainer,
		const GROUP_ID &	aCadstarGroupID = `wxEmptyString`,
		const VECTOR2I &	aMoveVector = `{ 0, 0 }`,
		const double &	aRotationAngle = `0.0`,
		const double &	aScalingFactor = `1.0`,
		const VECTOR2I &	aTransformCentre = `{ 0, 0 }`,
		const bool &	aMirrorInvert = `false`
	)

private

Parameters

aCadstarShape
aCadstarLayerID	KiCad layer to draw on
aLineThickness	Thickness of line to draw with
aShapeName	for reporting warnings/errors to the user
aContainer	to draw on (e.g. m_board)
aCadstarGroupID	to add the shape to
aMoveVector	move shapes by this amount (in KiCad coordinates)
aRotationAngle	rotate shapes by this amount (in tenth degrees)
aScalingFactor	scale shapes by this amount
aTransformCentre	around which all transforms are applied (KiCad coordinates)
aMirrorInvert	if true, mirrors the shapes

TODO update this when Polygons in KiCad can be defined with no fill

TODO update this when Polygons in KiCad can be defined with hatch fill

Definition at line 2739 of file cadstar_pcb_archive_loader.cpp.

References _, BOARD_ITEM_CONTAINER::Add(), addToGroup(), CADSTAR_ARCHIVE_PARSER::SHAPE::Cutouts, drawCadstarCutoutsAsShapes(), drawCadstarVerticesAsShapes(), SHAPE_POLY_SET::Fracture(), getPolySetFromCadstarShape(), CADSTAR_ARCHIVE_PARSER::HATCHED, CADSTAR_ARCHIVE_PARSER::OPENSHAPE, CADSTAR_ARCHIVE_PARSER::OUTLINE, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, EDA_SHAPE::SetFilled(), PCB_SHAPE::SetLayer(), EDA_SHAPE::SetPolyShape(), PCB_SHAPE::SetStroke(), CADSTAR_ARCHIVE_PARSER::SOLID, CADSTAR_ARCHIVE_PARSER::SHAPE::Type, and CADSTAR_ARCHIVE_PARSER::SHAPE::Vertices.

Referenced by loadBoards(), loadDocumentationSymbols(), loadFigures(), loadLibraryCoppers(), and loadLibraryFigures().

◆ drawCadstarText()

void CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText	(	const TEXT &	aCadstarText,
		BOARD_ITEM_CONTAINER *	aContainer,
		const GROUP_ID &	aCadstarGroupID = `wxEmptyString`,
		const LAYER_ID &	aCadstarLayerOverride = `wxEmptyString`,
		const VECTOR2I &	aMoveVector = `{ 0, 0 }`,
		const double &	aRotationAngle = `0.0`,
		const double &	aScalingFactor = `1.0`,
		const VECTOR2I &	aTransformCentre = `{ 0, 0 }`,
		const bool &	aMirrorInvert = `false`
	)

private

Parameters

aCadstarText
aContainer	to draw on (e.g. m_board)
aCadstarGroupID	to add the text to
aCadstarLayerOverride	if not empty, overrides the LayerID in aCadstarText
aMoveVector	move text by this amount (in KiCad coordinates)
aRotationAngle	rotate text by this amount (in tenth degrees)
aScalingFactor	scale text by this amount
aTransformCentre	around which all transforms are applied (KiCad coordinates)
aMirrorInvert	if true, it inverts the Mirror status of aCadstarText

Definition at line 2600 of file cadstar_pcb_archive_loader.cpp.

Referenced by loadDocumentationSymbols(), and loadTexts().

◆ drawCadstarVerticesAsShapes()

void CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarVerticesAsShapes	(	const std::vector< VERTEX > &	aCadstarVertices,
		const PCB_LAYER_ID &	aKiCadLayer,
		const int &	aLineThickness,
		BOARD_ITEM_CONTAINER *	aContainer,
		const GROUP_ID &	aCadstarGroupID = `wxEmptyString`,
		const VECTOR2I &	aMoveVector = `{ 0, 0 }`,
		const double &	aRotationAngle = `0.0`,
		const double &	aScalingFactor = `1.0`,
		const VECTOR2I &	aTransformCentre = `{ 0, 0 }`,
		const bool &	aMirrorInvert = `false`
	)

private

Uses PCB_SHAPE to draw the vertices on m_board object.

Parameters

aCadstarVertices
aKiCadLayer	KiCad layer to draw on
aLineThickness	Thickness of line to draw with
aContainer	to draw on (e.g. m_board)
aCadstarGroupID	to add the shape to
aMoveVector	move shape by this amount (in KiCad coordinates)
aRotationAngle	rotate shape by this amount (in tenth degrees)
aScalingFactor	scale shape by this amount
aTransformCentre	around which all transforms are applied (KiCad coordinates)
aMirrorInvert	if true, mirrors the shape
aCadstarGroupID	to add the shape to

Definition at line 2829 of file cadstar_pcb_archive_loader.cpp.

References BOARD_ITEM_CONTAINER::Add(), and getShapesFromVertices().

Referenced by drawCadstarCutoutsAsShapes(), and drawCadstarShape().

◆ EscapeFieldText()

static wxString CADSTAR_ARCHIVE_PARSER::EscapeFieldText ( const wxString & aFieldText )

inlinestaticinherited

Definition at line 1404 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolGateAndPartFields().

◆ FixTextPositionNoAlignment()

void CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment ( EDA_TEXT * aKiCadTextItem )

staticinherited

Corrects the position of a text element that had NO_ALIGNMENT in CADSTAR.

Assumes that the provided text element has been initialised with a position and orientation.

Parameters

aKiCadTextItem a Kicad item to correct

Definition at line 2778 of file cadstar_archive_parser.cpp.

References EDA_TEXT::GetInterline(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), LIB_FIELD_T, LIB_TEXT_T, EDA_TEXT::Offset(), RotatePoint(), text, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), and drawCadstarText().

◆ generateLibName()

wxString CADSTAR_ARCHIVE_PARSER::generateLibName	(	const wxString &	aRefName,
		const wxString &	aAlternateName
	)

staticinherited

Definition at line 2806 of file cadstar_archive_parser.cpp.

References CTX_LIBID, and EscapeString().

Referenced by CADSTAR_ARCHIVE_PARSER::SYMDEF::BuildLibName(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibPart(), and CADSTAR_SCH_ARCHIVE_LOADER::setFootprintOnSymbol().

◆ getAngle()

EDA_ANGLE CADSTAR_PCB_ARCHIVE_LOADER::getAngle ( const long long & aCadstarAngle )

inlineprivate

Parameters

aCadstarAngle

Returns

Definition at line 483 of file cadstar_pcb_archive_loader.h.

References DEGREES_T, CADSTAR_ARCHIVE_PARSER::HEADER::Format, CADSTAR_PCB_ARCHIVE_PARSER::Header, TENTHS_OF_A_DEGREE_T, and CADSTAR_ARCHIVE_PARSER::FORMAT::Version.

Referenced by addAttribute(), checkAndLogHatchCode(), drawCadstarText(), getHatchCodeAngle(), getKiCadPad(), and loadComponents().

◆ getAngleDegrees()

double CADSTAR_PCB_ARCHIVE_LOADER::getAngleDegrees ( const long long & aCadstarAngle )

inlineprivate

Parameters

aCadstarAngle

Returns

Definition at line 503 of file cadstar_pcb_archive_loader.h.

References getAngleTenthDegree().

Referenced by loadDimensions().

◆ getAngleTenthDegree()

double CADSTAR_PCB_ARCHIVE_LOADER::getAngleTenthDegree ( const long long & aCadstarAngle )

inlineprivate

Parameters

aCadstarAngle

Returns

Definition at line 463 of file cadstar_pcb_archive_loader.h.

References CADSTAR_ARCHIVE_PARSER::HEADER::Format, CADSTAR_PCB_ARCHIVE_PARSER::Header, and CADSTAR_ARCHIVE_PARSER::FORMAT::Version.

Referenced by getAngleDegrees(), and loadDocumentationSymbols().

◆ getAttributeName()

wxString CADSTAR_PCB_ARCHIVE_LOADER::getAttributeName ( const ATTRIBUTE_ID & aCadstarAttributeID )

private

Definition at line 3465 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::Assignments, CADSTAR_ARCHIVE_PARSER::CODEDEFS::AttributeNames, and CADSTAR_PCB_ARCHIVE_PARSER::ASSIGNMENTS::Codedefs.

Referenced by addAttribute().

◆ getAttributeValue()

wxString CADSTAR_PCB_ARCHIVE_LOADER::getAttributeValue	(	const ATTRIBUTE_ID &	aCadstarAttributeID,
		const std::map< ATTRIBUTE_ID, ATTRIBUTE_VALUE > &	aCadstarAttributeMap
	)

private

Definition at line 3475 of file cadstar_pcb_archive_loader.cpp.

Referenced by loadComponentAttributes().

◆ getCopperCode()

CADSTAR_PCB_ARCHIVE_LOADER::COPPERCODE CADSTAR_PCB_ARCHIVE_LOADER::getCopperCode ( const COPPERCODE_ID & aCadstaCopperCodeID )

private

Definition at line 3410 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::Assignments, CADSTAR_PCB_ARCHIVE_PARSER::ASSIGNMENTS::Codedefs, and CADSTAR_PCB_ARCHIVE_PARSER::CODEDEFS_PCB::CopperCodes.

Referenced by loadCoppers(), loadLibraryCoppers(), and loadTemplates().

◆ getFootprintFromCadstarID()

FOOTPRINT * CADSTAR_PCB_ARCHIVE_LOADER::getFootprintFromCadstarID ( const COMPONENT_ID & aCadstarComponentID )

private

Definition at line 3913 of file cadstar_pcb_archive_loader.cpp.

References m_componentMap.

Referenced by getKiCadNet(), and loadNets().

◆ getHatchCode()

CADSTAR_PCB_ARCHIVE_LOADER::HATCHCODE CADSTAR_PCB_ARCHIVE_LOADER::getHatchCode ( const HATCHCODE_ID & aCadstarHatchcodeID )

private

Definition at line 3517 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::Assignments, CADSTAR_PCB_ARCHIVE_PARSER::ASSIGNMENTS::Codedefs, and CADSTAR_ARCHIVE_PARSER::CODEDEFS::HatchCodes.

Referenced by checkAndLogHatchCode(), getHatchCodeAngle(), getKiCadHatchCodeGap(), and getKiCadHatchCodeThickness().

◆ getHatchCodeAngle()

EDA_ANGLE CADSTAR_PCB_ARCHIVE_LOADER::getHatchCodeAngle ( const HATCHCODE_ID & aCadstarHatchcodeID )

private

Definition at line 3528 of file cadstar_pcb_archive_loader.cpp.

References checkAndLogHatchCode(), getAngle(), BOARD_DESIGN_SETTINGS::GetDefaultZoneSettings(), BOARD::GetDesignSettings(), getHatchCode(), CADSTAR_ARCHIVE_PARSER::HATCHCODE::Hatches, m_board, and ZONE_SETTINGS::m_HatchOrientation.

Referenced by loadCoppers(), and loadTemplates().

◆ getKiCadCopperLayerID()

PCB_LAYER_ID CADSTAR_PCB_ARCHIVE_LOADER::getKiCadCopperLayerID	(	unsigned int	aLayerNum,
		bool	aDetectMaxLayer = `true`
	)

private

Parameters

aLayerNum	Physical / logical layer number (starts at 1)
aDetectMaxLayer	If true, returns B.Cu if the requested layer is the maximum layer

Returns: PCB_LAYER_ID

Definition at line 4047 of file cadstar_pcb_archive_loader.cpp.

References m_numCopperLayers.

Referenced by loadNetVia().

◆ getKiCadGroup()

PCB_GROUP * CADSTAR_PCB_ARCHIVE_LOADER::getKiCadGroup ( const GROUP_ID & aCadstarGroupID )

private

Definition at line 3565 of file cadstar_pcb_archive_loader.cpp.

References m_groupMap.

Referenced by loadBoards().

◆ getKiCadHatchCodeGap()

int CADSTAR_PCB_ARCHIVE_LOADER::getKiCadHatchCodeGap ( const HATCHCODE_ID & aCadstarHatchcodeID )

private

Definition at line 3553 of file cadstar_pcb_archive_loader.cpp.

References checkAndLogHatchCode(), BOARD_DESIGN_SETTINGS::GetDefaultZoneSettings(), BOARD::GetDesignSettings(), getHatchCode(), getKiCadLength(), CADSTAR_ARCHIVE_PARSER::HATCHCODE::Hatches, m_board, and ZONE_SETTINGS::m_HatchGap.

Referenced by loadCoppers(), and loadTemplates().

◆ getKiCadHatchCodeThickness()

int CADSTAR_PCB_ARCHIVE_LOADER::getKiCadHatchCodeThickness ( const HATCHCODE_ID & aCadstarHatchcodeID )

private

Definition at line 3540 of file cadstar_pcb_archive_loader.cpp.

References checkAndLogHatchCode(), BOARD_DESIGN_SETTINGS::GetDefaultZoneSettings(), BOARD::GetDesignSettings(), getHatchCode(), getKiCadLength(), CADSTAR_ARCHIVE_PARSER::HATCHCODE::Hatches, m_board, and ZONE_SETTINGS::m_HatchThickness.

Referenced by loadCoppers(), and loadTemplates().

◆ getKiCadLayer()

PCB_LAYER_ID CADSTAR_PCB_ARCHIVE_LOADER::getKiCadLayer ( const LAYER_ID & aCadstarLayerID )

private

Parameters

aCadstarLayerID

Returns: PCB_LAYER_ID

Definition at line 4116 of file cadstar_pcb_archive_loader.cpp.

References getLayerType(), m_layermap, and CADSTAR_PCB_ARCHIVE_PARSER::NOLAYER.

Referenced by addAttribute(), applyDimensionSettings(), drawCadstarText(), getKiCadLayerSet(), getKiCadPad(), loadAreas(), loadCoppers(), loadFigures(), loadLibraryAreas(), loadLibraryCoppers(), loadLibraryFigures(), loadNetTracks(), and loadTemplates().

◆ getKiCadLayerSet()

LSET CADSTAR_PCB_ARCHIVE_LOADER::getKiCadLayerSet ( const LAYER_ID & aCadstarLayerID )

private

Parameters

aCadstarLayerID

Returns: LSET

Definition at line 4132 of file cadstar_pcb_archive_loader.cpp.

References LSET::AllCuMask(), CADSTAR_PCB_ARCHIVE_PARSER::ALLDOC, CADSTAR_PCB_ARCHIVE_PARSER::ALLELEC, CADSTAR_PCB_ARCHIVE_PARSER::ALLLAYER, LSET::AllLayersMask(), getKiCadLayer(), getLayerType(), m_numCopperLayers, and MAX_CU_LAYERS.

Referenced by drawCadstarText(), loadAreas(), loadDocumentationSymbols(), and loadLibraryAreas().

◆ getKiCadLength()

int CADSTAR_PCB_ARCHIVE_LOADER::getKiCadLength ( long long aCadstarLength )

inlineprivate

Parameters

aCadstarLength

Returns

Definition at line 453 of file cadstar_pcb_archive_loader.h.

References CADSTAR_PCB_ARCHIVE_PARSER::KiCadUnitMultiplier.

Referenced by applyDimensionSettings(), applyTextCode(), calculateZonePriorities(), checkAndLogHatchCode(), getKiCadHatchCodeGap(), getKiCadHatchCodeThickness(), getKiCadNet(), getKiCadPad(), getLineThickness(), initStackupItem(), loadCoppers(), loadDesignRules(), loadDimensions(), loadLibraryCoppers(), loadNets(), loadNetTracks(), loadNetVia(), and loadTemplates().

◆ getKiCadNet()

NETINFO_ITEM * CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet ( const NET_ID & aCadstarNetID )

private

Searches m_netMap and returns the NETINFO_ITEM pointer if exists.

Otherwise creates a new one and adds it to m_board.

Parameters

aCadstarNetID

Returns

Definition at line 3934 of file cadstar_pcb_archive_loader.cpp.

Referenced by loadCoppers(), loadNets(), loadNetTracks(), loadNetVia(), and loadTemplates().

◆ getKiCadPad()

PAD * CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad	(	const COMPONENT_PAD &	aCadstarPad,
		FOOTPRINT *	aParent
	)

private

Definition at line 996 of file cadstar_pcb_archive_loader.cpp.

Referenced by loadComponents(), and loadLibraryPads().

◆ getKiCadPoint()

VECTOR2I CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPoint ( const VECTOR2I & aCadstarPoint )

private

Scales, offsets and inverts y axis to make the point usable directly in KiCad.

Parameters

aCadstarPoint

Returns

Definition at line 3923 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::KiCadUnitMultiplier, m_designCenter, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by addAttribute(), applyDimensionSettings(), drawCadstarText(), getKiCadPad(), getShapeFromVertex(), loadComponentLibrary(), loadComponents(), loadDimensions(), loadDocumentationSymbols(), loadLibraryCoppers(), and loadNetVia().

◆ getLayerPair()

CADSTAR_PCB_ARCHIVE_LOADER::LAYERPAIR CADSTAR_PCB_ARCHIVE_LOADER::getLayerPair ( const LAYERPAIR_ID & aCadstarLayerPairID )

private

Definition at line 3454 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::Assignments, CADSTAR_PCB_ARCHIVE_PARSER::ASSIGNMENTS::Codedefs, and CADSTAR_PCB_ARCHIVE_PARSER::CODEDEFS_PCB::LayerPairs.

Referenced by loadNetVia().

◆ getLayerType()

CADSTAR_PCB_ARCHIVE_LOADER::LAYER_TYPE CADSTAR_PCB_ARCHIVE_LOADER::getLayerType ( const LAYER_ID aCadstarLayerID )

private

Definition at line 3486 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::Assignments, CADSTAR_PCB_ARCHIVE_PARSER::ASSIGNMENTS::Layerdefs, CADSTAR_PCB_ARCHIVE_PARSER::LAYERDEFS::Layers, and CADSTAR_PCB_ARCHIVE_PARSER::UNDEFINED.

Referenced by getKiCadLayer(), getKiCadLayerSet(), and loadComponentLibrary().

◆ getLineChainFromShapes()

SHAPE_LINE_CHAIN CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromShapes ( const std::vector< PCB_SHAPE * > & aShapes )

private

Returns a SHAPE_LINE_CHAIN object from a series of PCB_SHAPE objects.

Parameters

aShapes

Returns

Definition at line 3060 of file cadstar_pcb_archive_loader.cpp.

References SHAPE_LINE_CHAIN::Append(), SHAPE_LINE_CHAIN::GetPoint(), SHAPE_LINE_CHAIN::PointCount(), SHAPE_ARC::Reverse(), and SHAPE_LINE_CHAIN::SetClosed().

Referenced by getPolySetFromCadstarShape().

◆ getLineThickness()

int CADSTAR_PCB_ARCHIVE_LOADER::getLineThickness ( const LINECODE_ID & aCadstarLineCodeID )

private

Definition at line 3400 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::Assignments, CADSTAR_PCB_ARCHIVE_PARSER::ASSIGNMENTS::Codedefs, BOARD::GetDesignSettings(), getKiCadLength(), BOARD_DESIGN_SETTINGS::GetLineThickness(), CADSTAR_ARCHIVE_PARSER::CODEDEFS::LineCodes, and m_board.

Referenced by loadBoards(), loadDocumentationSymbols(), loadFigures(), and loadLibraryFigures().

◆ GetLoadedLibraryFootpints()

std::vector< FOOTPRINT * > CADSTAR_PCB_ARCHIVE_LOADER::GetLoadedLibraryFootpints ( ) const

Return a copy of the loaded library footprints (caller owns the objects)

Returns: Container with all the footprint definitions that were loaded

Definition at line 173 of file cadstar_pcb_archive_loader.cpp.

References m_libraryMap.

Referenced by CADSTAR_PCB_ARCHIVE_PLUGIN::LoadBoard().

◆ GetNumberOfChildNodes()

long CADSTAR_ARCHIVE_PARSER::GetNumberOfChildNodes ( XNODE * aNode )

staticinherited

Definition at line 2736 of file cadstar_archive_parser.cpp.

References XNODE::GetChildren(), and XNODE::GetNext().

Referenced by CADSTAR_ARCHIVE_PARSER::GetNumberOfStepsForReporting().

◆ GetNumberOfStepsForReporting()

long CADSTAR_ARCHIVE_PARSER::GetNumberOfStepsForReporting	(	XNODE *	aRootNode,
		std::vector< wxString >	aSubNodeChildrenToCount
	)

staticinherited

Definition at line 2748 of file cadstar_archive_parser.cpp.

References XNODE::GetChildren(), XNODE::GetNext(), and CADSTAR_ARCHIVE_PARSER::GetNumberOfChildNodes().

Referenced by CADSTAR_SCH_ARCHIVE_PARSER::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ getPadCode()

CADSTAR_PCB_ARCHIVE_LOADER::PADCODE CADSTAR_PCB_ARCHIVE_LOADER::getPadCode ( const PADCODE_ID & aCadstarPadCodeID )

private

Definition at line 3432 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::Assignments, CADSTAR_PCB_ARCHIVE_PARSER::ASSIGNMENTS::Codedefs, and CADSTAR_PCB_ARCHIVE_PARSER::CODEDEFS_PCB::PadCodes.

Referenced by getKiCadPad(), and loadLibraryCoppers().

◆ getPadReference()

PAD *& CADSTAR_PCB_ARCHIVE_LOADER::getPadReference	(	FOOTPRINT *	aFootprint,
		const PAD_ID	aCadstarPadID
	)

private

Definition at line 1322 of file cadstar_pcb_archive_loader.cpp.

References _, FOOTPRINT::GetReference(), FOOTPRINT::Pads(), and THROW_IO_ERROR.

Referenced by loadComponents(), loadLibraryCoppers(), and loadNets().

◆ GetPadSide()

CADSTAR_PCB_ARCHIVE_PARSER::PAD_SIDE CADSTAR_PCB_ARCHIVE_PARSER::GetPadSide ( const wxString & aPadSideString )

staticinherited

Definition at line 1010 of file cadstar_pcb_archive_parser.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::MAXIMUM, CADSTAR_PCB_ARCHIVE_PARSER::MINIMUM, and CADSTAR_PCB_ARCHIVE_PARSER::THROUGH_HOLE.

Referenced by CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_PAD::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::PADEXCEPTION::Parse().

◆ getPart()

CADSTAR_PCB_ARCHIVE_LOADER::PART CADSTAR_PCB_ARCHIVE_LOADER::getPart ( const PART_ID & aCadstarPartID )

private

Definition at line 3497 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_ARCHIVE_PARSER::PARTS::PartDefinitions, and CADSTAR_PCB_ARCHIVE_PARSER::Parts.

Referenced by loadComponentAttributes(), and loadComponents().

◆ getPolySetFromCadstarShape()

SHAPE_POLY_SET CADSTAR_PCB_ARCHIVE_LOADER::getPolySetFromCadstarShape	(	const SHAPE &	aCadstarShape,
		const int &	aLineThickness = `-1`,
		BOARD_ITEM_CONTAINER *	aContainer = `nullptr`,
		const VECTOR2I &	aMoveVector = `{ 0, 0 }`,
		const double &	aRotationAngle = `0.0`,
		const double &	aScalingFactor = `1.0`,
		const VECTOR2I &	aTransformCentre = `{ 0, 0 }`,
		const bool &	aMirrorInvert = `false`
	)

private

Returns a SHAPE_POLY_SET object from a Cadstar SHAPE.

Parameters

aCadstarShape
aLineThickness	Thickness of line is used for expanding the polygon by half.
aContainer	to draw on (e.g. m_board). Can be nullptr.
aMoveVector	move poly by this amount (in KiCad coordinates)
aRotationAngle	rotate poly by this amount (in tenth degrees)
aScalingFactor	scale poly by this amount
aTransformCentre	around which all transforms are applied (KiCad coordinates)
aMirrorInvert	if true, mirrors the poly

Returns

Definition at line 3003 of file cadstar_pcb_archive_loader.cpp.

References SHAPE_POLY_SET::AddHole(), ARC_HIGH_DEF, SHAPE_POLY_SET::ClearArcs(), CADSTAR_ARCHIVE_PARSER::SHAPE::Cutouts, getLineChainFromShapes(), getShapesFromVertices(), SHAPE_POLY_SET::Hole(), SHAPE_POLY_SET::HoleCount(), SHAPE_POLY_SET::Inflate(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN::PointCount(), CADSTAR_ARCHIVE_PARSER::CUTOUT::Vertices, and CADSTAR_ARCHIVE_PARSER::SHAPE::Vertices.

Referenced by drawCadstarShape(), getZoneFromCadstarShape(), loadCoppers(), and loadLibraryCoppers().

◆ getRouteCode()

CADSTAR_PCB_ARCHIVE_LOADER::ROUTECODE CADSTAR_PCB_ARCHIVE_LOADER::getRouteCode ( const ROUTECODE_ID & aCadstarRouteCodeID )

private

Definition at line 3506 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::Assignments, CADSTAR_PCB_ARCHIVE_PARSER::ASSIGNMENTS::Codedefs, and CADSTAR_ARCHIVE_PARSER::CODEDEFS::RouteCodes.

Referenced by getKiCadNet().

◆ getShapeFromVertex()

PCB_SHAPE * CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex	(	const POINT &	aCadstarStartPoint,
		const VERTEX &	aCadstarVertex,
		BOARD_ITEM_CONTAINER *	aContainer = `nullptr`,
		const GROUP_ID &	aCadstarGroupID = `wxEmptyString`,
		const VECTOR2I &	aMoveVector = `{ 0, 0 }`,
		const double &	aRotationAngle = `0.0`,
		const double &	aScalingFactor = `1.0`,
		const VECTOR2I &	aTransformCentre = `{ 0, 0 }`,
		const bool &	aMirrorInvert = `false`
	)

private

Returns a pointer to a PCB_SHAPE object.

Caller owns the object.

Parameters

aCadstarStartPoint
aCadstarVertex
aContainer	to draw on (e.g. m_board). Can be nullptr.
aCadstarGroupID	to add the shape to
aMoveVector	move shapes by this amount (in KiCad coordinates)
aRotationAngle	rotate shapes by this amount (in tenth degrees)
aScalingFactor	scale shapes by this amount
aTransformCentre	around which all transforms are applied (KiCad coordinates)
aMirrorInvert	if true, mirrors the shapes

Returns

Definition at line 2887 of file cadstar_pcb_archive_loader.cpp.

Referenced by getShapesFromVertices(), and loadNetTracks().

◆ getShapesFromVertices()

std::vector< PCB_SHAPE * > CADSTAR_PCB_ARCHIVE_LOADER::getShapesFromVertices	(	const std::vector< VERTEX > &	aCadstarVertices,
		BOARD_ITEM_CONTAINER *	aContainer = `nullptr`,
		const GROUP_ID &	aCadstarGroupID = `wxEmptyString`,
		const VECTOR2I &	aMoveVector = `{ 0, 0 }`,
		const double &	aRotationAngle = `0.0`,
		const double &	aScalingFactor = `1.0`,
		const VECTOR2I &	aTransformCentre = `{ 0, 0 }`,
		const bool &	aMirrorInvert = `false`
	)

private

Returns a vector of pointers to PCB_SHAPE objects.

Caller owns the objects.

Parameters

aCadstarVertices
aContainer	to draw on (e.g. m_board). Can be nullptr.
aCadstarGroupID	to add the shape to
aMoveVector	move shapes by this amount (in KiCad coordinates)
aRotationAngle	rotate shapes by this amount (in tenth degrees)
aScalingFactor	scale shapes by this amount
aTransformCentre	around which all transforms are applied (KiCad coordinates)
aMirrorInvert	if true, mirrors the shapes

Returns

Definition at line 2855 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_ARCHIVE_PARSER::VERTEX::End, and getShapeFromVertex().

Referenced by drawCadstarVerticesAsShapes(), getPolySetFromCadstarShape(), and loadCoppers().

◆ getTextCode()

CADSTAR_PCB_ARCHIVE_LOADER::TEXTCODE CADSTAR_PCB_ARCHIVE_LOADER::getTextCode ( const TEXTCODE_ID & aCadstarTextCodeID )

private

Definition at line 3421 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::Assignments, CADSTAR_PCB_ARCHIVE_PARSER::ASSIGNMENTS::Codedefs, and CADSTAR_ARCHIVE_PARSER::CODEDEFS::TextCodes.

Referenced by applyTextCode().

◆ getViaCode()

CADSTAR_PCB_ARCHIVE_LOADER::VIACODE CADSTAR_PCB_ARCHIVE_LOADER::getViaCode ( const VIACODE_ID & aCadstarViaCodeID )

private

Definition at line 3443 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::Assignments, CADSTAR_PCB_ARCHIVE_PARSER::ASSIGNMENTS::Codedefs, and CADSTAR_PCB_ARCHIVE_PARSER::CODEDEFS_PCB::ViaCodes.

Referenced by loadNetVia().

◆ GetXmlAttributeIDLong()

long CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDLong	(	XNODE *	aNode,
		unsigned int	aID,
		bool	aIsRequired = `true`
	)

staticinherited

Parameters

aNode
aID
aIsRequired	Prevents exception throwing if false.

Returns: returns the value (long) of attribute "attrX" in aNode where 'X' is aID

Exceptions

IO_ERROR if attribute does not exist

Definition at line 2608 of file cadstar_archive_parser.cpp.

References CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), THROW_PARSING_IO_ERROR, and CADSTAR_ARCHIVE_PARSER::UNDEFINED_VALUE.

◆ GetXmlAttributeIDString()

wxString CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString	(	XNODE *	aNode,
		unsigned int	aID,
		bool	aIsRequired = `true`
	)

staticinherited

Parameters

aNode
aID
aIsRequired	Prevents exception throwing if false.

Returns: returns the value (wxString) of attribute "attrX" in aNode where 'X' is aID

Exceptions

IO_ERROR if attribute does not exist

Definition at line 2582 of file cadstar_archive_parser.cpp.

References THROW_MISSING_PARAMETER_IO_ERROR.

◆ getZoneFromCadstarShape()

ZONE * CADSTAR_PCB_ARCHIVE_LOADER::getZoneFromCadstarShape	(	const SHAPE &	aCadstarShape,
		const int &	aLineThickness,
		BOARD_ITEM_CONTAINER *	aParentContainer
	)

private

Parameters

aCadstarShape
aLineThickness	Thickness of line to draw with
aParentContainer	Parent object (e.g. BOARD or FOOTPRINT pointer)

Returns: Pointer to ZONE. Caller owns the object.

Definition at line 2976 of file cadstar_pcb_archive_loader.cpp.

References ZONE::AddPolygon(), SHAPE_POLY_SET::CHole(), SHAPE_POLY_SET::COutline(), getPolySetFromCadstarShape(), CADSTAR_ARCHIVE_PARSER::HATCHED, SHAPE_POLY_SET::HoleCount(), ZONE::SetFillMode(), ZONE::SetHatchStyle(), and CADSTAR_ARCHIVE_PARSER::SHAPE::Type.

Referenced by loadAreas(), loadCoppers(), loadLibraryAreas(), and loadTemplates().

◆ HandleTextOverbar()

wxString CADSTAR_ARCHIVE_PARSER::HandleTextOverbar ( wxString aCadstarString )

staticinherited

Convert a string with CADSTAR overbar characters to equivalent in KiCad.

Parameters

aCadstarString Input string

Returns: KiCad string with overbar characters

Definition at line 2768 of file cadstar_archive_parser.cpp.

References ConvertToNewOverbarNotation().

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibPart(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolGateAndPartFields().

◆ initStackupItem()

void CADSTAR_PCB_ARCHIVE_LOADER::initStackupItem	(	const LAYER &	aCadstarLayer,
		BOARD_STACKUP_ITEM *	aKiCadItem,
		int	aDielectricSublayer
	)

private

Definition at line 260 of file cadstar_pcb_archive_loader.cpp.

Referenced by loadBoardStackup().

◆ InsertAttributeAtEnd()

void CADSTAR_ARCHIVE_PARSER::InsertAttributeAtEnd	(	XNODE *	aNode,
		wxString	aValue
	)

staticinherited

Definition at line 2422 of file cadstar_archive_parser.cpp.

Referenced by CADSTAR_ARCHIVE_PARSER::LoadArchiveFile().

◆ isFootprint()

bool CADSTAR_PCB_ARCHIVE_LOADER::isFootprint ( BOARD_ITEM_CONTAINER * aContainer )

inlineprivate

Definition at line 546 of file cadstar_pcb_archive_loader.h.

References PCB_FOOTPRINT_T, and EDA_ITEM::Type().

◆ isLayerSet()

bool CADSTAR_PCB_ARCHIVE_LOADER::isLayerSet ( const LAYER_ID & aCadstarLayerID )

private

Parameters

aCadstarLayerID

Returns: true if the layer corresponds to a KiCad LSET or false if the layer maps directly

Definition at line 4093 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::ALLDOC, CADSTAR_PCB_ARCHIVE_PARSER::ALLELEC, CADSTAR_PCB_ARCHIVE_PARSER::ALLLAYER, CADSTAR_PCB_ARCHIVE_PARSER::Assignments, CADSTAR_PCB_ARCHIVE_PARSER::ASSIGNMENTS::Layerdefs, CADSTAR_PCB_ARCHIVE_PARSER::LAYERDEFS::Layers, and CADSTAR_PCB_ARCHIVE_PARSER::LAYER::Type.

Referenced by drawCadstarText(), loadAreas(), and loadLibraryAreas().

◆ IsValidAttribute()

bool CADSTAR_ARCHIVE_PARSER::IsValidAttribute ( wxXmlAttribute * aAttribute )

staticinherited

Parameters

aAttribute

Returns

Definition at line 2576 of file cadstar_archive_parser.cpp.

Referenced by CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::PIN_EQUIVALENCE::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::SWAP_GATE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::LAYERDEFS::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_COPPER::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_AREA::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::PAD_EXITS::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::AREA::Parse().

◆ Load()

void CADSTAR_PCB_ARCHIVE_LOADER::Load	(	BOARD *	aBoard,
		PROJECT *	aProject
	)

Loads a CADSTAR PCB Archive file into the KiCad BOARD object given.

Parameters

aBoard

Definition at line 51 of file cadstar_pcb_archive_loader.cpp.

Referenced by CADSTAR_PCB_ARCHIVE_PLUGIN::LoadBoard().

◆ LoadArchiveFile()

XNODE * CADSTAR_ARCHIVE_PARSER::LoadArchiveFile	(	const wxString &	aFileName,
		const wxString &	aFileTypeIdentifier,
		PROGRESS_REPORTER *	aProgressReporter = `nullptr`
	)

staticinherited

Reads a CADSTAR Archive file (S-parameter format)

Parameters

aFileName
aFileTypeIdentifier	Identifier of the first node in the file to check against. E.g. "CADSTARPCB"
aProgressReporter	Pointer to a Progress Reporter to report progress to.

Returns: XNODE pointing to the top of the tree for further parsing. Each node has the first element as the node's name and subsequent elements as node attributes ("attr0", "attr1", "attr2", etc.). Caller is responsible for deleting to avoid memory leaks.

Exceptions

IO_ERROR

Definition at line 2451 of file cadstar_archive_parser.cpp.

References _, DSNLEXER::CurText(), DSN_EOF, DSN_LEFT, DSN_RIGHT, XNODE::GetParent(), CADSTAR_ARCHIVE_PARSER::InsertAttributeAtEnd(), PROGRESS_REPORTER::KeepRefreshing(), DSNLEXER::NextTok(), PROGRESS_REPORTER::SetCurrentProgress(), and THROW_IO_ERROR.

Referenced by CADSTAR_SCH_ARCHIVE_PARSER::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ loadAreas()

void CADSTAR_PCB_ARCHIVE_LOADER::loadAreas ( )

private

Definition at line 1657 of file cadstar_pcb_archive_loader.cpp.

Referenced by Load().

◆ loadBoards()

void CADSTAR_PCB_ARCHIVE_LOADER::loadBoards ( )

private

Definition at line 1385 of file cadstar_pcb_archive_loader.cpp.

References addToGroup(), CADSTAR_PCB_ARCHIVE_PARSER::LAYOUT::Boards, createUniqueGroupID(), drawCadstarShape(), getKiCadGroup(), getLineThickness(), CADSTAR_PCB_ARCHIVE_PARSER::CADSTAR_BOARD::GroupID, CADSTAR_PCB_ARCHIVE_PARSER::CADSTAR_BOARD::ID, CADSTAR_PCB_ARCHIVE_PARSER::Layout, CADSTAR_PCB_ARCHIVE_PARSER::CADSTAR_BOARD::LineCodeID, m_board, and CADSTAR_PCB_ARCHIVE_PARSER::CADSTAR_BOARD::Shape.

Referenced by Load().

◆ loadBoardStackup()

void CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup ( )

private

Definition at line 282 of file cadstar_pcb_archive_loader.cpp.

Referenced by Load(), and LoadLibrary().

◆ loadComponentAttributes()

void CADSTAR_PCB_ARCHIVE_LOADER::loadComponentAttributes	(	const COMPONENT &	aComponent,
		FOOTPRINT *	aFootprint
	)

private

Definition at line 2451 of file cadstar_pcb_archive_loader.cpp.

References addAttribute(), CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::AttributeID, CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::AttributeID, CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::AttributeLocation, CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT::AttributeValues, COMPONENT_NAME_2_ATTRID, COMPONENT_NAME_ATTRID, getAttributeValue(), getPart(), CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::HasLocation, CADSTAR_ARCHIVE_PARSER::PART::Name, PART_NAME_ATTRID, CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT::PartID, CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT::TextLocations, and CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::Value.

Referenced by loadComponents().

◆ loadComponentLibrary()

void CADSTAR_PCB_ARCHIVE_LOADER::loadComponentLibrary ( )

private

◆ loadComponents()

void CADSTAR_PCB_ARCHIVE_LOADER::loadComponents ( )

private

Definition at line 1711 of file cadstar_pcb_archive_loader.cpp.

Referenced by Load().

◆ loadCoppers()

void CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers ( )

private

Definition at line 2099 of file cadstar_pcb_archive_loader.cpp.

Referenced by Load().

◆ loadDesignRules()

void CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules ( )

private

◆ loadDimensions()

void CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions ( )

private

Definition at line 1433 of file cadstar_pcb_archive_loader.cpp.

Referenced by Load().

◆ loadDocumentationSymbols()

void CADSTAR_PCB_ARCHIVE_LOADER::loadDocumentationSymbols ( )

private

Definition at line 1834 of file cadstar_pcb_archive_loader.cpp.

Referenced by Load().

◆ loadFigures()

void CADSTAR_PCB_ARCHIVE_LOADER::loadFigures ( )

private

Definition at line 1406 of file cadstar_pcb_archive_loader.cpp.

References drawCadstarShape(), CADSTAR_PCB_ARCHIVE_PARSER::LAYOUT::Figures, getKiCadLayer(), getLineThickness(), CADSTAR_ARCHIVE_PARSER::FIGURE::GroupID, CADSTAR_ARCHIVE_PARSER::FIGURE::ID, CADSTAR_ARCHIVE_PARSER::FIGURE::LayerID, CADSTAR_PCB_ARCHIVE_PARSER::Layout, CADSTAR_ARCHIVE_PARSER::FIGURE::LineCodeID, m_board, and CADSTAR_ARCHIVE_PARSER::FIGURE::Shape.

Referenced by Load().

◆ loadGroups()

void CADSTAR_PCB_ARCHIVE_LOADER::loadGroups ( )

private

Definition at line 1338 of file cadstar_pcb_archive_loader.cpp.

References _, BOARD::Add(), PCB_GROUP::AddItem(), CADSTAR_ARCHIVE_PARSER::GROUP::Fixed, CADSTAR_ARCHIVE_PARSER::GROUP::GroupID, CADSTAR_PCB_ARCHIVE_PARSER::LAYOUT::Groups, CADSTAR_ARCHIVE_PARSER::GROUP::ID, CADSTAR_PCB_ARCHIVE_PARSER::Layout, m_board, m_groupMap, CADSTAR_ARCHIVE_PARSER::GROUP::Name, PCB_GROUP::SetLocked(), PCB_GROUP::SetName(), and THROW_IO_ERROR.

Referenced by Load().

◆ LoadLibrary()

std::vector< std::unique_ptr< FOOTPRINT > > CADSTAR_PCB_ARCHIVE_LOADER::LoadLibrary ( )

Parse a CADSTAR PCB Archive and load the footprints contained within.

Returns: Container with all the footprint definitions that were loaded (caller owns them)

Definition at line 186 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_ARCHIVE_PARSER::BOARD, loadBoardStackup(), loadComponentLibrary(), m_board, m_designCenter, m_libraryMap, CADSTAR_ARCHIVE_PARSER::m_progressReporter, m_project, CADSTAR_PCB_ARCHIVE_PARSER::Parse(), remapUnsureLayers(), and PROGRESS_REPORTER::SetNumPhases().

Referenced by CADSTAR_PCB_ARCHIVE_PLUGIN::ensureLoadedLibrary().

◆ loadLibraryAreas()

void CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryAreas	(	const SYMDEF_PCB &	aComponent,
		FOOTPRINT *	aFootprint
	)

private

◆ loadLibraryCoppers()

void CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers	(	const SYMDEF_PCB &	aComponent,
		FOOTPRINT *	aFootprint
	)

private

Definition at line 847 of file cadstar_pcb_archive_loader.cpp.

Referenced by loadComponentLibrary().

◆ loadLibraryFigures()

void CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryFigures	(	const SYMDEF_PCB &	aComponent,
		FOOTPRINT *	aFootprint
	)

private

Definition at line 829 of file cadstar_pcb_archive_loader.cpp.

References CADSTAR_ARCHIVE_PARSER::SYMDEF::Alternate, drawCadstarShape(), CADSTAR_ARCHIVE_PARSER::SYMDEF::Figures, getKiCadLayer(), getLineThickness(), CADSTAR_ARCHIVE_PARSER::FIGURE::ID, CADSTAR_ARCHIVE_PARSER::FIGURE::LayerID, CADSTAR_ARCHIVE_PARSER::FIGURE::LineCodeID, CADSTAR_ARCHIVE_PARSER::SYMDEF::ReferenceName, and CADSTAR_ARCHIVE_PARSER::FIGURE::Shape.

Referenced by loadComponentLibrary().

◆ loadLibraryPads()

void CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryPads	(	const SYMDEF_PCB &	aComponent,
		FOOTPRINT *	aFootprint
	)

private

Definition at line 984 of file cadstar_pcb_archive_loader.cpp.

References FOOTPRINT::Add(), CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::ComponentPads, getKiCadPad(), and pad.

Referenced by loadComponentLibrary().

◆ loadNets()

void CADSTAR_PCB_ARCHIVE_LOADER::loadNets ( )

private

◆ loadNetTracks()

void CADSTAR_PCB_ARCHIVE_LOADER::loadNetTracks	(	const NET_ID &	aCadstarNetID,
		const NET_PCB::ROUTE &	aCadstarRoute,
		long	aStartWidth = `std::numeric_limits<long>::max()`,
		long	aEndWidth = `std::numeric_limits<long>::max()`
	)

private

Definition at line 2490 of file cadstar_pcb_archive_loader.cpp.

References _, getKiCadLayer(), getKiCadLength(), getKiCadNet(), getShapeFromVertex(), m_board, m_doneTearDropWarning, makeTracksFromShapes(), PCB_SHAPE::SetLayer(), BOARD_ITEM::SetLocked(), and PCB_SHAPE::SetStroke().

Referenced by loadNets().

◆ loadNetVia()

int CADSTAR_PCB_ARCHIVE_LOADER::loadNetVia	(	const NET_ID &	aCadstarNetID,
		const NET_PCB::VIA &	aCadstarVia
	)

private

Load via and return via size.

todo add netcode to the via

Definition at line 2547 of file cadstar_pcb_archive_loader.cpp.

Referenced by loadNets().

◆ loadTemplates()

void CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates ( )

private

Definition at line 1895 of file cadstar_pcb_archive_loader.cpp.

Referenced by Load().

◆ loadTexts()

void CADSTAR_PCB_ARCHIVE_LOADER::loadTexts ( )

private

Definition at line 1423 of file cadstar_pcb_archive_loader.cpp.

References drawCadstarText(), CADSTAR_PCB_ARCHIVE_PARSER::Layout, m_board, and CADSTAR_PCB_ARCHIVE_PARSER::LAYOUT::Texts.

Referenced by Load().

◆ loadTextVariables()

void CADSTAR_PCB_ARCHIVE_LOADER::loadTextVariables ( )

private

◆ logBoardStackupMessage()

void CADSTAR_PCB_ARCHIVE_LOADER::logBoardStackupMessage	(	const wxString &	aCadstarLayerName,
		const PCB_LAYER_ID &	aKiCadLayer
	)

private

Definition at line 247 of file cadstar_pcb_archive_loader.cpp.

References _, m_logLayerWarnings, and LSET::Name().

Referenced by loadBoardStackup().

◆ logBoardStackupWarning()

void CADSTAR_PCB_ARCHIVE_LOADER::logBoardStackupWarning	(	const wxString &	aCadstarLayerName,
		const PCB_LAYER_ID &	aKiCadLayer
	)

private

Definition at line 234 of file cadstar_pcb_archive_loader.cpp.

References _, m_logLayerWarnings, and LSET::Name().

Referenced by loadBoardStackup().

◆ makeTracksFromShapes()

std::vector< PCB_TRACK * > CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes	(	const std::vector< PCB_SHAPE * > &	aShapes,
		BOARD_ITEM_CONTAINER *	aParentContainer,
		NETINFO_ITEM *	aNet = `nullptr`,
		PCB_LAYER_ID	aLayerOverride = `UNDEFINED_LAYER`,
		int	aWidthOverride = `-1`
	)

private

Returns a vector of pointers to TRACK/ARC objects.

Caller owns the objects

Parameters

aShapes
aParentContainer	sets this as the parent of each TRACK object and Add()s it to the parent
aNet	sets all the tracks to this net, unless nullptr
aLayerOverride	Sets all tracks to this layer, or, if it is UNDEFINED_LAYER, uses the layers in the shapes
aWidthOverride	Sets all tracks to this width, or, if it is UNDEFINED_LAYER, uses the width in the shapes

Returns

Definition at line 3104 of file cadstar_pcb_archive_loader.cpp.

References BOARD_ITEM_CONTAINER::Add(), applyRouteOffset(), PCB_TRACK::GetEnd(), BOARD_ITEM::GetLayer(), BOARD_CONNECTED_ITEM::GetNet(), PCB_TRACK::GetStart(), PCB_TRACK::GetWidth(), BOARD_ITEM::IsLocked(), SHAPE_ARC::Reverse(), PCB_TRACK::SetEnd(), BOARD_ITEM::SetLayer(), BOARD_ITEM::SetLocked(), BOARD_CONNECTED_ITEM::SetNet(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_TRACK::SetStart(), and PCB_TRACK::SetWidth().

Referenced by loadCoppers(), and loadNetTracks().

◆ Parse()

void CADSTAR_PCB_ARCHIVE_PARSER::Parse ( bool aLibrary = false )

inherited

Parses the file.

Exceptions

IO_ERROR if file could not be opened or there was an error while parsing

Definition at line 33 of file cadstar_pcb_archive_parser.cpp.

Referenced by Load(), and LoadLibrary().

◆ ParseAlignment()

CADSTAR_ARCHIVE_PARSER::ALIGNMENT CADSTAR_ARCHIVE_PARSER::ParseAlignment ( XNODE * aNode )

staticinherited

Definition at line 1050 of file cadstar_archive_parser.cpp.

References CADSTAR_ARCHIVE_PARSER::BOTTOMCENTER, CADSTAR_ARCHIVE_PARSER::BOTTOMLEFT, CADSTAR_ARCHIVE_PARSER::BOTTOMRIGHT, CADSTAR_ARCHIVE_PARSER::CENTERCENTER, CADSTAR_ARCHIVE_PARSER::CENTERLEFT, CADSTAR_ARCHIVE_PARSER::CENTERRIGHT, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), CADSTAR_ARCHIVE_PARSER::NO_ALIGNMENT, THROW_UNKNOWN_PARAMETER_IO_ERROR, CADSTAR_ARCHIVE_PARSER::TOPCENTER, CADSTAR_ARCHIVE_PARSER::TOPLEFT, and CADSTAR_ARCHIVE_PARSER::TOPRIGHT.

Referenced by CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::Parse(), CADSTAR_ARCHIVE_PARSER::TEXT::Parse(), and CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::ParseSubNode().

◆ ParseAllChildCutouts()

std::vector< CADSTAR_ARCHIVE_PARSER::CUTOUT > CADSTAR_ARCHIVE_PARSER::ParseAllChildCutouts	(	XNODE *	aNode,
		PARSER_CONTEXT *	aContext,
		bool	aTestAllChildNodes = `false`
	)

staticinherited

if no children are present, it just returns an empty vector (without throwing an exception)

Parameters

aNode	containing a series of CUTOUT objects
aTestAllChildNodes
aExpectedNumPoints	if -1, this is check is disabled

Returns: std::vector containing all CUTOUT objects

Exceptions

IO_ERROR

if one of the following:

Unable to parse a CUTOUT object
aTestAllChildNodes is true and one of the child nodes is not a valid CUTOUT object

Definition at line 2710 of file cadstar_archive_parser.cpp.

References XNODE::GetChildren(), XNODE::GetNext(), CADSTAR_ARCHIVE_PARSER::CUTOUT::Parse(), and THROW_UNKNOWN_NODE_IO_ERROR.

Referenced by CADSTAR_ARCHIVE_PARSER::SHAPE::Parse().

◆ ParseAllChildPoints()

std::vector< CADSTAR_ARCHIVE_PARSER::POINT > CADSTAR_ARCHIVE_PARSER::ParseAllChildPoints	(	XNODE *	aNode,
		PARSER_CONTEXT *	aContext,
		bool	aTestAllChildNodes = `false`,
		int	aExpectedNumPoints = `UNDEFINED_VALUE`
	)

staticinherited

if no children are present, it just returns an empty vector (without throwing an exception)

Parameters

aNode	containing a series of POINT objects
aTestAllChildNodes
aExpectedNumPoints	if UNDEFINED_VALUE (i.e. -1), this is check is disabled

Returns: std::vector containing all POINT objects

Exceptions

IO_ERROR

if one of the following:

Unable to parse a POINT object
aTestAllChildNodes is true and one of the child nodes is not a valid POINT object
aExpectedNumPoints is non-negative and the number of POINT objects found is different

Definition at line 2650 of file cadstar_archive_parser.cpp.

References _, XNODE::GetChildren(), XNODE::GetNext(), CADSTAR_ARCHIVE_PARSER::POINT::Parse(), THROW_IO_ERROR, THROW_UNKNOWN_NODE_IO_ERROR, and CADSTAR_ARCHIVE_PARSER::UNDEFINED_VALUE.

Referenced by CADSTAR_ARCHIVE_PARSER::VERTEX::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::NET_SCH::CONNECTION_SCH::Parse(), and CADSTAR_ARCHIVE_PARSER::SETTINGS::ParseSubNode().

◆ ParseAllChildVertices()

std::vector< CADSTAR_ARCHIVE_PARSER::VERTEX > CADSTAR_ARCHIVE_PARSER::ParseAllChildVertices	(	XNODE *	aNode,
		PARSER_CONTEXT *	aContext,
		bool	aTestAllChildNodes = `false`
	)

staticinherited

if no children are present, it just returns an empty vector (without throwing an exception)

Parameters

aNode	containing a series of VERTEX objects
aTestAllChildNodes
aExpectedNumPoints	if -1, this is check is disabled

Returns: std::vector containing all VERTEX objects

Exceptions

IO_ERROR

if one of the following:

Unable to parse a VERTEX object
aTestAllChildNodes is true and one of the child nodes is not a valid VERTEX object

Definition at line 2684 of file cadstar_archive_parser.cpp.

References XNODE::GetChildren(), XNODE::GetNext(), CADSTAR_ARCHIVE_PARSER::VERTEX::IsVertex(), CADSTAR_ARCHIVE_PARSER::VERTEX::Parse(), and THROW_UNKNOWN_NODE_IO_ERROR.

Referenced by CADSTAR_ARCHIVE_PARSER::CUTOUT::Parse(), and CADSTAR_ARCHIVE_PARSER::SHAPE::Parse().

◆ ParseAngunits()

CADSTAR_ARCHIVE_PARSER::ANGUNITS CADSTAR_ARCHIVE_PARSER::ParseAngunits ( XNODE * aNode )

staticinherited

Definition at line 681 of file cadstar_archive_parser.cpp.

References CADSTAR_ARCHIVE_PARSER::DEGREES, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), CADSTAR_ARCHIVE_PARSER::RADIANS, and THROW_UNKNOWN_PARAMETER_IO_ERROR.

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

◆ ParseChildEValue()

void CADSTAR_ARCHIVE_PARSER::ParseChildEValue	(	XNODE *	aNode,
		PARSER_CONTEXT *	aContext,
		EVALUE &	aValueToParse
	)

staticinherited

Parameters

aNode	with a child node containing an EVALUE
aValueToParse

Exceptions

IO_ERROR if unable to parse or node is not an EVALUE

Definition at line 2640 of file cadstar_archive_parser.cpp.

References XNODE::GetChildren(), CADSTAR_ARCHIVE_PARSER::EVALUE::Parse(), and THROW_UNKNOWN_NODE_IO_ERROR.

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

◆ ParseJustification()

CADSTAR_ARCHIVE_PARSER::JUSTIFICATION CADSTAR_ARCHIVE_PARSER::ParseJustification ( XNODE * aNode )

staticinherited

Definition at line 1082 of file cadstar_archive_parser.cpp.

References CADSTAR_ARCHIVE_PARSER::CENTER, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), CADSTAR_ARCHIVE_PARSER::LEFT, CADSTAR_ARCHIVE_PARSER::RIGHT, and THROW_UNKNOWN_PARAMETER_IO_ERROR.

Referenced by CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::Parse(), CADSTAR_ARCHIVE_PARSER::TEXT::Parse(), and CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::ParseSubNode().

◆ ParseReadability()

CADSTAR_ARCHIVE_PARSER::READABILITY CADSTAR_ARCHIVE_PARSER::ParseReadability ( XNODE * aNode )

staticinherited

Definition at line 1101 of file cadstar_archive_parser.cpp.

References CADSTAR_ARCHIVE_PARSER::BOTTOM_TO_TOP, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), THROW_UNKNOWN_PARAMETER_IO_ERROR, and CADSTAR_ARCHIVE_PARSER::TOP_TO_BOTTOM.

Referenced by CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMBOL::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::DRILL_TABLE::Parse().

◆ ParseSwapRule()

CADSTAR_ARCHIVE_PARSER::SWAP_RULE CADSTAR_ARCHIVE_PARSER::ParseSwapRule ( XNODE * aNode )

staticinherited

Definition at line 1513 of file cadstar_archive_parser.cpp.

References CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), CADSTAR_ARCHIVE_PARSER::NO_SWAP, THROW_UNKNOWN_PARAMETER_IO_ERROR, and CADSTAR_ARCHIVE_PARSER::USE_SWAP_LAYER.

Referenced by CADSTAR_ARCHIVE_PARSER::FIGURE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_COPPER::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_AREA::Parse(), and CADSTAR_ARCHIVE_PARSER::TEXT::Parse().

◆ ParseTestlandSide()

CADSTAR_PCB_ARCHIVE_PARSER::TESTLAND_SIDE CADSTAR_PCB_ARCHIVE_PARSER::ParseTestlandSide ( XNODE * aNode )

staticinherited

Definition at line 1937 of file cadstar_pcb_archive_parser.cpp.

References CADSTAR_PCB_ARCHIVE_PARSER::BOTH, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), CADSTAR_PCB_ARCHIVE_PARSER::MAX, CADSTAR_PCB_ARCHIVE_PARSER::MIN, CADSTAR_PCB_ARCHIVE_PARSER::NONE, and THROW_UNKNOWN_PARAMETER_IO_ERROR.

Referenced by CADSTAR_PCB_ARCHIVE_PARSER::PIN_ATTRIBUTE::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::NET_PCB::VIA::Parse().

◆ ParseTextFields()

wxString CADSTAR_ARCHIVE_PARSER::ParseTextFields	(	const wxString &	aTextString,
		PARSER_CONTEXT *	aParserContext
	)

staticinherited

Replaces CADSTAR fields for the equivalent in KiCad and stores the field values in aParserContext.

Parameters

aTextString	Text string to parse
aParserContext	PARSER_CONTEXT in which to store the values of the found fields

Returns

Definition at line 856 of file cadstar_archive_parser.cpp.

Referenced by applyDimensionSettings(), loadDimensions(), CADSTAR_ARCHIVE_PARSER::TEXT::Parse(), and CADSTAR_ARCHIVE_PARSER::ParseTextFields().

◆ ParseUnits()

CADSTAR_ARCHIVE_PARSER::UNITS CADSTAR_ARCHIVE_PARSER::ParseUnits ( XNODE * aNode )

staticinherited

Definition at line 654 of file cadstar_archive_parser.cpp.

References CADSTAR_ARCHIVE_PARSER::CENTIMETER, CADSTAR_ARCHIVE_PARSER::DESIGN, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), CADSTAR_ARCHIVE_PARSER::INCH, CADSTAR_ARCHIVE_PARSER::METER, CADSTAR_ARCHIVE_PARSER::MICROMETRE, CADSTAR_ARCHIVE_PARSER::MM, CADSTAR_ARCHIVE_PARSER::THOU, and THROW_UNKNOWN_PARAMETER_IO_ERROR.

Referenced by CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::Parse(), and CADSTAR_ARCHIVE_PARSER::SETTINGS::ParseSubNode().

◆ remapUnsureLayers()

void CADSTAR_PCB_ARCHIVE_LOADER::remapUnsureLayers ( )

private

Callback m_layerMappingHandler for layers we aren't sure of.

Definition at line 686 of file cadstar_pcb_archive_loader.cpp.

Referenced by Load(), and LoadLibrary().

Member Data Documentation

◆ Assignments

ASSIGNMENTS CADSTAR_PCB_ARCHIVE_PARSER::Assignments

inherited

◆ CADSTAR_TO_KICAD_FIELDS

const std::map< CADSTAR_ARCHIVE_PARSER::TEXT_FIELD_NAME, wxString > CADSTAR_ARCHIVE_PARSER::CADSTAR_TO_KICAD_FIELDS

staticinherited

Initial value:

=
 { { TEXT_FIELD_NAME::DESIGN_TITLE, wxT( "DESIGN_TITLE" ) },
 { TEXT_FIELD_NAME::SHORT_JOBNAME, wxT( "SHORT_JOBNAME" ) },
 { TEXT_FIELD_NAME::LONG_JOBNAME, wxT( "LONG_JOBNAME" ) },
 { TEXT_FIELD_NAME::NUM_OF_SHEETS, wxT( "##" ) },
 { TEXT_FIELD_NAME::SHEET_NUMBER, wxT( "#" ) },
 { TEXT_FIELD_NAME::SHEET_NAME, wxT( "SHEETNAME" ) },
 { TEXT_FIELD_NAME::VARIANT_NAME, wxT( "VARIANT_NAME" ) },
 { TEXT_FIELD_NAME::VARIANT_DESCRIPTION, wxT( "VARIANT_DESCRIPTION" ) },
 { TEXT_FIELD_NAME::REG_USER, wxT( "REG_USER" ) },
 { TEXT_FIELD_NAME::COMPANY_NAME, wxT( "COMPANY_NAME" ) },
 { TEXT_FIELD_NAME::CURRENT_USER, wxT( "CURRENT_USER" ) },
 { TEXT_FIELD_NAME::DATE, wxT( "DATE" ) },
 { TEXT_FIELD_NAME::TIME, wxT( "TIME" ) },
 { TEXT_FIELD_NAME::MACHINE_NAME, wxT( "MACHINE_NAME" ) } }

Map between CADSTAR fields and KiCad text variables.

This is used as a lookup table when parsing CADSTAR text fields. Most variables have a similar name in KiCad as in CADSTAR.

Definition at line 172 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), loadTextVariables(), and CADSTAR_ARCHIVE_PARSER::ParseTextFields().

◆ Filename

wxString CADSTAR_PCB_ARCHIVE_PARSER::Filename

inherited

Definition at line 1216 of file cadstar_pcb_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ FONT_BOLD

const long CADSTAR_ARCHIVE_PARSER::FONT_BOLD = 700

staticinherited

Definition at line 330 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists().

◆ FONT_NORMAL

const long CADSTAR_ARCHIVE_PARSER::FONT_NORMAL = 400

staticinherited

Definition at line 329 of file cadstar_archive_parser.h.

◆ Header

HEADER CADSTAR_PCB_ARCHIVE_PARSER::Header

inherited

Definition at line 1218 of file cadstar_pcb_archive_parser.h.

Referenced by getAngle(), getAngleTenthDegree(), loadTextVariables(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ KiCadUnitMultiplier

int CADSTAR_PCB_ARCHIVE_PARSER::KiCadUnitMultiplier

inherited

Use this value to convert units in this CPA file to KiCad units.

Definition at line 1224 of file cadstar_pcb_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_PARSER::CADSTAR_PCB_ARCHIVE_PARSER(), getKiCadLength(), getKiCadPoint(), Load(), loadNets(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ Layout

LAYOUT CADSTAR_PCB_ARCHIVE_PARSER::Layout

inherited

Definition at line 1222 of file cadstar_pcb_archive_parser.h.

Referenced by calculateZonePriorities(), getKiCadNet(), Load(), loadAreas(), loadBoards(), loadComponents(), loadCoppers(), loadDimensions(), loadDocumentationSymbols(), loadFigures(), loadGroups(), loadNets(), loadTemplates(), loadTexts(), loadTextVariables(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ Library

LIBRARY CADSTAR_PCB_ARCHIVE_PARSER::Library

inherited

Definition at line 1220 of file cadstar_pcb_archive_parser.h.

Referenced by loadComponentLibrary(), loadComponents(), loadDocumentationSymbols(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ m_board

BOARD* CADSTAR_PCB_ARCHIVE_LOADER::m_board

private

◆ m_componentMap

std::map<COMPONENT_ID, FOOTPRINT*> CADSTAR_PCB_ARCHIVE_LOADER::m_componentMap

private

Map between Cadstar and KiCad components on the board.

Does NOT own the FOOTPRINT objects (these should have been loaded to m_board).

Definition at line 111 of file cadstar_pcb_archive_loader.h.

Referenced by getFootprintFromCadstarID(), and loadComponents().

◆ m_context

PARSER_CONTEXT CADSTAR_ARCHIVE_PARSER::m_context

protectedinherited

Definition at line 1434 of file cadstar_archive_parser.h.

Referenced by applyDimensionSettings(), loadDimensions(), CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), loadTextVariables(), CADSTAR_SCH_ARCHIVE_PARSER::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ m_designCenter

VECTOR2I CADSTAR_PCB_ARCHIVE_LOADER::m_designCenter

private

Used for calculating the required offset to apply to the Cadstar design so that it fits in KiCad canvas.

Definition at line 134 of file cadstar_pcb_archive_loader.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER(), getKiCadPoint(), Load(), loadComponents(), and LoadLibrary().

◆ m_doneCopperWarning

bool CADSTAR_PCB_ARCHIVE_LOADER::m_doneCopperWarning

private

Used by loadCoppers() to avoid multiple duplicate warnings.

Definition at line 141 of file cadstar_pcb_archive_loader.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER(), and loadCoppers().

◆ m_doneNetClassWarning

bool CADSTAR_PCB_ARCHIVE_LOADER::m_doneNetClassWarning

private

Used by getKiCadNet() to avoid multiple duplicate warnings.

Definition at line 145 of file cadstar_pcb_archive_loader.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER(), and getKiCadNet().

◆ m_doneSpacingClassWarning

bool CADSTAR_PCB_ARCHIVE_LOADER::m_doneSpacingClassWarning

private

Used by getKiCadNet() to avoid multiple duplicate warnings.

Definition at line 143 of file cadstar_pcb_archive_loader.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER(), and getKiCadNet().

◆ m_doneTearDropWarning

bool CADSTAR_PCB_ARCHIVE_LOADER::m_doneTearDropWarning

private

Definition at line 147 of file cadstar_pcb_archive_loader.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER(), and loadNetTracks().

◆ m_groupMap

std::map<GROUP_ID, PCB_GROUP*> CADSTAR_PCB_ARCHIVE_LOADER::m_groupMap

private

Map between Cadstar and KiCad groups.

Does NOT ownthe PCB_GROUP objects (these should have been loaded to m_board).

Definition at line 107 of file cadstar_pcb_archive_loader.h.

Referenced by addToGroup(), createUniqueGroupID(), getKiCadGroup(), and loadGroups().

◆ m_hatchcodesTested

std::set<HATCHCODE_ID> CADSTAR_PCB_ARCHIVE_LOADER::m_hatchcodesTested

private

Used by checkAndLogHatchCode() to avoid multiple duplicate warnings.

Definition at line 137 of file cadstar_pcb_archive_loader.h.

Referenced by checkAndLogHatchCode().

◆ m_layermap

std::map<LAYER_ID, PCB_LAYER_ID> CADSTAR_PCB_ARCHIVE_LOADER::m_layermap

private

Map between Cadstar and KiCad Layers.

Populated by loadBoardStackup().

Definition at line 101 of file cadstar_pcb_archive_loader.h.

Referenced by getKiCadLayer(), loadBoardStackup(), and remapUnsureLayers().

◆ m_layerMappingHandler

LAYER_MAPPING_HANDLER CADSTAR_PCB_ARCHIVE_LOADER::m_layerMappingHandler

private

Callback to get layer mapping.

Definition at line 97 of file cadstar_pcb_archive_loader.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER(), and remapUnsureLayers().

◆ m_librarycopperpads

std::map<SYMDEF_ID, ASSOCIATED_COPPER_PADS> CADSTAR_PCB_ARCHIVE_LOADER::m_librarycopperpads

private

Associated copper pads (if any) for each component library definition.

Definition at line 125 of file cadstar_pcb_archive_loader.h.

Referenced by loadLibraryCoppers(), and loadNets().

◆ m_libraryMap

std::map<SYMDEF_ID, FOOTPRINT*> CADSTAR_PCB_ARCHIVE_LOADER::m_libraryMap

private

Map between Cadstar and KiCad components in the library.

Populated by loadComponentLibrary(). Owns the FOOTPRINT objects.

Definition at line 103 of file cadstar_pcb_archive_loader.h.

Referenced by GetLoadedLibraryFootpints(), loadComponentLibrary(), loadComponents(), LoadLibrary(), and ~CADSTAR_PCB_ARCHIVE_LOADER().

◆ m_logLayerWarnings

bool CADSTAR_PCB_ARCHIVE_LOADER::m_logLayerWarnings

private

Used in loadBoardStackup()

Definition at line 98 of file cadstar_pcb_archive_loader.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER(), logBoardStackupMessage(), and logBoardStackupWarning().

◆ m_netClassMap

std::map<std::tuple<ROUTECODE_ID, NETCLASS_ID, SPACING_CLASS_ID>, std::shared_ptr<NETCLASS> > CADSTAR_PCB_ARCHIVE_LOADER::m_netClassMap

private

Map between Cadstar and KiCad classes.

Definition at line 129 of file cadstar_pcb_archive_loader.h.

Referenced by getKiCadNet().

◆ m_netMap

std::map<NET_ID, NETINFO_ITEM*> CADSTAR_PCB_ARCHIVE_LOADER::m_netMap

private

Map between Cadstar and KiCad Nets.

Definition at line 127 of file cadstar_pcb_archive_loader.h.

Referenced by getKiCadNet().

◆ m_numCopperLayers

int CADSTAR_PCB_ARCHIVE_LOADER::m_numCopperLayers

private

Number of layers in the design.

Definition at line 149 of file cadstar_pcb_archive_loader.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER(), getKiCadCopperLayerID(), getKiCadLayerSet(), Load(), and loadBoardStackup().

◆ m_numNets

int CADSTAR_PCB_ARCHIVE_LOADER::m_numNets

private

Number of nets loaded so far.

Definition at line 148 of file cadstar_pcb_archive_loader.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER(), and getKiCadNet().

◆ m_padcodesTested

std::set<PADCODE_ID> CADSTAR_PCB_ARCHIVE_LOADER::m_padcodesTested

private

Used by getKiCadPad() to avoid multiple duplicate warnings.

Definition at line 139 of file cadstar_pcb_archive_loader.h.

Referenced by getKiCadPad().

◆ m_powerPlaneLayers

std::vector<LAYER_ID> CADSTAR_PCB_ARCHIVE_LOADER::m_powerPlaneLayers

private

List of layers that are marked as power plane in CADSTAR.

This is used by "loadtemplates"

Definition at line 131 of file cadstar_pcb_archive_loader.h.

Referenced by loadBoardStackup(), and loadTemplates().

◆ m_progressReporter

PROGRESS_REPORTER* CADSTAR_ARCHIVE_PARSER::m_progressReporter

protectedinherited

Definition at line 1435 of file cadstar_archive_parser.h.

Referenced by CADSTAR_ARCHIVE_PARSER::CADSTAR_ARCHIVE_PARSER(), CADSTAR_PCB_ARCHIVE_LOADER(), CADSTAR_SCH_ARCHIVE_LOADER::CADSTAR_SCH_ARCHIVE_LOADER(), CADSTAR_ARCHIVE_PARSER::checkPoint(), Load(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), LoadLibrary(), CADSTAR_SCH_ARCHIVE_LOADER::LoadPartsLib(), CADSTAR_SCH_ARCHIVE_PARSER::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ m_project

PROJECT* CADSTAR_PCB_ARCHIVE_LOADER::m_project

private

Definition at line 100 of file cadstar_pcb_archive_loader.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER(), Load(), LoadLibrary(), and loadTextVariables().

◆ m_rootNode

XNODE* CADSTAR_PCB_ARCHIVE_PARSER::m_rootNode

privateinherited

Definition at line 1227 of file cadstar_pcb_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_PARSER::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::~CADSTAR_PCB_ARCHIVE_PARSER().

◆ m_zonesMap

std::map<TEMPLATE_ID, ZONE*> CADSTAR_PCB_ARCHIVE_LOADER::m_zonesMap

private

Map between Cadstar and KiCad zones.

Definition at line 130 of file cadstar_pcb_archive_loader.h.

Referenced by calculateZonePriorities(), loadCoppers(), and loadTemplates().

◆ Parts

PARTS CADSTAR_PCB_ARCHIVE_PARSER::Parts

inherited

Definition at line 1221 of file cadstar_pcb_archive_parser.h.

Referenced by getPart(), loadComponents(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ TXT_HEIGHT_RATIO

const double CADSTAR_ARCHIVE_PARSER::TXT_HEIGHT_RATIO = ( 24.0 - 5.0 ) / 24.0

staticinherited

CADSTAR fonts are drawn on a 24x24 integer matrix, where the each axis goes from 0 to 24.

The characters can each specify a width of between 12 and 24, but the height is fixed at 24.

The default CADSTAR font uses y=5 as the starting point for capital letters, leaving space for the tails of letters such as "g", "p", "y", "q", etc.

The font height in CADSTAR corresponds to the full 24 point height. In KiCad it only corresponds to the height above the guide line, meaning the overall text height will be larger in KiCad.

Definition at line 137 of file cadstar_archive_parser.h.

Referenced by applyTextCode(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists(), and CADSTAR_SCH_ARCHIVE_LOADER::getTextHeightFromTextCode().

◆ UNDEFINED_VALUE

const long CADSTAR_ARCHIVE_PARSER::UNDEFINED_VALUE = -1

staticinherited

Definition at line 124 of file cadstar_archive_parser.h.

Referenced by getKiCadPad(), CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDLong(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolGateAndPartFields(), loadTemplates(), CADSTAR_ARCHIVE_PARSER::VERTEX::Parse(), CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::Parse(), CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::PIN_NUM_LABEL_LOC::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMDEF_SCM::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SIGNALREFERENCELINK::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SIGLOC::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::TEMPLATE::POURING::Parse(), and CADSTAR_ARCHIVE_PARSER::ParseAllChildPoints().

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

Enumerator
NO_ALIGNMENT	NO_ALIGNMENT has different meaning depending on the object type.
TOPLEFT
TOPCENTER
TOPRIGHT
CENTERLEFT
CENTERCENTER
CENTERRIGHT
BOTTOMLEFT
BOTTOMCENTER
BOTTOMRIGHT

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ AREA_ID

◆ ASSOCIATED_COPPER_PADS

◆ ATTRIBUTE_ID

◆ BOARD_ID

◆ COLOR_ID

◆ COMP_AREA_ID

◆ COMPONENT_ID

◆ COPPER_ID

◆ COPPER_TERM_ID

◆ COPPERCODE_ID

◆ DIMENSION_ID

◆ DOCUMENTATION_SYMBOL_ID

◆ DRILL_TABLE_ID

◆ FIGURE_ID

◆ GATE_ID

◆ GROUP_ID

◆ HATCHCODE_ID

◆ LAYER_ID

◆ LAYERPAIR_ID

◆ LINECODE_ID

◆ MATERIAL_ID

◆ NET_ID

◆ NETCLASS_ID

◆ NETELEMENT_ID

◆ PAD_ID

◆ PADCODE_ID

◆ PART_DEFINITION_PIN_ID

◆ PART_ID

◆ PART_PIN_ID

◆ PHYSICAL_LAYER_ID

◆ REUSEBLOCK_ID

◆ ROUTECODE_ID

◆ RULESET_ID

◆ SPACING_CLASS_ID

◆ SPACINGCODE_ID

◆ SYMDEF_ID

◆ TEMPLATE_ID

◆ TERMINAL_ID

◆ TEXT_ID

◆ TEXTCODE_ID

◆ TRUNK_ID

◆ VARIANT_ID

◆ VIACODE_ID

Member Enumeration Documentation

◆ ALIGNMENT

◆ ANGUNITS

◆ ATTROWNER

◆ ATTRUSAGE

◆ EMBEDDING

◆ GRID_TYPE

◆ JUSTIFICATION

◆ LAYER_SUBTYPE

◆ LAYER_TYPE

◆ LINESTYLE

◆ MATERIAL_LAYER_TYPE

◆ NETSYNCH

◆ PAD_SHAPE_TYPE

◆ PAD_SIDE

◆ READABILITY

◆ RESOLUTION

◆ ROUTING_BIAS

◆ SHAPE_TYPE

◆ SWAP_RULE

◆ SYMDEF_TYPE

◆ TESTLAND_SIDE

◆ TEXT_FIELD_NAME

◆ UNITS

◆ VERTEX_TYPE