KiCad PCB EDA Suite
DSN::WIRING Class Reference

Class WIRING corresponds to <wiring_descriptor> in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::WIRING:
DSN::ELEM

Public Member Functions

 WIRING (ELEM *aParent)
 
 ~WIRING ()
 
void FormatContents (OUTPUTFORMATTER *out, int nestLevel) override throw ( IO_ERROR )
 Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
UNIT_RESGetUnits () const override
 Function GetUnits returns the units for this section. More...
 
DSN_T Type () const
 
const char * Name () const
 
virtual void Format (OUTPUTFORMATTER *out, int nestLevel) throw ( IO_ERROR )
 Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
void SetParent (ELEM *aParent)
 

Protected Member Functions

std::string makeHash ()
 Function makeHash returns a string which uniquely represents this ELEM amoung other ELEMs of the same derived class as "this" one. More...
 

Protected Attributes

DSN_T type
 
ELEMparent
 

Static Protected Attributes

static STRING_FORMATTER sf
 

Private Attributes

UNIT_RESunit
 
WIRES wires
 
WIRE_VIAS wire_vias
 

Friends

class SPECCTRA_DB
 

Detailed Description

Class WIRING corresponds to <wiring_descriptor> in the specctra dsn spec.

Definition at line 3090 of file specctra.h.

Constructor & Destructor Documentation

DSN::WIRING::WIRING ( ELEM aParent)
inline

Definition at line 3100 of file specctra.h.

3100  :
3101  ELEM( T_wiring, aParent )
3102  {
3103  unit = 0;
3104  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3486
UNIT_RES * unit
Definition: specctra.h:3094
DSN::WIRING::~WIRING ( )
inline

Definition at line 3105 of file specctra.h.

References unit.

3106  {
3107  delete unit;
3108  }
UNIT_RES * unit
Definition: specctra.h:3094

Member Function Documentation

void DSN::ELEM::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
virtualinherited

Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.

Parameters
outThe formatter to write to.
nestLevelA multiple of the number of spaces to preceed the output with.
Exceptions
IO_ERRORif a system error writing the output, such as a full disk.

Reimplemented in DSN::SESSION, DSN::NET_OUT, DSN::SUPPLY_PIN, DSN::ANCESTOR, DSN::PCB, DSN::WIRE_VIA, DSN::WIRE, DSN::CLASS, DSN::NET, DSN::COMP_ORDER, DSN::FROMTO, DSN::PADSTACK, DSN::IMAGE, DSN::PIN, DSN::SHAPE, DSN::COMPONENT, DSN::PLACE, DSN::GRID, DSN::STRINGPROP, DSN::TOKPROP, DSN::LAYER_NOISE_WEIGHT, DSN::SPECCTRA_LAYER_PAIR, DSN::LAYER, DSN::CONTROL, DSN::VIA, DSN::KEEPOUT, DSN::WINDOW, DSN::QARC, DSN::CIRCLE, DSN::BOUNDARY, DSN::PATH, DSN::LAYER_RULE, DSN::RULE, DSN::RECTANGLE, and DSN::UNIT_RES.

Definition at line 3511 of file specctra.cpp.

Referenced by DSN::WINDOW::Format(), DSN::KEEPOUT::Format(), DSN::CONTROL::Format(), DSN::SHAPE::Format(), DSN::CLASS::Format(), DSN::WIRE::Format(), DSN::PCB::Format(), DSN::SESSION::Format(), DSN::CLASS_CLASS::FormatContents(), DSN::STRUCTURE::FormatContents(), and DSN::ROUTE::FormatContents().

3512 {
3513  out->Print( nestLevel, "(%s\n", Name() );
3514 
3515  FormatContents( out, nestLevel+1 );
3516 
3517  out->Print( nestLevel, ")\n" );
3518 }
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECC...
Definition: specctra.h:264
const char * Name() const
Definition: specctra.cpp:3497
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
void DSN::WIRING::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
inlineoverridevirtual

Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.

This is the same as Format() except that the outer wrapper is not included.

Parameters
outThe formatter to write to.
nestLevelA multiple of the number of spaces to preceed the output with.
Exceptions
IO_ERRORif a system error writing the output, such as a full disk.

Reimplemented from DSN::ELEM.

Definition at line 3110 of file specctra.h.

References DSN::UNIT_RES::Format().

3111  {
3112  if( unit )
3113  unit->Format( out, nestLevel );
3114 
3115  for( WIRES::iterator i=wires.begin(); i!=wires.end(); ++i )
3116  i->Format( out, nestLevel );
3117 
3118  for( WIRE_VIAS::iterator i=wire_vias.begin(); i!=wire_vias.end(); ++i )
3119  i->Format( out, nestLevel );
3120  }
UNIT_RES * unit
Definition: specctra.h:3094
void Format(OUTPUTFORMATTER *out, int nestLevel) override
Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN f...
Definition: specctra.h:426
WIRES wires
Definition: specctra.h:3095
WIRE_VIAS wire_vias
Definition: specctra.h:3096
UNIT_RES* DSN::WIRING::GetUnits ( ) const
inlineoverridevirtual

Function GetUnits returns the units for this section.

Derived classes may override this to check for section specific overrides.

Returns
UNIT_RES* - from a local or parent scope

Reimplemented from DSN::ELEM.

Definition at line 3122 of file specctra.h.

References DSN::ELEM::GetUnits(), and unit.

3123  {
3124  if( unit )
3125  return unit;
3126 
3127  return ELEM::GetUnits();
3128  }
UNIT_RES * unit
Definition: specctra.h:3094
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3502
std::string DSN::ELEM::makeHash ( )
inlineprotectedinherited

Function makeHash returns a string which uniquely represents this ELEM amoung other ELEMs of the same derived class as "this" one.

It is not useable for all derived classes, only those which plan for it by implementing a FormatContents() function that captures all info which will be used in the subsequent string compare. THIS SHOULD NORMALLY EXCLUDE THE TYPENAME, AND INSTANCE NAME OR ID AS WELL.

Definition at line 212 of file specctra.h.

References STRING_FORMATTER::Clear(), DSN::ELEM::FormatContents(), STRING_FORMATTER::GetString(), DSN::ELEM::sf, and STRING_FORMATTER::StripUseless().

Referenced by DSN::IMAGE::Compare(), and DSN::PADSTACK::Compare().

213  {
214  sf.Clear();
215  FormatContents( &sf, 0 );
216  sf.StripUseless();
217 
218  return sf.GetString();
219  }
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECC...
Definition: specctra.h:264
const std::string & GetString()
Definition: richio.h:475
void StripUseless()
Function StripUseless removes whitespace, '(', and ')' from the mystring.
Definition: richio.cpp:504
static STRING_FORMATTER sf
Definition: specctra.h:222
void Clear()
Function Clear clears the buffer and empties the internal string.
Definition: richio.h:464

Friends And Related Function Documentation

friend class SPECCTRA_DB
friend

Definition at line 3092 of file specctra.h.

Member Data Documentation

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

Referenced by DSN::ELEM::GetUnits().

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

Referenced by DSN::ELEM::makeHash().

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 199 of file specctra.h.

Referenced by DSN::ELEM::Name(), and DSN::ELEM::Type().

UNIT_RES* DSN::WIRING::unit
private

Definition at line 3094 of file specctra.h.

Referenced by GetUnits(), and ~WIRING().

WIRE_VIAS DSN::WIRING::wire_vias
private

Definition at line 3096 of file specctra.h.

WIRES DSN::WIRING::wires
private

Definition at line 3095 of file specctra.h.

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


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