KiCad PCB EDA Suite
DSN::VIA Class Reference

Class VIA corresponds to the <via_descriptor> in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::VIA:
DSN::ELEM

Public Member Functions

 VIA (ELEM *aParent)
 
void AppendVia (const char *aViaName)
 
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

STRINGS padstacks
 
STRINGS spares
 

Friends

class SPECCTRA_DB
 

Detailed Description

Class VIA corresponds to the <via_descriptor> in the specctra dsn spec.

Definition at line 1011 of file specctra.h.

Constructor & Destructor Documentation

DSN::VIA::VIA ( ELEM aParent)
inline

Definition at line 1020 of file specctra.h.

1020  :
1021  ELEM( T_via, aParent )
1022  {
1023  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3490

Member Function Documentation

void DSN::VIA::AppendVia ( const char *  aViaName)
inline

Definition at line 1025 of file specctra.h.

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

1026  {
1027  padstacks.push_back( aViaName );
1028  }
STRINGS padstacks
Definition: specctra.h:1015
void DSN::VIA::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 1030 of file specctra.h.

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

Referenced by DSN::STRUCTURE::FormatContents().

1031  {
1032  const int RIGHTMARGIN = 80;
1033  int perLine = out->Print( nestLevel, "(%s", Name() );
1034 
1035  for( STRINGS::iterator i=padstacks.begin(); i!=padstacks.end(); ++i )
1036  {
1037  if( perLine > RIGHTMARGIN )
1038  {
1039  out->Print( 0, "\n" );
1040  perLine = out->Print( nestLevel+1, "%s", "");
1041  }
1042 
1043  const char* quote = out->GetQuoteChar( i->c_str() );
1044  perLine += out->Print( 0, " %s%s%s", quote, i->c_str(), quote );
1045  }
1046 
1047  if( spares.size() )
1048  {
1049  out->Print( 0, "\n" );
1050 
1051  perLine = out->Print( nestLevel+1, "(spare" );
1052 
1053  for( STRINGS::iterator i=spares.begin(); i!=spares.end(); ++i )
1054  {
1055  if( perLine > RIGHTMARGIN )
1056  {
1057  out->Print( 0, "\n" );
1058  perLine = out->Print( nestLevel+2, "%s", "");
1059  }
1060  const char* quote = out->GetQuoteChar( i->c_str() );
1061  perLine += out->Print( 0, " %s%s%s", quote, i->c_str(), quote );
1062  }
1063 
1064  out->Print( 0, ")" );
1065  }
1066 
1067  out->Print( 0, ")\n" );
1068  }
STRINGS padstacks
Definition: specctra.h:1015
const char * Name() const
Definition: specctra.cpp:3501
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
STRINGS spares
Definition: specctra.h:1016
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
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 1013 of file specctra.h.

Member Data Documentation

STRINGS DSN::VIA::padstacks
private

Definition at line 1015 of file specctra.h.

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

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

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

STRINGS DSN::VIA::spares
private

Definition at line 1016 of file specctra.h.

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

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: