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
 Return the units for this section. More...
 
void FormatContents (OUTPUTFORMATTER *out, int nestLevel) override
 Write 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)
 Write 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 ()
 Return a string which uniquely represents this ELEM among 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 3454 of file specctra.h.

Constructor & Destructor Documentation

◆ ROUTE()

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

Definition at line 3457 of file specctra.h.

3457  :
3458  ELEM( T_route, aParent )
3459  {
3460  resolution = 0;
3461  parser = 0;
3462  structure_out = 0;
3463  library = 0;
3464  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749
STRUCTURE_OUT * structure_out
Definition: specctra.h:3516
PARSER * parser
Definition: specctra.h:3515
LIBRARY * library
Definition: specctra.h:3517
UNIT_RES * resolution
Definition: specctra.h:3514

References library, parser, resolution, and structure_out.

◆ ~ROUTE()

DSN::ROUTE::~ROUTE ( )
inline

Definition at line 3466 of file specctra.h.

3467  {
3468  delete resolution;
3469  delete parser;
3470  delete structure_out;
3471  delete library;
3472 // delete test_points;
3473  }
STRUCTURE_OUT * structure_out
Definition: specctra.h:3516
PARSER * parser
Definition: specctra.h:3515
LIBRARY * library
Definition: specctra.h:3517
UNIT_RES * resolution
Definition: specctra.h:3514

References library, parser, resolution, and structure_out.

Member Function Documentation

◆ Format()

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

Write 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 precede 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 3774 of file specctra.cpp.

3775 {
3776  out->Print( nestLevel, "(%s\n", Name() );
3777 
3778  FormatContents( out, nestLevel+1 );
3779 
3780  out->Print( nestLevel, ")\n" );
3781 }
const char * Name() const
Definition: specctra.cpp:3760
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:242
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426

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

Write 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 precede the output with.
Exceptions
IO_ERRORif a system error writing the output, such as a full disk.

Reimplemented from DSN::ELEM.

Definition at line 3483 of file specctra.h.

3484  {
3485  if( resolution )
3486  resolution->Format( out, nestLevel );
3487 
3488  if( parser )
3489  parser->Format( out, nestLevel );
3490 
3491  if( structure_out )
3492  structure_out->Format( out, nestLevel );
3493 
3494  if( library )
3495  library->Format( out, nestLevel );
3496 
3497  if( net_outs.size() )
3498  {
3499  out->Print( nestLevel, "(network_out\n" );
3500 
3501  for( NET_OUTS::iterator i = net_outs.begin(); i != net_outs.end(); ++i )
3502  i->Format( out, nestLevel + 1 );
3503 
3504  out->Print( nestLevel, ")\n" );
3505  }
3506 
3507 // if( test_poinst )
3508 // test_points->Format( out, nestLevel );
3509  }
NET_OUTS net_outs
Definition: specctra.h:3518
STRUCTURE_OUT * structure_out
Definition: specctra.h:3516
void Format(OUTPUTFORMATTER *out, int nestLevel) override
Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:422
PARSER * parser
Definition: specctra.h:3515
LIBRARY * library
Definition: specctra.h:3517
UNIT_RES * resolution
Definition: specctra.h:3514
virtual void Format(OUTPUTFORMATTER *out, int nestLevel)
Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.cpp:3774
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426

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

Return the units for this section.

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

Returns
an element from a local or parent scope.

Reimplemented from DSN::ELEM.

Definition at line 3475 of file specctra.h.

3476  {
3477  if( resolution )
3478  return resolution;
3479 
3480  return ELEM::GetUnits();
3481  }
UNIT_RES * resolution
Definition: specctra.h:3514
virtual UNIT_RES * GetUnits() const
Return the units for this section.
Definition: specctra.cpp:3765

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

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

◆ makeHash()

std::string DSN::ELEM::makeHash ( )
inlineprotectedinherited

Return a string which uniquely represents this ELEM among other ELEMs of the same derived class as "this" one.

It is not usable 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 263 of file specctra.h.

264  {
265  sf.Clear();
266  FormatContents( &sf, 0 );
267  sf.StripUseless();
268 
269  return sf.GetString();
270  }
virtual void FormatContents(OUTPUTFORMATTER *out, int nestLevel)
Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:242
const std::string & GetString()
Definition: richio.h:438
void StripUseless()
Removes whitespace, '(', and ')' from the string.
Definition: richio.cpp:512
static STRING_FORMATTER sf
Definition: specctra.h:273
void Clear()
Clear the buffer and empties the internal string.
Definition: richio.h:428

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

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

◆ parser

PARSER* DSN::ROUTE::parser
private

Definition at line 3515 of file specctra.h.

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

◆ resolution

UNIT_RES* DSN::ROUTE::resolution
private

Definition at line 3514 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 273 of file specctra.h.

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

◆ structure_out

STRUCTURE_OUT* DSN::ROUTE::structure_out
private

Definition at line 3516 of file specctra.h.

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

◆ type

DSN_T DSN::ELEM::type
protectedinherited

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