KiCad PCB EDA Suite
DSN::CLASS Class Reference

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
 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 class_id
 
STRINGS net_ids
 
STRINGS circuit
 circuit descriptor list More...
 
RULErules
 
LAYER_RULES layer_rules
 
TOPOLOGYtopology
 

Friends

class SPECCTRA_DB
 

Detailed Description

The <class_descriptor> in the specctra spec.

Definition at line 2753 of file specctra.h.

Constructor & Destructor Documentation

◆ CLASS()

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

Definition at line 2756 of file specctra.h.

2756  :
2757  ELEM( T_class, aParent )
2758  {
2759  rules = 0;
2760  topology = 0;
2761  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749
RULE * rules
Definition: specctra.h:2832
TOPOLOGY * topology
Definition: specctra.h:2836

References rules, and topology.

◆ ~CLASS()

DSN::CLASS::~CLASS ( )
inline

Definition at line 2763 of file specctra.h.

2764  {
2765  delete rules;
2766  delete topology;
2767  }
RULE * rules
Definition: specctra.h:2832
TOPOLOGY * topology
Definition: specctra.h:2836

References rules, and topology.

Member Function Documentation

◆ Format()

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

2770  {
2771  const char* quote = out->GetQuoteChar( class_id.c_str() );
2772 
2773  int perLine = out->Print( nestLevel, "(%s %s%s%s", Name(), quote, class_id.c_str(), quote );
2774 
2775  const int RIGHTMARGIN = 72;
2776 
2777  for( STRINGS::iterator i=net_ids.begin(); i!=net_ids.end(); ++i )
2778  {
2779  const char* space = " ";
2780 
2781  if( perLine > RIGHTMARGIN )
2782  {
2783  out->Print( 0, "\n" );
2784  perLine = out->Print( nestLevel+1, "%s", "" );
2785  space = ""; // no space at first net_id of the line
2786  }
2787 
2788  quote = out->GetQuoteChar( i->c_str() );
2789  perLine += out->Print( 0, "%s%s%s%s", space, quote, i->c_str(), quote );
2790  }
2791 
2792  bool newLine = false;
2793 
2794  if( circuit.size() || rules || layer_rules.size() || topology )
2795  {
2796  out->Print( 0, "\n" );
2797  newLine = true;
2798  }
2799 
2800  if( circuit.size() )
2801  {
2802  out->Print( nestLevel+1, "(circuit\n" );
2803 
2804  for( STRINGS::iterator i = circuit.begin(); i != circuit.end(); ++i )
2805  out->Print( nestLevel + 2, "%s\n", i->c_str() );
2806 
2807  out->Print( nestLevel+1, ")\n" );
2808  }
2809 
2810  if( rules )
2811  rules->Format( out, nestLevel+1 );
2812 
2813  for( LAYER_RULES::iterator i = layer_rules.begin(); i != layer_rules.end(); ++i )
2814  i->Format( out, nestLevel + 1 );
2815 
2816  if( topology )
2817  topology->Format( out, nestLevel+1 );
2818 
2819  out->Print( newLine ? nestLevel : 0, ")\n" );
2820  }
STRINGS circuit
circuit descriptor list
Definition: specctra.h:2830
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
std::string class_id
Definition: specctra.h:2825
virtual void Format(OUTPUTFORMATTER *out, int nestLevel)
Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.cpp:3774
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
LAYER_RULES layer_rules
Definition: specctra.h:2834
RULE * rules
Definition: specctra.h:2832
TOPOLOGY * topology
Definition: specctra.h:2836
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426
STRINGS net_ids
Definition: specctra.h:2827

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

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

Member Data Documentation

◆ circuit

STRINGS DSN::CLASS::circuit
private

circuit descriptor list

Definition at line 2830 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 2834 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 276 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 273 of file specctra.h.

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

◆ topology

TOPOLOGY* DSN::CLASS::topology
private

Definition at line 2836 of file specctra.h.

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

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