KiCad PCB EDA Suite
DSN Namespace Reference

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

Classes

class  ANCESTOR
 
class  BOUNDARY
 
class  CIRCLE
 
class  CLASS
 CLASS corresponds to the <class_descriptor> in the specctra spec. More...
 
class  CLASS_CLASS
 
class  CLASSES
 
class  COMP_ORDER
 COMP_ORDER corresponds to the <component_order_descriptor>. More...
 
class  COMPONENT
 COMPONENT implements the <component_descriptor> in the specctra dsn spec. More...
 
class  CONNECT
 
class  CONTROL
 
class  COPPER_PLANE
 COPPER_PLANE corresponds to a <plane_descriptor> in the specctra dsn spec. More...
 
class  ELEM
 ELEM is a base class for any DSN element class. More...
 
class  ELEM_HOLDER
 ELEM_HOLDER is a holder for any DSN class. More...
 
class  FROMTO
 
class  GRID
 
class  HISTORY
 
class  IMAGE
 
class  KEEPOUT
 KEEPOUT is used for <keepout_descriptor> and <plane_descriptor>. More...
 
class  LAYER
 
class  LAYER_NOISE_WEIGHT
 
class  LAYER_RULE
 
class  LIBRARY
 LIBRARY corresponds to the <library_descriptor> in the specctra dsn specification. More...
 
class  NET
 NET corresponds to a <net_descriptor> in the DSN spec. More...
 
class  NET_OUT
 NET_OUT corresponds to the <net_out_descriptor> of the specctra dsn spec. More...
 
class  NETWORK
 
class  PADSTACK
 PADSTACK holds either a via or a pad definition. More...
 
class  PARSER
 PARSER is simply a configuration record per the SPECCTRA DSN file spec. More...
 
class  PATH
 PATH supports both the <path_descriptor> and the <polygon_descriptor> per the specctra dsn spec. More...
 
class  PCB
 
class  PIN
 
struct  PIN_PAIR
 Struct PIN_PAIR is 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
 PIN_REF corresponds to the <pin_reference> definition in the specctra dsn spec. More...
 
class  PLACE
 PLACE implements the <placement_reference> in the specctra dsn spec. More...
 
class  PLACEMENT
 
struct  POINT
 Struct POINT is a holder for a point in the SPECCTRA DSN coordinate system. More...
 
struct  PROPERTY
 
class  QARC
 
class  RECTANGLE
 
class  REGION
 
class  ROUTE
 
class  RULE
 RULE corresponds to the <rule_descriptor> in the specctra dsn spec. More...
 
class  SESSION
 SESSION corresponds to the <session_file_descriptor> in the specctra dsn spec. More...
 
class  SHAPE
 SHAPE corresponds to the "(shape ..)" element in the specctra dsn spec. More...
 
class  SPECCTRA_DB
 SPECCTRA_DB holds a DSN data tree, usually coming from a DSN file. More...
 
class  SPECCTRA_LAYER_PAIR
 
class  STRINGPROP
 STRINGPROP is a container for a single property whose value is a string. More...
 
class  STRUCTURE
 
class  STRUCTURE_OUT
 
class  SUPPLY_PIN
 SUPPLY_PIN corresponds to the <supply_pin_descriptor> in the specctra dsn spec. More...
 
class  TOKPROP
 TOKPROP is a container for a single property whose value is another DSN_T token. More...
 
class  TOPOLOGY
 
class  UNIT_RES
 UNIT_RES is 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
 VIA corresponds to the <via_descriptor> in the specctra dsn spec. More...
 
class  WAS_IS
 WAS_IS corresponds to the <was_is_descriptor> in the specctra dsn spec. More...
 
class  WINDOW
 
class  WIRE
 WIRE corresponds to <wire_shape_descriptor> in the specctra dsn spec. More...
 
class  WIRE_VIA
 WIRE_VIA corresponds to <wire_via_descriptor> in the specctra dsn spec. More...
 
class  WIRING
 WIRING corresponds to <wiring_descriptor> in the specctra dsn spec. More...
 

Typedefs

typedef std::vector< std::string > STRINGS
 
typedef std::vector< POINTPOINTS
 
typedef std::vector< PROPERTYPROPERTIES
 
typedef boost::ptr_vector< LAYER_RULELAYER_RULES
 
typedef boost::ptr_vector< PATHPATHS
 
typedef boost::ptr_vector< WINDOWWINDOWS
 
typedef boost::ptr_vector< KEEPOUTKEEPOUTS
 
typedef boost::ptr_vector< LAYERLAYERS
 
typedef boost::ptr_vector< SPECCTRA_LAYER_PAIRSPECCTRA_LAYER_PAIRS
 
typedef boost::ptr_vector< COPPER_PLANECOPPER_PLANES
 
typedef boost::ptr_vector< PLACEPLACES
 
typedef boost::ptr_vector< COMPONENTCOMPONENTS
 
typedef boost::ptr_vector< PINPINS
 
typedef boost::ptr_vector< IMAGEIMAGES
 
typedef boost::ptr_vector< PADSTACKPADSTACKS
 
typedef std::vector< PIN_REFPIN_REFS
 
typedef boost::ptr_vector< FROMTOFROMTOS
 
typedef boost::ptr_vector< COMP_ORDERCOMP_ORDERS
 
typedef boost::ptr_vector< NETNETS
 
typedef boost::ptr_vector< CLASSCLASSLIST
 
typedef boost::ptr_vector< WIREWIRES
 
typedef boost::ptr_vector< WIRE_VIAWIRE_VIAS
 
typedef boost::ptr_vector< ANCESTORANCESTORS
 
typedef boost::ptr_vector< SUPPLY_PINSUPPLY_PINS
 
typedef boost::ptr_vector< NET_OUTNET_OUTS
 
typedef std::vector< PIN_PAIRPIN_PAIRS
 
typedef boost::ptr_set< PADSTACKPADSTACKSET
 
typedef std::map< wxString, int > PINMAP
 data type used to ensure unique-ness of pin names, holding (wxString and int) More...
 
typedef std::set< std::string > STRINGSET
 
typedef std::pair< STRINGSET::iterator, bool > STRINGSET_PAIR
 

Functions

const char * GetTokenText (T aTok)
 Function GetTokenText is in the DSN namespace and returns the C string representing a SPECCTRA_DB::keyword. More...
 
bool operator< (const PADSTACK &lhs, const PADSTACK &rhs)
 Function operator< is used by the PADSTACKSET boost::ptr_set below. More...
 
static double scale (int kicadDist)
 Function scale converts a distance from PCBNEW internal units to the reported specctra dsn units in floating point format. More...
 
static double IU2um (int kicadDist)
 
static double mapX (int x)
 
static double mapY (int y)
 
static POINT mapPt (const wxPoint &pt)
 Function mapPt converts a KiCad point into a DSN file point. More...
 
static bool isRoundKeepout (D_PAD *aPad)
 Function isRoundKeepout decides if the pad is a copper-less through hole which needs to be made into a round keepout. More...
 
static PATHmakePath (const POINT &aStart, const POINT &aEnd, const std::string &aLayerName)
 Function makePath creates a PATH element with a single straight line, a pair of vertices. More...
 
static int scale (double distance, UNIT_RES *aResolution)
 Function scale converts a session file distance to KiCad units of deci-mils. More...
 
static wxPoint mapPt (const POINT &aPoint, UNIT_RES *aResolution)
 Function mapPt translates a point from the Specctra Session format coordinate system to the KiCad coordinate system. More...
 

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 constructore, then boost::ptr_vector cannot be beat.

Typedef Documentation

◆ ANCESTORS

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

Definition at line 3264 of file specctra.h.

◆ CLASSLIST

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

Definition at line 2804 of file specctra.h.

◆ COMP_ORDERS

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

Definition at line 2561 of file specctra.h.

◆ COMPONENTS

typedef boost::ptr_vector<COMPONENT> DSN::COMPONENTS

Definition at line 1784 of file specctra.h.

◆ COPPER_PLANES

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

Definition at line 1334 of file specctra.h.

◆ FROMTOS

typedef boost::ptr_vector<FROMTO> DSN::FROMTOS

Definition at line 2527 of file specctra.h.

◆ IMAGES

typedef boost::ptr_vector<IMAGE> DSN::IMAGES

Definition at line 2091 of file specctra.h.

◆ KEEPOUTS

typedef boost::ptr_vector<KEEPOUT> DSN::KEEPOUTS

Definition at line 1004 of file specctra.h.

◆ LAYER_RULES

typedef boost::ptr_vector<LAYER_RULE> DSN::LAYER_RULES

Definition at line 568 of file specctra.h.

◆ LAYERS

typedef boost::ptr_vector<LAYER> DSN::LAYERS

Definition at line 1263 of file specctra.h.

◆ NET_OUTS

typedef boost::ptr_vector<NET_OUT> DSN::NET_OUTS

Definition at line 3411 of file specctra.h.

◆ NETS

typedef boost::ptr_vector<NET> DSN::NETS

Definition at line 2689 of file specctra.h.

◆ PADSTACKS

typedef boost::ptr_vector<PADSTACK> DSN::PADSTACKS

Definition at line 2212 of file specctra.h.

◆ PADSTACKSET

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

Definition at line 3599 of file specctra.h.

◆ PATHS

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

Definition at line 646 of file specctra.h.

◆ PIN_PAIRS

typedef std::vector<PIN_PAIR> DSN::PIN_PAIRS

Definition at line 3496 of file specctra.h.

◆ PIN_REFS

typedef std::vector<PIN_REF> DSN::PIN_REFS

Definition at line 2459 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 592 of file specctra_export.cpp.

◆ PINS

typedef boost::ptr_vector<PIN> DSN::PINS

Definition at line 1972 of file specctra.h.

◆ PLACES

typedef boost::ptr_vector<PLACE> DSN::PLACES

Definition at line 1732 of file specctra.h.

◆ POINTS

typedef std::vector<POINT> DSN::POINTS

Definition at line 159 of file specctra.h.

◆ PROPERTIES

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

Definition at line 184 of file specctra.h.

◆ SPECCTRA_LAYER_PAIRS

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

Definition at line 1293 of file specctra.h.

◆ STRINGS

typedef std::vector<std::string> DSN::STRINGS

Definition at line 158 of file specctra.h.

◆ STRINGSET

typedef std::set<std::string> DSN::STRINGSET

Definition at line 886 of file specctra_export.cpp.

◆ STRINGSET_PAIR

typedef std::pair<STRINGSET::iterator, bool> DSN::STRINGSET_PAIR

Definition at line 887 of file specctra_export.cpp.

◆ SUPPLY_PINS

typedef boost::ptr_vector<SUPPLY_PIN> DSN::SUPPLY_PINS

Definition at line 3354 of file specctra.h.

◆ WINDOWS

typedef boost::ptr_vector<WINDOW> DSN::WINDOWS

Definition at line 877 of file specctra.h.

◆ WIRE_VIAS

typedef boost::ptr_vector<WIRE_VIA> DSN::WIRE_VIAS

Definition at line 3086 of file specctra.h.

◆ WIRES

typedef boost::ptr_vector<WIRE> DSN::WIRES

Definition at line 2950 of file specctra.h.

Function Documentation

◆ GetTokenText()

const char * DSN::GetTokenText ( aTok)

Function GetTokenText is in the DSN namespace and returns the C string representing a SPECCTRA_DB::keyword.

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

Definition at line 69 of file specctra.cpp.

70 {
71  return SPECCTRA_LEXER::TokenName( aTok );
72 }

Referenced by DSN::UNIT_RES::Format(), DSN::LAYER::Format(), DSN::TOKPROP::Format(), DSN::GRID::Format(), DSN::PLACE::Format(), DSN::SHAPE::Format(), DSN::FROMTO::Format(), DSN::NET::Format(), DSN::WIRE::Format(), DSN::WIRE_VIA::Format(), DSN::PLACEMENT::FormatContents(), DSN::IMAGE::FormatContents(), DSN::PADSTACK::FormatContents(), PCB_PARSER::parseBoardUnits(), SCH_SEXPR_PARSER::parseDouble(), PCB_PARSER::parseDouble(), SCH_SEXPR_PARSER::parseInternalUnits(), and PCB_PARSER::parseVersion().

◆ isRoundKeepout()

static bool DSN::isRoundKeepout ( D_PAD aPad)
static

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

Definition at line 202 of file specctra_export.cpp.

203 {
204  if( aPad->GetShape()==PAD_SHAPE_CIRCLE )
205  {
206  if( aPad->GetDrillSize().x >= aPad->GetSize().x )
207  return true;
208 
209  if( !( aPad->GetLayerSet() & LSET::AllCuMask() ).any() )
210  return true;
211  }
212 
213  return false;
214 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:719
LSET GetLayerSet() const override
Function GetLayerSet returns a std::bitset of all layers on which the item physically resides.
Definition: class_pad.h:332
const wxSize & GetDrillSize() const
Definition: class_pad.h:230
PAD_SHAPE_T GetShape() const
Definition: class_pad.h:157
const wxSize & GetSize() const
Definition: class_pad.h:224

References LSET::AllCuMask(), D_PAD::GetDrillSize(), D_PAD::GetLayerSet(), D_PAD::GetShape(), D_PAD::GetSize(), and PAD_SHAPE_CIRCLE.

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

◆ IU2um()

static double DSN::IU2um ( int  kicadDist)
inlinestatic

Definition at line 162 of file specctra_export.cpp.

163 {
164  return kicadDist * (1000.0 / IU_PER_MM);
165 }
static constexpr double IU_PER_MM
Mock up a conversion function.

References IU_PER_MM.

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

Function makePath creates a PATH element with a single straight line, a pair of vertices.

Definition at line 221 of file specctra_export.cpp.

222 {
223  PATH* path = new PATH( 0, T_path );
224 
225  path->AppendPoint( aStart );
226  path->AppendPoint( aEnd );
227  path->SetLayerId( aLayerName.c_str() );
228  return path;
229 }
void SetLayerId(const char *aLayerId)
Definition: specctra.h:602
void AppendPoint(const POINT &aPoint)
Definition: specctra.h:595
PATH supports both the <path_descriptor> and the <polygon_descriptor> per the specctra dsn spec.
Definition: specctra.h:576

References DSN::PATH::AppendPoint(), and DSN::PATH::SetLayerId().

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

◆ mapPt() [1/2]

static wxPoint 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
aPointThe session point to translate
aResolution- The amount to scale the point.
Returns
wxPoint - The KiCad coordinate system point.

Definition at line 152 of file specctra_import.cpp.

153 {
154  wxPoint ret( scale( aPoint.x, aResolution ),
155  -scale( aPoint.y, aResolution ) ); // negate y
156 
157  return ret;
158 }
double y
Definition: specctra.h:97
double x
Definition: specctra.h:96
const int scale

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

◆ mapPt() [2/2]

static POINT DSN::mapPt ( const wxPoint pt)
static

Function mapPt converts 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 186 of file specctra_export.cpp.

187 {
188  POINT ret;
189 
190  ret.x = mapX( pt.x );
191  ret.y = mapY( pt.y );
192  ret.FixNegativeZero();
193  return ret;
194 }
void FixNegativeZero()
Function FixNegativeZero will change negative zero to positive zero in the IEEE floating point storag...
Definition: specctra.h:136
double y
Definition: specctra.h:97
double x
Definition: specctra.h:96
Struct POINT is a holder for a point in the SPECCTRA DSN coordinate system.
Definition: specctra.h:94
static double mapY(int y)
static double mapX(int x)

References DSN::POINT::FixNegativeZero(), mapX(), mapY(), wxPoint::x, DSN::POINT::x, wxPoint::y, and DSN::POINT::y.

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

◆ mapX()

static double DSN::mapX ( int  x)
inlinestatic

Definition at line 168 of file specctra_export.cpp.

169 {
170  return scale( x );
171 }
const int scale

References scale().

Referenced by mapPt().

◆ mapY()

static double DSN::mapY ( int  y)
inlinestatic

Definition at line 174 of file specctra_export.cpp.

175 {
176  return -scale( y ); // make y negative, since it is increasing going down.
177 }
const int scale

References scale().

Referenced by mapPt().

◆ operator<()

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

Function operator< is used by the PADSTACKSET boost::ptr_set below.

Definition at line 2219 of file specctra.h.

2220 {
2221  return PADSTACK::Compare( (PADSTACK*) &lhs, (PADSTACK*) &rhs ) < 0;
2222 }

References DSN::PADSTACK::Compare().

◆ 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
distanceThe session file length to convert.
aResolutionThe session UNIT_RES which holds the engineering unit specifier
Returns
int - The KiCad length in internal unit

Definition at line 113 of file specctra_import.cpp.

114 {
115  double resValue = aResolution->GetValue();
116  double factor;
117 
118  switch( aResolution->GetEngUnits() )
119  {
120  default:
121  case T_inch:
122  factor = 25.4e6; // nanometers per inch
123  break;
124  case T_mil:
125  factor = 25.4e3; // nanometers per mil
126  break;
127  case T_cm:
128  factor = 1e7; // nanometers per cm
129  break;
130  case T_mm:
131  factor = 1e6; // nanometers per mm
132  break;
133  case T_um:
134  factor = 1e3; // nanometers per um
135  break;
136  }
137 
138  int ret = KiROUND( factor * distance / resValue );
139 
140  return ret;
141 }
DSN_T GetEngUnits() const
Definition: specctra.h:423
int GetValue() const
Definition: specctra.h:424
static float distance(const SFVEC2UI &a, const SFVEC2UI &b)
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68

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

◆ scale() [2/2]

static double DSN::scale ( int  kicadDist)
inlinestatic

Function scale converts a distance from PCBNEW internal units to the reported specctra dsn units in floating point format.

Definition at line 154 of file specctra_export.cpp.

155 {
156  // nanometers to um
157  return kicadDist / ( IU_PER_MM / 1000.0 );
158 }
static constexpr double IU_PER_MM
Mock up a conversion function.

References IU_PER_MM.

Referenced by DSN::SPECCTRA_DB::exportNETCLASS(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), DSN::SPECCTRA_DB::makeTRACK(), DSN::SPECCTRA_DB::makeVia(), DSN::SPECCTRA_DB::makeVIA(), mapPt(), mapX(), and mapY().