KiCad PCB EDA Suite
DSN::CLASS Class Reference

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 corresponds to the <class_descriptor> in the specctra spec.

Definition at line 2747 of file specctra.h.

Constructor & Destructor Documentation

◆ CLASS()

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

Definition at line 2766 of file specctra.h.

2766  :
2767  ELEM( T_class, aParent )
2768  {
2769  rules = 0;
2770  topology = 0;
2771  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
RULE * rules
Definition: specctra.h:2758
TOPOLOGY * topology
Definition: specctra.h:2762

References rules, and topology.

◆ ~CLASS()

DSN::CLASS::~CLASS ( )
inline

Definition at line 2772 of file specctra.h.

2773  {
2774  delete rules;
2775  delete topology;
2776  }
RULE * rules
Definition: specctra.h:2758
TOPOLOGY * topology
Definition: specctra.h:2762

References rules, and topology.

Member Function Documentation

◆ Format()

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

2780  {
2781  const char* quote = out->GetQuoteChar( class_id.c_str() );
2782 
2783  int perLine = out->Print( nestLevel, "(%s %s%s%s",
2784  Name(),
2785  quote, class_id.c_str(), quote );
2786 
2787  const int RIGHTMARGIN = 72;
2788 
2789  for( STRINGS::iterator i=net_ids.begin(); i!=net_ids.end(); ++i )
2790  {
2791  const char* space = " ";
2792  if( perLine > RIGHTMARGIN )
2793  {
2794  out->Print( 0, "\n" );
2795  perLine = out->Print( nestLevel+1, "%s", "" );
2796  space = ""; // no space at first net_id of the line
2797  }
2798 
2799  quote = out->GetQuoteChar( i->c_str() );
2800  perLine += out->Print( 0, "%s%s%s%s", space, quote, i->c_str(), quote );
2801  }
2802 
2803  bool newLine = false;
2804  if( circuit.size() || rules || layer_rules.size() || topology )
2805  {
2806  out->Print( 0, "\n" );
2807  newLine = true;
2808  }
2809 
2810  if( circuit.size() )
2811  {
2812  out->Print( nestLevel+1, "(circuit\n" );
2813  for( STRINGS::iterator i=circuit.begin(); i!=circuit.end(); ++i )
2814  out->Print( nestLevel+2, "%s\n", i->c_str() );
2815  out->Print( nestLevel+1, ")\n" );
2816  }
2817 
2818  if( rules )
2819  rules->Format( out, nestLevel+1 );
2820 
2821  for( LAYER_RULES::iterator i=layer_rules.begin(); i!=layer_rules.end(); ++i )
2822  i->Format( out, nestLevel+1 );
2823 
2824  if( topology )
2825  topology->Format( out, nestLevel+1 );
2826 
2827  out->Print( newLine ? nestLevel : 0, ")\n" );
2828  }
STRINGS circuit
circuit descriptor list
Definition: specctra.h:2756
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
std::string class_id
Definition: specctra.h:2751
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:3519
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
LAYER_RULES layer_rules
Definition: specctra.h:2760
RULE * rules
Definition: specctra.h:2758
TOPOLOGY * topology
Definition: specctra.h:2762
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408
STRINGS net_ids
Definition: specctra.h:2753

References circuit, class_id, DSN::ELEM::Format(), DSN::RULE::Format(), OUTPUTFORMATTER::GetQuoteChar(), layer_rules, DSN::ELEM::Name(), net_ids, OUTPUTFORMATTER::Print(), rules, and topology.

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

Member Data Documentation

◆ circuit

STRINGS DSN::CLASS::circuit
private

circuit descriptor list

Definition at line 2756 of file specctra.h.

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

◆ class_id

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

◆ layer_rules

LAYER_RULES DSN::CLASS::layer_rules
private

Definition at line 2760 of file specctra.h.

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

◆ net_ids

STRINGS DSN::CLASS::net_ids
private

◆ 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::CLASS::rules
private

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

◆ topology

TOPOLOGY* DSN::CLASS::topology
private

Definition at line 2762 of file specctra.h.

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

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