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 3413 of file specctra.h.

Constructor & Destructor Documentation

◆ ROUTE()

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

Definition at line 3426 of file specctra.h.

3426  :
3427  ELEM( T_route, aParent )
3428  {
3429  resolution = 0;
3430  parser = 0;
3431  structure_out = 0;
3432  library = 0;
3433  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
STRUCTURE_OUT * structure_out
Definition: specctra.h:3419
PARSER * parser
Definition: specctra.h:3418
LIBRARY * library
Definition: specctra.h:3420
UNIT_RES * resolution
Definition: specctra.h:3417

References library, parser, resolution, and structure_out.

◆ ~ROUTE()

DSN::ROUTE::~ROUTE ( )
inline

Definition at line 3434 of file specctra.h.

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

References library, parser, resolution, and structure_out.

Member Function Documentation

◆ Format()

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 3519 of file specctra.cpp.

3520 {
3521  out->Print( nestLevel, "(%s\n", Name() );
3522 
3523  FormatContents( out, nestLevel+1 );
3524 
3525  out->Print( nestLevel, ")\n" );
3526 }
const char * Name() const
Definition: specctra.cpp:3505
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:263
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408

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().

◆ FormatContents()

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 3451 of file specctra.h.

3452  {
3453  if( resolution )
3454  resolution->Format( out, nestLevel );
3455 
3456  if( parser )
3457  parser->Format( out, nestLevel );
3458 
3459  if( structure_out )
3460  structure_out->Format( out, nestLevel );
3461 
3462  if( library )
3463  library->Format( out, nestLevel );
3464 
3465  if( net_outs.size() )
3466  {
3467  out->Print( nestLevel, "(network_out\n" );
3468  for( NET_OUTS::iterator i=net_outs.begin(); i!=net_outs.end(); ++i )
3469  i->Format( out, nestLevel+1 );
3470  out->Print( nestLevel, ")\n" );
3471  }
3472 
3473 // if( test_poinst )
3474 // test_points->Format( out, nestLevel );
3475  }
NET_OUTS net_outs
Definition: specctra.h:3421
STRUCTURE_OUT * structure_out
Definition: specctra.h:3419
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:425
PARSER * parser
Definition: specctra.h:3418
LIBRARY * library
Definition: specctra.h:3420
UNIT_RES * resolution
Definition: specctra.h:3417
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:3519
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408

References DSN::ELEM::Format(), DSN::UNIT_RES::Format(), library, net_outs, parser, OUTPUTFORMATTER::Print(), resolution, and structure_out.

◆ GetUnits()

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 3443 of file specctra.h.

3444  {
3445  if( resolution )
3446  return resolution;
3447 
3448  return ELEM::GetUnits();
3449  }
UNIT_RES * resolution
Definition: specctra.h:3417
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3510

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

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

◆ makeHash()

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 211 of file specctra.h.

212  {
213  sf.Clear();
214  FormatContents( &sf, 0 );
215  sf.StripUseless();
216 
217  return sf.GetString();
218  }
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:263
const std::string & GetString()
Definition: richio.h:476
void StripUseless()
Function StripUseless removes whitespace, '(', and ')' from the mystring.
Definition: richio.cpp:494
static STRING_FORMATTER sf
Definition: specctra.h:221
void Clear()
Function Clear clears the buffer and empties the internal string.
Definition: richio.h:465

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().

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 3415 of file specctra.h.

Member Data Documentation

◆ library

LIBRARY* DSN::ROUTE::library
private

◆ net_outs

NET_OUTS DSN::ROUTE::net_outs
private

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

Referenced by DSN::ELEM::GetUnits(), and DSN::ELEM::SetParent().

◆ parser

PARSER* DSN::ROUTE::parser
private

Definition at line 3418 of file specctra.h.

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

◆ resolution

UNIT_RES* DSN::ROUTE::resolution
private

Definition at line 3417 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

◆ structure_out

STRUCTURE_OUT* DSN::ROUTE::structure_out
private

Definition at line 3419 of file specctra.h.

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

◆ type

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 198 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: