KiCad PCB EDA Suite
DSN::ROUTE Class Reference

#include <specctra.h>

Inheritance diagram for DSN::ROUTE:
DSN::ELEM

Public Member Functions

 ROUTE (ELEM *aParent)
 
 ~ROUTE ()
 
UNIT_RESGetUnits () const override
 Function GetUnits returns the units for this section. More...
 
void FormatContents (OUTPUTFORMATTER *out, int nestLevel) override
 Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
DSN_T Type () const
 
const char * Name () const
 
virtual void Format (OUTPUTFORMATTER *out, int nestLevel)
 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_RESresolution
 
PARSERparser
 
STRUCTURE_OUTstructure_out
 
LIBRARYlibrary
 
NET_OUTS net_outs
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 3414 of file specctra.h.

Constructor & Destructor Documentation

DSN::ROUTE::ROUTE ( ELEM aParent)
inline

Definition at line 3427 of file specctra.h.

3427  :
3428  ELEM( T_route, aParent )
3429  {
3430  resolution = 0;
3431  parser = 0;
3432  structure_out = 0;
3433  library = 0;
3434  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3490
STRUCTURE_OUT * structure_out
Definition: specctra.h:3420
PARSER * parser
Definition: specctra.h:3419
LIBRARY * library
Definition: specctra.h:3421
UNIT_RES * resolution
Definition: specctra.h:3418
DSN::ROUTE::~ROUTE ( )
inline

Definition at line 3435 of file specctra.h.

References library, parser, resolution, and structure_out.

3436  {
3437  delete resolution;
3438  delete parser;
3439  delete structure_out;
3440  delete library;
3441 // delete test_points;
3442  }
STRUCTURE_OUT * structure_out
Definition: specctra.h:3420
PARSER * parser
Definition: specctra.h:3419
LIBRARY * library
Definition: specctra.h:3421
UNIT_RES * resolution
Definition: specctra.h:3418

Member Function Documentation

void DSN::ELEM::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
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 3515 of file specctra.cpp.

References DSN::ELEM::FormatContents(), DSN::ELEM::Name(), and OUTPUTFORMATTER::Print().

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

3516 {
3517  out->Print( nestLevel, "(%s\n", Name() );
3518 
3519  FormatContents( out, nestLevel+1 );
3520 
3521  out->Print( nestLevel, ")\n" );
3522 }
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:3501
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
void DSN::ROUTE::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
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 3452 of file specctra.h.

References DSN::ELEM::Format(), DSN::UNIT_RES::Format(), and OUTPUTFORMATTER::Print().

3453  {
3454  if( resolution )
3455  resolution->Format( out, nestLevel );
3456 
3457  if( parser )
3458  parser->Format( out, nestLevel );
3459 
3460  if( structure_out )
3461  structure_out->Format( out, nestLevel );
3462 
3463  if( library )
3464  library->Format( out, nestLevel );
3465 
3466  if( net_outs.size() )
3467  {
3468  out->Print( nestLevel, "(network_out\n" );
3469  for( NET_OUTS::iterator i=net_outs.begin(); i!=net_outs.end(); ++i )
3470  i->Format( out, nestLevel+1 );
3471  out->Print( nestLevel, ")\n" );
3472  }
3473 
3474 // if( test_poinst )
3475 // test_points->Format( out, nestLevel );
3476  }
NET_OUTS net_outs
Definition: specctra.h:3422
STRUCTURE_OUT * structure_out
Definition: specctra.h:3420
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
PARSER * parser
Definition: specctra.h:3419
LIBRARY * library
Definition: specctra.h:3421
UNIT_RES * resolution
Definition: specctra.h:3418
virtual void Format(OUTPUTFORMATTER *out, int nestLevel)
Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN f...
Definition: specctra.cpp:3515
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
UNIT_RES* DSN::ROUTE::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 3444 of file specctra.h.

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

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

3445  {
3446  if( resolution )
3447  return resolution;
3448 
3449  return ELEM::GetUnits();
3450  }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3506
UNIT_RES * resolution
Definition: specctra.h:3418
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:500
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 3416 of file specctra.h.

Member Data Documentation

LIBRARY* DSN::ROUTE::library
private

Definition at line 3421 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doROUTE(), DSN::SPECCTRA_DB::FromSESSION(), and ~ROUTE().

NET_OUTS DSN::ROUTE::net_outs
private

Definition at line 3422 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doROUTE(), and DSN::SPECCTRA_DB::FromSESSION().

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

PARSER* DSN::ROUTE::parser
private

Definition at line 3419 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doROUTE(), and ~ROUTE().

UNIT_RES* DSN::ROUTE::resolution
private

Definition at line 3418 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doROUTE(), GetUnits(), and ~ROUTE().

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

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

STRUCTURE_OUT* DSN::ROUTE::structure_out
private

Definition at line 3420 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doROUTE(), and ~ROUTE().

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 199 of file specctra.h.

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


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