This source file implements export and import capabilities to the specctra dsn file format. More...

Classes
class	ANCESTOR

class	BOUNDARY

class	CIRCLE

class	CLASS
	The <class_descriptor> in the specctra spec. More...

class	CLASS_CLASS

class	CLASSES

class	COMP_ORDER
	The <component_order_descriptor>. More...

class	COMPONENT
	Implement a <component_descriptor> in the specctra dsn spec. More...

class	CONNECT

class	CONTROL

class	COPPER_PLANE
	A <plane_descriptor> in the specctra dsn spec. More...

class	ELEM
	A base class for any DSN element class. More...

class	ELEM_HOLDER
	A holder for any DSN class. More...

class	FROMTO

class	GRID

class	HISTORY

class	IMAGE

class	KEEPOUT
	Used for <keepout_descriptor> and <plane_descriptor>. More...

class	LAYER

class	LAYER_NOISE_WEIGHT

class	LAYER_RULE

class	LIBRARY
	A <library_descriptor> in the specctra dsn specification. More...

class	NET
	A <net_descriptor> in the DSN spec. More...

class	NET_OUT
	A <net_out_descriptor> of the specctra dsn spec. More...

class	NETWORK

class	PADSTACK
	Hold either a via or a pad definition. More...

class	PARSER
	A configuration record per the SPECCTRA DSN file spec. More...

class	PATH
	Support both the <path_descriptor> and the <polygon_descriptor> per the specctra dsn spec. More...

class	PCB

class	PIN

struct	PIN_PAIR
	Used within the WAS_IS class below to hold a pair of PIN_REFs and corresponds to the (pins was is) construct within the specctra dsn spec. More...

struct	PIN_REF
	A <pin_reference> definition in the specctra dsn spec. More...

class	PLACE
	Implement a <placement_reference> in the specctra dsn spec. More...

class	PLACEMENT

struct	POINT
	A point in the SPECCTRA DSN coordinate system. More...

struct	PROPERTY

class	QARC

class	RECTANGLE

class	REGION

class	ROUTE

class	RULE
	A <rule_descriptor> in the specctra dsn spec. More...

class	SESSION
	A <session_file_descriptor> in the specctra dsn spec. More...

class	SHAPE
	A "(shape ..)" element in the specctra dsn spec. More...

class	SPECCTRA_DB
	A DSN data tree, usually coming from a DSN file. More...

class	SPECCTRA_LAYER_PAIR

class	STRINGPROP
	A container for a single property whose value is a string. More...

class	STRUCTURE

class	STRUCTURE_OUT

class	SUPPLY_PIN
	A <supply_pin_descriptor> in the specctra dsn spec. More...

class	TOKPROP
	A container for a single property whose value is another DSN_T token. More...

class	TOPOLOGY

class	UNIT_RES
	A holder for either a T_unit or T_resolution object which are usually mutually exclusive in the dsn grammar, except within the T_pcb level. More...

class	VIA
	A <via_descriptor> in the specctra dsn spec. More...

class	WAS_IS
	A <was_is_descriptor> in the specctra dsn spec. More...

class	WINDOW

class	WIRE
	A <wire_shape_descriptor> in the specctra dsn spec. More...

class	WIRE_VIA
	A <wire_via_descriptor> in the specctra dsn spec. More...

class	WIRING
	A <wiring_descriptor> in the specctra dsn spec. More...

Typedefs
typedef std::vector< PROPERTY >	PROPERTIES

typedef boost::ptr_vector< PATH >	PATHS

typedef boost::ptr_vector< SPECCTRA_LAYER_PAIR >	SPECCTRA_LAYER_PAIRS

typedef boost::ptr_vector< COPPER_PLANE >	COPPER_PLANES

typedef boost::ptr_vector< COMP_ORDER >	COMP_ORDERS

typedef boost::ptr_vector< CLASS >	CLASSLIST

typedef boost::ptr_vector< ANCESTOR >	ANCESTORS

typedef boost::ptr_set< PADSTACK >	PADSTACKSET

typedef std::map< wxString, int >	PINMAP
	data type used to ensure unique-ness of pin names, holding (wxString and int)

Functions
const char *	GetTokenText (T aTok)
	The DSN namespace and returns the C string representing a SPECCTRA_DB::keyword.

void	ExportBoardToSpecctraFile (BOARD *aBoard, const wxString &aFullFilename)
	Helper method to export board to DSN file.

bool	operator< (const PADSTACK &lhs, const PADSTACK &rhs)
	Used by the PADSTACKSET boost::ptr_set below.

bool	ImportSpecctraSession (BOARD *aBoard, const wxString &fullFileName, COMMIT &aCommit)
	Helper method to import SES file to a board.

static double	scale (int kicadDist)
	Convert a distance from Pcbnew internal units to the reported Specctra DSN units in floating point format.

static double	IU2um (int kicadDist)

static double	mapX (int x)

static double	mapY (int y)

static POINT	mapPt (const VECTOR2I &pt)
	Convert a KiCad point into a DSN file point.

static POINT	mapPt (const VECTOR2I &pt, FOOTPRINT *aFootprint)

static bool	isRoundKeepout (PAD *aPad)
	Decide if the pad is a copper-less through hole which needs to be made into a round keepout.

static PATH *	makePath (const POINT &aStart, const POINT &aEnd, const std::string &aLayerName)
	Create a PATH element with a single straight line, a pair of vertices.

static std::string	sanitizeForDSNString (const wxString &aValue)

static int	scale (double distance, UNIT_RES *aResolution)
	Function scale converts a session file distance to KiCad units of deci-mils.

static VECTOR2I	mapPt (const POINT &aPoint, UNIT_RES *aResolution)
	Function mapPt translates a point from the Specctra Session format coordinate system to the KiCad coordinate system.

Detailed Description

This source file implements export and import capabilities to the specctra dsn file format.

The grammar for that file format is documented fairly well. There are classes for each major type of descriptor in the spec.

Since there are so many classes in here, it may be helpful to generate the Doxygen directory:

$ cd &ltkicadSourceRoot&gt $ doxygen

Then you can view the html documentation in the &ltkicadSourceRoot&gt/doxygen directory. The main class in this file is SPECCTRA_DB and its main functions are LoadPCB(), LoadSESSION(), and ExportPCB().

Wide use is made of boost::ptr_vector&lt&gt and std::vector&lt&gt template classes. If the contained object is small, then std::vector tends to be used. If the contained object is large, variable size, or would require writing an assignment operator() or copy constructor, then boost::ptr_vector cannot be beat.

Typedef Documentation

◆ ANCESTORS

typedef boost::ptr_vector<ANCESTOR> DSN::ANCESTORS

Definition at line 3260 of file specctra.h.

◆ CLASSLIST

typedef boost::ptr_vector<CLASS> DSN::CLASSLIST

Definition at line 2793 of file specctra.h.

◆ COMP_ORDERS

typedef boost::ptr_vector<COMP_ORDER> DSN::COMP_ORDERS

Definition at line 2551 of file specctra.h.

◆ COPPER_PLANES

typedef boost::ptr_vector<COPPER_PLANE> DSN::COPPER_PLANES

Definition at line 1353 of file specctra.h.

◆ PADSTACKSET

typedef boost::ptr_set<PADSTACK> DSN::PADSTACKSET

Definition at line 3596 of file specctra.h.

◆ PATHS

typedef boost::ptr_vector<PATH> DSN::PATHS

Definition at line 654 of file specctra.h.

◆ PINMAP

typedef std::map<wxString, int> DSN::PINMAP

data type used to ensure unique-ness of pin names, holding (wxString and int)

Definition at line 601 of file specctra_export.cpp.

◆ PROPERTIES

typedef std::vector<PROPERTY> DSN::PROPERTIES

Definition at line 192 of file specctra.h.

◆ SPECCTRA_LAYER_PAIRS

typedef boost::ptr_vector<SPECCTRA_LAYER_PAIR> DSN::SPECCTRA_LAYER_PAIRS

Definition at line 1311 of file specctra.h.

Function Documentation

◆ ExportBoardToSpecctraFile()

void DSN::ExportBoardToSpecctraFile	(	BOARD *	aBoard,
		const wxString &	aFullFilename )

Helper method to export board to DSN file.

Parameters

aBoard	board object
aFullFilename	specctra file name

Definition at line 109 of file specctra_export.cpp.

References _, DSN::SPECCTRA_DB::BuiltBoardOutlines(), DSN::SPECCTRA_DB::ExportPCB(), DSN::SPECCTRA_DB::FlipFOOTPRINTs(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::MakePCB(), DSN::SPECCTRA_DB::RevertFOOTPRINTs(), DSN::SPECCTRA_DB::SetPCB(), and BOARD::SynchronizeNetsAndNetClasses().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PCB_EDIT_FRAME::ExportSpecctraFile().

◆ GetTokenText()

const char * DSN::GetTokenText ( T aTok )

The DSN namespace and returns the C string representing a SPECCTRA_DB::keyword.

We needed a non-instance function to get at the SPECCTRA_DB::keyword[] and class SPECCTRA_DB is not defined yet.

Definition at line 67 of file specctra.cpp.

References T.

Referenced by DSN::FROMTO::Format(), DSN::GRID::Format(), DSN::LAYER::Format(), DSN::NET::Format(), DSN::PLACE::Format(), DSN::SHAPE::Format(), DSN::TOKPROP::Format(), DSN::UNIT_RES::Format(), DSN::WIRE::Format(), DSN::WIRE_VIA::Format(), DSN::IMAGE::FormatContents(), DSN::PADSTACK::FormatContents(), DSN::PLACEMENT::FormatContents(), and DSN::SPECCTRA_DB::FromSESSION().

◆ ImportSpecctraSession()

bool DSN::ImportSpecctraSession	(	BOARD *	aBoard,
		const wxString &	fullFileName,
		COMMIT &	aCommit )

Helper method to import SES file to a board.

Stages board changes into aCommit. The caller must Push() the commit.

Parameters

aBoard	board object
fullFileName	specctra session file name
aCommit	commit for undo/redo and view updates

Definition at line 552 of file specctra_import.cpp.

References DSN::SPECCTRA_DB::FromSESSION(), and DSN::SPECCTRA_DB::LoadSESSION().

Referenced by PCB_EDIT_FRAME::ImportSpecctraSession().

◆ isRoundKeepout()

static bool DSN::isRoundKeepout ( PAD * aPad )

static

Decide if the pad is a copper-less through hole which needs to be made into a round keepout.

Definition at line 204 of file specctra_export.cpp.

References PADSTACK::ALL_LAYERS, LSET::AllCuMask(), CIRCLE, PAD::GetDrillSize(), PAD::GetLayerSet(), PAD::GetShape(), PAD::GetSize(), and VECTOR2< T >::x.

Referenced by DSN::SPECCTRA_DB::makeIMAGE(), and DSN::SPECCTRA_DB::makePADSTACK().

◆ IU2um()

static double DSN::IU2um ( int kicadDist )

inlinestatic

Definition at line 158 of file specctra_export.cpp.

References pcbIUScale.

Referenced by DSN::SPECCTRA_DB::makePADSTACK(), and DSN::SPECCTRA_DB::makeVia().

◆ makePath()

static PATH * DSN::makePath	(	const POINT &	aStart,
		const POINT &	aEnd,
		const std::string &	aLayerName )

static

Create a PATH element with a single straight line, a pair of vertices.

Definition at line 223 of file specctra_export.cpp.

References path.

Referenced by DSN::SPECCTRA_DB::makePADSTACK().

◆ mapPt() [1/3]

static VECTOR2I DSN::mapPt	(	const POINT &	aPoint,
		UNIT_RES *	aResolution )

static

Function mapPt translates a point from the Specctra Session format coordinate system to the KiCad coordinate system.

Parameters

aPoint	The session point to translate
aResolution	- The amount to scale the point.

Returns: wxPoint - The KiCad coordinate system point.

Definition at line 122 of file specctra_import.cpp.

References scale(), scale, DSN::POINT::x, and DSN::POINT::y.

◆ mapPt() [2/3]

static POINT DSN::mapPt ( const VECTOR2I & pt )

static

Convert a KiCad point into a DSN file point.

Kicad's BOARD coordinates are in nanometers (called Internal Units or IU) and we are exporting in units of mils, so we have to scale them.

Definition at line 182 of file specctra_export.cpp.

References DSN::POINT::FixNegativeZero(), mapX(), mapY(), DSN::POINT::x, VECTOR2< T >::x, DSN::POINT::y, and VECTOR2< T >::y.

Referenced by DSN::SPECCTRA_DB::fillBOUNDARY(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::FromSESSION(), DSN::SPECCTRA_DB::makeARC(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), DSN::SPECCTRA_DB::makeTRACK(), DSN::SPECCTRA_DB::makeVIA(), and mapPt().

◆ mapPt() [3/3]

static POINT DSN::mapPt	(	const VECTOR2I &	pt,
		FOOTPRINT *	aFootprint )

static

Definition at line 193 of file specctra_export.cpp.

References FOOTPRINT::GetOrientation(), FOOTPRINT::GetPosition(), mapPt(), and RotatePoint().

◆ mapX()

static double DSN::mapX ( int x )

inlinestatic

Definition at line 164 of file specctra_export.cpp.

References scale.

Referenced by mapPt().

◆ mapY()

static double DSN::mapY ( int y )

inlinestatic

Definition at line 170 of file specctra_export.cpp.

References scale.

Referenced by mapPt().

◆ operator<()

bool DSN::operator<	(	const PADSTACK &	lhs,
		const PADSTACK &	rhs )

inline

Used by the PADSTACKSET boost::ptr_set below.

Definition at line 2211 of file specctra.h.

References DSN::PADSTACK::Compare().

◆ sanitizeForDSNString()

static std::string DSN::sanitizeForDSNString ( const wxString & aValue )

static

Definition at line 1064 of file specctra_export.cpp.

References TO_UTF8.

Referenced by DSN::SPECCTRA_DB::FromBOARD().

◆ scale() [1/2]

static int DSN::scale	(	double	distance,
		UNIT_RES *	aResolution )

static

Function scale converts a session file distance to KiCad units of deci-mils.

Parameters

distance	The session file length to convert.
aResolution	The session UNIT_RES which holds the engineering unit specifier

Returns: int - The KiCad length in internal unit

Definition at line 95 of file specctra_import.cpp.

References distance(), DSN::UNIT_RES::GetEngUnits(), DSN::UNIT_RES::GetValue(), and KiROUND().

◆ scale() [2/2]

static double DSN::scale ( int kicadDist )

inlinestatic

Convert a distance from Pcbnew internal units to the reported Specctra DSN units in floating point format.

Convert integer internal units to float um

Definition at line 150 of file specctra_export.cpp.

References pcbIUScale.

Referenced by DSN::SPECCTRA_DB::makePADSTACK(), and mapPt().

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ ANCESTORS

◆ CLASSLIST

◆ COMP_ORDERS

◆ COPPER_PLANES

◆ PADSTACKSET

◆ PATHS

◆ PINMAP

◆ PROPERTIES

◆ SPECCTRA_LAYER_PAIRS

Function Documentation

◆ ExportBoardToSpecctraFile()

◆ GetTokenText()

◆ ImportSpecctraSession()

◆ isRoundKeepout()

◆ IU2um()

◆ makePath()

◆ mapPt() [1/3]

◆ mapPt() [2/3]

◆ mapPt() [3/3]

◆ mapX()

◆ mapY()

◆ operator<()

◆ sanitizeForDSNString()

◆ scale() [1/2]

◆ scale() [2/2]