KiCad PCB EDA Suite
DSN::FROMTO Class Reference

#include <specctra.h>

Inheritance diagram for DSN::FROMTO:
DSN::ELEM

Public Member Functions

 FROMTO (ELEM *aParent)
 
 ~FROMTO ()
 
void Format (OUTPUTFORMATTER *out, int nestLevel) override
 Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...
 
DSN_T Type () const
 
const char * Name () const
 
virtual UNIT_RESGetUnits () const
 Return the units for this section. More...
 
virtual void FormatContents (OUTPUTFORMATTER *out, int nestLevel)
 Write the contents 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

std::string fromText
 
std::string toText
 
DSN_T fromto_type
 
std::string net_id
 
RULErules
 
LAYER_RULES layer_rules
 

Friends

class SPECCTRA_DB
 

Detailed Description

Definition at line 2488 of file specctra.h.

Constructor & Destructor Documentation

◆ FROMTO()

DSN::FROMTO::FROMTO ( ELEM aParent)
inline

Definition at line 2491 of file specctra.h.

2491  :
2492  ELEM( T_fromto, aParent )
2493  {
2494  rules = 0;
2495  fromto_type = DSN_T( T_NONE );
2496  }
DSN_T fromto_type
Definition: specctra.h:2548
DSN::T DSN_T
Definition: specctra.h:46
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749
RULE * rules
Definition: specctra.h:2550

References fromto_type, and rules.

◆ ~FROMTO()

DSN::FROMTO::~FROMTO ( )
inline

Definition at line 2497 of file specctra.h.

2498  {
2499  delete rules;
2500  }
RULE * rules
Definition: specctra.h:2550

References rules.

Member Function Documentation

◆ Format()

void DSN::FROMTO::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
inlineoverridevirtual

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 from DSN::ELEM.

Definition at line 2502 of file specctra.h.

2503  {
2504  // no quoting on these two, the lexer preserved the quotes on input
2505  out->Print( nestLevel, "(%s %s %s ",
2506  Name(), fromText.c_str(), toText.c_str() );
2507 
2508  if( fromto_type != DSN_T( T_NONE ) )
2509  out->Print( 0, "(type %s)", GetTokenText( fromto_type ) );
2510 
2511  if( net_id.size() )
2512  {
2513  const char* quote = out->GetQuoteChar( net_id.c_str() );
2514  out->Print( 0, "(net %s%s%s)", quote, net_id.c_str(), quote );
2515  }
2516 
2517  bool singleLine = true;
2518 
2519  if( rules || layer_rules.size() )
2520  {
2521  out->Print( 0, "\n" );
2522  singleLine = false;
2523  }
2524 
2525  if( rules )
2526  rules->Format( out, nestLevel+1 );
2527 
2528  /*
2529  if( circuit.size() )
2530  out->Print( nestLevel, "%s\n", circuit.c_str() );
2531  */
2532 
2533  for( LAYER_RULES::iterator i = layer_rules.begin(); i != layer_rules.end(); ++i )
2534  i->Format( out, nestLevel+1 );
2535 
2536  out->Print( singleLine ? 0 : nestLevel, ")" );
2537 
2538  if( nestLevel || !singleLine )
2539  out->Print( 0, "\n" );
2540  }
DSN_T fromto_type
Definition: specctra.h:2548
DSN::T DSN_T
Definition: specctra.h:46
RULE * rules
Definition: specctra.h:2550
const char * Name() const
Definition: specctra.cpp:3760
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:500
LAYER_RULES layer_rules
Definition: specctra.h:2552
std::string net_id
Definition: specctra.h:2549
std::string fromText
Definition: specctra.h:2545
static const char * GetQuoteChar(const char *wrapee, const char *quote_char)
Perform quote character need determination according to the Specctra DSN specification.
Definition: richio.cpp:348
const char * GetTokenText(T aTok)
The DSN namespace and returns the C string representing a SPECCTRA_DB::keyword.
Definition: specctra.cpp:70
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426
std::string toText
Definition: specctra.h:2546

References DSN::RULE::Format(), fromText, fromto_type, OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), layer_rules, DSN::ELEM::Name(), net_id, OUTPUTFORMATTER::Print(), rules, and toText.

◆ FormatContents()

virtual void DSN::ELEM::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
inlinevirtualinherited

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 in DSN::WAS_IS, DSN::ROUTE, DSN::HISTORY, DSN::WIRING, DSN::NETWORK, DSN::TOPOLOGY, DSN::LIBRARY, DSN::PADSTACK, DSN::IMAGE, DSN::PLACEMENT, DSN::COMPONENT, DSN::STRUCTURE, DSN::STRUCTURE_OUT, DSN::REGION, DSN::CLASS_CLASS, DSN::CLASSES, DSN::PARSER, and DSN::ELEM_HOLDER.

Definition at line 242 of file specctra.h.

243  {
244  // overridden in ELEM_HOLDER
245  }

Referenced by DSN::ELEM::Format(), and DSN::ELEM::makeHash().

◆ GetUnits()

UNIT_RES * DSN::ELEM::GetUnits ( ) const
virtualinherited

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 in DSN::ROUTE, DSN::PCB, DSN::WIRING, DSN::LIBRARY, DSN::PADSTACK, DSN::IMAGE, DSN::PLACEMENT, and DSN::STRUCTURE.

Definition at line 3765 of file specctra.cpp.

3766 {
3767  if( parent )
3768  return parent->GetUnits();
3769 
3770  return &UNIT_RES::Default;
3771 }
ELEM * parent
Definition: specctra.h:276
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:410
virtual UNIT_RES * GetUnits() const
Return the units for this section.
Definition: specctra.cpp:3765

References DSN::UNIT_RES::Default, DSN::ELEM::GetUnits(), and DSN::ELEM::parent.

Referenced by DSN::SPECCTRA_DB::FromSESSION(), DSN::ELEM::GetUnits(), DSN::STRUCTURE::GetUnits(), DSN::PLACEMENT::GetUnits(), DSN::IMAGE::GetUnits(), DSN::PADSTACK::GetUnits(), DSN::LIBRARY::GetUnits(), DSN::WIRING::GetUnits(), DSN::PCB::GetUnits(), and DSN::ROUTE::GetUnits().

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

Member Data Documentation

◆ fromText

std::string DSN::FROMTO::fromText
private

Definition at line 2545 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doFROMTO(), and Format().

◆ fromto_type

DSN_T DSN::FROMTO::fromto_type
private

Definition at line 2548 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doFROMTO(), Format(), and FROMTO().

◆ layer_rules

LAYER_RULES DSN::FROMTO::layer_rules
private

Definition at line 2552 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doFROMTO(), and Format().

◆ net_id

std::string DSN::FROMTO::net_id
private

Definition at line 2549 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doFROMTO(), and Format().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 276 of file specctra.h.

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

◆ rules

RULE* DSN::FROMTO::rules
private

Definition at line 2550 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doFROMTO(), Format(), FROMTO(), and ~FROMTO().

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 273 of file specctra.h.

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

◆ toText

std::string DSN::FROMTO::toText
private

Definition at line 2546 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doFROMTO(), and Format().

◆ 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: