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 throw ( IO_ERROR )
 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) throw ( IO_ERROR )
 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 2459 of file specctra.h.

Constructor & Destructor Documentation

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

Definition at line 2474 of file specctra.h.

References DSN::T_NONE.

2474  :
2475  ELEM( T_fromto, aParent )
2476  {
2477  rules = 0;
2478  fromto_type = DSN_T( T_NONE );
2479  }
DSN_T fromto_type
Definition: specctra.h:2466
DSN::T DSN_T
Definition: specctra.h:47
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3486
RULE * rules
Definition: specctra.h:2468
DSN::FROMTO::~FROMTO ( )
inline

Definition at line 2480 of file specctra.h.

References rules.

2481  {
2482  delete rules;
2483  }
RULE * rules
Definition: specctra.h:2468

Member Function Documentation

void DSN::FROMTO::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
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 2485 of file specctra.h.

References DSN::RULE::Format(), DSN::GetTokenText(), DSN::ELEM::Name(), and DSN::T_NONE.

2486  {
2487  // no quoting on these two, the lexer preserved the quotes on input
2488  out->Print( nestLevel, "(%s %s %s ",
2489  Name(), fromText.c_str(), toText.c_str() );
2490 
2491  if( fromto_type != DSN_T( T_NONE ) )
2492  out->Print( 0, "(type %s)", GetTokenText( fromto_type ) );
2493 
2494  if( net_id.size() )
2495  {
2496  const char* quote = out->GetQuoteChar( net_id.c_str() );
2497  out->Print( 0, "(net %s%s%s)", quote, net_id.c_str(), quote );
2498  }
2499 
2500  bool singleLine = true;
2501 
2502  if( rules || layer_rules.size() )
2503  {
2504  out->Print( 0, "\n" );
2505  singleLine = false;
2506  }
2507 
2508  if( rules )
2509  rules->Format( out, nestLevel+1 );
2510 
2511  /*
2512  if( circuit.size() )
2513  out->Print( nestLevel, "%s\n", circuit.c_str() );
2514  */
2515 
2516  for( LAYER_RULES::iterator i=layer_rules.begin(); i!=layer_rules.end(); ++i )
2517  i->Format( out, nestLevel+1 );
2518 
2519  out->Print( singleLine ? 0 : nestLevel, ")" );
2520  if( nestLevel || !singleLine )
2521  out->Print( 0, "\n" );
2522  }
DSN_T fromto_type
Definition: specctra.h:2466
DSN::T DSN_T
Definition: specctra.h:47
RULE * rules
Definition: specctra.h:2468
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:505
const char * Name() const
Definition: specctra.cpp:3497
LAYER_RULES layer_rules
Definition: specctra.h:2470
std::string net_id
Definition: specctra.h:2467
std::string fromText
Definition: specctra.h:2463
static const char * GetQuoteChar(const char *wrapee, const char *quote_char)
Function GetQuoteChar performs quote character need determination according to the Specctra DSN speci...
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,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
std::string toText
Definition: specctra.h:2464
virtual void DSN::ELEM::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
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 264 of file specctra.h.

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

265  {
266  // overridden in ELEM_HOLDER
267  }
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 3502 of file specctra.cpp.

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

3503 {
3504  if( parent )
3505  return parent->GetUnits();
3506 
3507  return &UNIT_RES::Default;
3508 }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3502
ELEM * parent
Definition: specctra.h:200
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:414
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:504
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 2461 of file specctra.h.

Member Data Documentation

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

Definition at line 2463 of file specctra.h.

DSN_T DSN::FROMTO::fromto_type
private

Definition at line 2466 of file specctra.h.

LAYER_RULES DSN::FROMTO::layer_rules
private

Definition at line 2470 of file specctra.h.

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

Definition at line 2467 of file specctra.h.

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

RULE* DSN::FROMTO::rules
private

Definition at line 2468 of file specctra.h.

Referenced by ~FROMTO().

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

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

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

Definition at line 2464 of file specctra.h.

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 199 of file specctra.h.

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


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