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
 Function Format writes 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
 Function GetUnits returns the units for this section. More...
 
virtual void FormatContents (OUTPUTFORMATTER *out, int nestLevel)
 Function FormatContents writes 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 ()
 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

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

Constructor & Destructor Documentation

◆ FROMTO()

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

Definition at line 2498 of file specctra.h.

2498  :
2499  ELEM( T_fromto, aParent )
2500  {
2501  rules = 0;
2502  fromto_type = DSN_T( T_NONE );
2503  }
DSN_T fromto_type
Definition: specctra.h:2490
DSN::T DSN_T
Definition: specctra.h:46
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
RULE * rules
Definition: specctra.h:2492

References fromto_type, and rules.

◆ ~FROMTO()

DSN::FROMTO::~FROMTO ( )
inline

Definition at line 2504 of file specctra.h.

2505  {
2506  delete rules;
2507  }
RULE * rules
Definition: specctra.h:2492

References rules.

Member Function Documentation

◆ Format()

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

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

Definition at line 2509 of file specctra.h.

2510  {
2511  // no quoting on these two, the lexer preserved the quotes on input
2512  out->Print( nestLevel, "(%s %s %s ",
2513  Name(), fromText.c_str(), toText.c_str() );
2514 
2515  if( fromto_type != DSN_T( T_NONE ) )
2516  out->Print( 0, "(type %s)", GetTokenText( fromto_type ) );
2517 
2518  if( net_id.size() )
2519  {
2520  const char* quote = out->GetQuoteChar( net_id.c_str() );
2521  out->Print( 0, "(net %s%s%s)", quote, net_id.c_str(), quote );
2522  }
2523 
2524  bool singleLine = true;
2525 
2526  if( rules || layer_rules.size() )
2527  {
2528  out->Print( 0, "\n" );
2529  singleLine = false;
2530  }
2531 
2532  if( rules )
2533  rules->Format( out, nestLevel+1 );
2534 
2535  /*
2536  if( circuit.size() )
2537  out->Print( nestLevel, "%s\n", circuit.c_str() );
2538  */
2539 
2540  for( LAYER_RULES::iterator i = layer_rules.begin(); i != layer_rules.end(); ++i )
2541  i->Format( out, nestLevel+1 );
2542 
2543  out->Print( singleLine ? 0 : nestLevel, ")" );
2544 
2545  if( nestLevel || !singleLine )
2546  out->Print( 0, "\n" );
2547  }
DSN_T fromto_type
Definition: specctra.h:2490
DSN::T DSN_T
Definition: specctra.h:46
RULE * rules
Definition: specctra.h:2492
const char * Name() const
Definition: specctra.cpp:3505
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:501
LAYER_RULES layer_rules
Definition: specctra.h:2494
std::string net_id
Definition: specctra.h:2491
std::string fromText
Definition: specctra.h:2487
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:331
const char * GetTokenText(T aTok)
Function GetTokenText is in the DSN namespace and returns the C string representing a SPECCTRA_DB::ke...
Definition: specctra.cpp:69
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408
std::string toText
Definition: specctra.h:2488

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

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

264  {
265  // overridden in ELEM_HOLDER
266  }

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

◆ GetUnits()

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

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

Definition at line 3510 of file specctra.cpp.

3511 {
3512  if( parent )
3513  return parent->GetUnits();
3514 
3515  return &UNIT_RES::Default;
3516 }
ELEM * parent
Definition: specctra.h:199
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:413
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3510

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

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:435
void StripUseless()
Removes whitespace, '(', and ')' from the string.
Definition: richio.cpp:494
static STRING_FORMATTER sf
Definition: specctra.h:221
void Clear()
Clear the buffer and empties the internal string.
Definition: richio.h:425

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

Member Data Documentation

◆ fromText

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

Definition at line 2487 of file specctra.h.

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

◆ fromto_type

DSN_T DSN::FROMTO::fromto_type
private

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

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

◆ net_id

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

Definition at line 2491 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

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

◆ rules

RULE* DSN::FROMTO::rules
private

Definition at line 2492 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

◆ toText

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

Definition at line 2488 of file specctra.h.

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

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