KiCad PCB EDA Suite
DSN::VIA Class Reference

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

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

Definition at line 1024 of file specctra.h.

Constructor & Destructor Documentation

◆ VIA()

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

Definition at line 1033 of file specctra.h.

1033  :
1034  ELEM( T_via, aParent )
1035  {
1036  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494

Member Function Documentation

◆ AppendVia()

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

Definition at line 1038 of file specctra.h.

1039  {
1040  padstacks.push_back( aViaName );
1041  }
STRINGS padstacks
Definition: specctra.h:1028

References padstacks.

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

◆ Format()

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

1044  {
1045  const int RIGHTMARGIN = 80;
1046  int perLine = out->Print( nestLevel, "(%s", Name() );
1047 
1048  for( STRINGS::iterator i = padstacks.begin(); i != padstacks.end(); ++i )
1049  {
1050  if( perLine > RIGHTMARGIN )
1051  {
1052  out->Print( 0, "\n" );
1053  perLine = out->Print( nestLevel+1, "%s", "");
1054  }
1055 
1056  const char* quote = out->GetQuoteChar( i->c_str() );
1057  perLine += out->Print( 0, " %s%s%s", quote, i->c_str(), quote );
1058  }
1059 
1060  if( spares.size() )
1061  {
1062  out->Print( 0, "\n" );
1063 
1064  perLine = out->Print( nestLevel+1, "(spare" );
1065 
1066  for( STRINGS::iterator i = spares.begin(); i != spares.end(); ++i )
1067  {
1068  if( perLine > RIGHTMARGIN )
1069  {
1070  out->Print( 0, "\n" );
1071  perLine = out->Print( nestLevel+2, "%s", "");
1072  }
1073 
1074  const char* quote = out->GetQuoteChar( i->c_str() );
1075  perLine += out->Print( 0, " %s%s%s", quote, i->c_str(), quote );
1076  }
1077 
1078  out->Print( 0, ")" );
1079  }
1080 
1081  out->Print( 0, ")\n" );
1082  }
STRINGS padstacks
Definition: specctra.h:1028
const char * Name() const
Definition: specctra.cpp:3505
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
STRINGS spares
Definition: specctra.h:1029
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408

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

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

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

Member Data Documentation

◆ padstacks

STRINGS DSN::VIA::padstacks
private

Definition at line 1028 of file specctra.h.

Referenced by AppendVia(), DSN::SPECCTRA_DB::doVIA(), and Format().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

Referenced by DSN::ELEM::GetUnits(), and DSN::ELEM::SetParent().

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

◆ spares

STRINGS DSN::VIA::spares
private

Definition at line 1029 of file specctra.h.

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

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