KiCad PCB EDA Suite
DSN::CLASS Class Reference

Class CLASS corresponds to the <class_descriptor> in the specctra spec. More...

#include <specctra.h>

Inheritance diagram for DSN::CLASS:
DSN::ELEM

Public Member Functions

 CLASS (ELEM *aParent)
 
 ~CLASS ()
 
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 class_id
 
STRINGS net_ids
 
STRINGS circuit
 circuit descriptor list More...
 
RULErules
 
LAYER_RULES layer_rules
 
TOPOLOGYtopology
 

Friends

class SPECCTRA_DB
 

Detailed Description

Class CLASS corresponds to the <class_descriptor> in the specctra spec.

Definition at line 2721 of file specctra.h.

Constructor & Destructor Documentation

DSN::CLASS::CLASS ( ELEM aParent)
inline

Definition at line 2740 of file specctra.h.

2740  :
2741  ELEM( T_class, aParent )
2742  {
2743  rules = 0;
2744  topology = 0;
2745  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3490
RULE * rules
Definition: specctra.h:2732
TOPOLOGY * topology
Definition: specctra.h:2736
DSN::CLASS::~CLASS ( )
inline

Definition at line 2746 of file specctra.h.

References rules, and topology.

2747  {
2748  delete rules;
2749  delete topology;
2750  }
RULE * rules
Definition: specctra.h:2732
TOPOLOGY * topology
Definition: specctra.h:2736

Member Function Documentation

void DSN::CLASS::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 2753 of file specctra.h.

References DSN::ELEM::Format(), DSN::RULE::Format(), OUTPUTFORMATTER::GetQuoteChar(), DSN::ELEM::Name(), OUTPUTFORMATTER::Print(), and topology.

2754  {
2755  const char* quote = out->GetQuoteChar( class_id.c_str() );
2756 
2757  int perLine = out->Print( nestLevel, "(%s %s%s%s",
2758  Name(),
2759  quote, class_id.c_str(), quote );
2760 
2761  const int RIGHTMARGIN = 72;
2762 
2763  for( STRINGS::iterator i=net_ids.begin(); i!=net_ids.end(); ++i )
2764  {
2765  const char* space = " ";
2766  if( perLine > RIGHTMARGIN )
2767  {
2768  out->Print( 0, "\n" );
2769  perLine = out->Print( nestLevel+1, "%s", "" );
2770  space = ""; // no space at first net_id of the line
2771  }
2772 
2773  quote = out->GetQuoteChar( i->c_str() );
2774  perLine += out->Print( 0, "%s%s%s%s", space, quote, i->c_str(), quote );
2775  }
2776 
2777  bool newLine = false;
2778  if( circuit.size() || rules || layer_rules.size() || topology )
2779  {
2780  out->Print( 0, "\n" );
2781  newLine = true;
2782  }
2783 
2784  if( circuit.size() )
2785  {
2786  out->Print( nestLevel+1, "(circuit\n" );
2787  for( STRINGS::iterator i=circuit.begin(); i!=circuit.end(); ++i )
2788  out->Print( nestLevel+2, "%s\n", i->c_str() );
2789  out->Print( nestLevel+1, ")\n" );
2790  }
2791 
2792  if( rules )
2793  rules->Format( out, nestLevel+1 );
2794 
2795  for( LAYER_RULES::iterator i=layer_rules.begin(); i!=layer_rules.end(); ++i )
2796  i->Format( out, nestLevel+1 );
2797 
2798  if( topology )
2799  topology->Format( out, nestLevel+1 );
2800 
2801  out->Print( newLine ? nestLevel : 0, ")\n" );
2802  }
STRINGS circuit
circuit descriptor list
Definition: specctra.h:2730
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
std::string class_id
Definition: specctra.h:2725
const char * Name() const
Definition: specctra.cpp:3501
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:3515
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:327
LAYER_RULES layer_rules
Definition: specctra.h:2734
RULE * rules
Definition: specctra.h:2732
TOPOLOGY * topology
Definition: specctra.h:2736
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
STRINGS net_ids
Definition: specctra.h:2727
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 264 of file specctra.h.

Referenced by DSN::ELEM::Format(), and 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 3506 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().

3507 {
3508  if( parent )
3509  return parent->GetUnits();
3510 
3511  return &UNIT_RES::Default;
3512 }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3506
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:500
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 2723 of file specctra.h.

Member Data Documentation

STRINGS DSN::CLASS::circuit
private

circuit descriptor list

Definition at line 2730 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doCLASS(), and DSN::SPECCTRA_DB::exportNETCLASS().

std::string DSN::CLASS::class_id
private

Definition at line 2725 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doCLASS(), and DSN::SPECCTRA_DB::exportNETCLASS().

LAYER_RULES DSN::CLASS::layer_rules
private

Definition at line 2734 of file specctra.h.

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

STRINGS DSN::CLASS::net_ids
private

Definition at line 2727 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doCLASS(), and DSN::SPECCTRA_DB::exportNETCLASS().

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

RULE* DSN::CLASS::rules
private
STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

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

TOPOLOGY* DSN::CLASS::topology
private

Definition at line 2736 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doCLASS(), Format(), and ~CLASS().

DSN_T DSN::ELEM::type
protectedinherited

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