KiCad PCB EDA Suite
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | Friends | List of all members
DSN::VIA Class Reference

A <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
 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_RES * GetUnits () 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
 
ELEM * parent
 

Static Protected Attributes

static STRING_FORMATTER sf
 

Private Attributes

STRINGS padstacks
 
STRINGS spares
 

Friends

class SPECCTRA_DB
 

Detailed Description

A <via_descriptor> in the specctra dsn spec.

Definition at line 1038 of file specctra.h.

Constructor & Destructor Documentation

◆ VIA()

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

Definition at line 1042 of file specctra.h.

1042  :
1043  ELEM( T_via, aParent )
1044  {
1045  }
DSN::ELEM::ELEM
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749

Member Function Documentation

◆ AppendVia()

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

Definition at line 1047 of file specctra.h.

1048  {
1049  padstacks.push_back( aViaName );
1050  }
DSN::VIA::padstacks
STRINGS padstacks
Definition: specctra.h:1096

References padstacks.

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

◆ Format()

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

1053  {
1054  const int RIGHTMARGIN = 80;
1055  int perLine = out->Print( nestLevel, "(%s", Name() );
1056 
1057  for( STRINGS::iterator i = padstacks.begin(); i != padstacks.end(); ++i )
1058  {
1059  if( perLine > RIGHTMARGIN )
1060  {
1061  out->Print( 0, "\n" );
1062  perLine = out->Print( nestLevel+1, "%s", "");
1063  }
1064 
1065  const char* quote = out->GetQuoteChar( i->c_str() );
1066  perLine += out->Print( 0, " %s%s%s", quote, i->c_str(), quote );
1067  }
1068 
1069  if( spares.size() )
1070  {
1071  out->Print( 0, "\n" );
1072 
1073  perLine = out->Print( nestLevel+1, "(spare" );
1074 
1075  for( STRINGS::iterator i = spares.begin(); i != spares.end(); ++i )
1076  {
1077  if( perLine > RIGHTMARGIN )
1078  {
1079  out->Print( 0, "\n" );
1080  perLine = out->Print( nestLevel+2, "%s", "");
1081  }
1082 
1083  const char* quote = out->GetQuoteChar( i->c_str() );
1084  perLine += out->Print( 0, " %s%s%s", quote, i->c_str(), quote );
1085  }
1086 
1087  out->Print( 0, ")" );
1088  }
1089 
1090  out->Print( 0, ")\n" );
1091  }
DSN::VIA::padstacks
STRINGS padstacks
Definition: specctra.h:1096
DSN::ELEM::Name
const char * Name() const
Definition: specctra.cpp:3760
OUTPUTFORMATTER::GetQuoteChar
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
DSN::VIA::spares
STRINGS spares
Definition: specctra.h:1097
OUTPUTFORMATTER::Print
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426

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

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 }
DSN::ELEM::parent
ELEM * parent
Definition: specctra.h:276
DSN::UNIT_RES::Default
static UNIT_RES Default
A static instance which holds the default units of T_inch and 2540000.
Definition: specctra.h:410
DSN::ELEM::GetUnits
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  }
DSN::ELEM::FormatContents
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
STRING_FORMATTER::GetString
const std::string & GetString()
Definition: richio.h:438
STRING_FORMATTER::StripUseless
void StripUseless()
Removes whitespace, '(', and ')' from the string.
Definition: richio.cpp:512
DSN::ELEM::sf
static STRING_FORMATTER sf
Definition: specctra.h:273
STRING_FORMATTER::Clear
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()

const char * DSN::ELEM::Name ( ) const
inherited

Definition at line 3760 of file specctra.cpp.

3761 {
3762  return SPECCTRA_DB::TokenName( type );
3763 }
DSN::ELEM::type
DSN_T type
Definition: specctra.h:275

References DSN::ELEM::type.

Referenced by DSN::ELEM::Format(), DSN::UNIT_RES::Format(), DSN::RECTANGLE::Format(), DSN::RULE::Format(), DSN::LAYER_RULE::Format(), DSN::PATH::Format(), DSN::BOUNDARY::Format(), DSN::CIRCLE::Format(), DSN::QARC::Format(), DSN::WINDOW::Format(), DSN::KEEPOUT::Format(), Format(), DSN::CONTROL::Format(), DSN::LAYER::Format(), DSN::SPECCTRA_LAYER_PAIR::Format(), DSN::LAYER_NOISE_WEIGHT::Format(), DSN::TOKPROP::Format(), DSN::STRINGPROP::Format(), DSN::GRID::Format(), DSN::PLACE::Format(), DSN::COMPONENT::Format(), DSN::SHAPE::Format(), DSN::IMAGE::Format(), DSN::PADSTACK::Format(), DSN::FROMTO::Format(), DSN::COMP_ORDER::Format(), DSN::NET::Format(), DSN::CLASS::Format(), DSN::WIRE::Format(), DSN::WIRE_VIA::Format(), DSN::PCB::Format(), DSN::ANCESTOR::Format(), DSN::SUPPLY_PIN::Format(), and DSN::SESSION::Format().

◆ SetParent()

void DSN::ELEM::SetParent ( ELEM *  aParent)
inlineinherited

Definition at line 247 of file specctra.h.

248  {
249  parent = aParent;
250  }
DSN::ELEM::parent
ELEM * parent
Definition: specctra.h:276

References DSN::ELEM::parent.

Referenced by DSN::LIBRARY::AddPadstack(), DSN::KEEPOUT::AddWindow(), DSN::LIBRARY::AppendIMAGE(), DSN::LIBRARY::AppendPADSTACK(), DSN::LIBRARY::AppendVia(), DSN::STRUCTURE::SetBOUNDARY(), DSN::STRUCTURE::SetPlaceBOUNDARY(), DSN::WINDOW::SetShape(), DSN::KEEPOUT::SetShape(), and DSN::WIRE::SetShape().

◆ Type()

DSN_T DSN::ELEM::Type ( ) const
inlineinherited

Definition at line 210 of file specctra.h.

210 { return type; }
DSN::ELEM::type
DSN_T type
Definition: specctra.h:275

References DSN::ELEM::type.

Referenced by DSN::SPECCTRA_DB::doCLASS_CLASS(), DSN::ELEM_HOLDER::FindElem(), DSN::SPECCTRA_DB::FromSESSION(), DSN::SPECCTRA_DB::makeVIA(), DSN::WINDOW::SetShape(), DSN::KEEPOUT::SetShape(), and DSN::WIRE::SetShape().

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 1094 of file specctra.h.

Member Data Documentation

◆ padstacks

STRINGS DSN::VIA::padstacks
private

Definition at line 1096 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 276 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 273 of file specctra.h.

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

◆ spares

STRINGS DSN::VIA::spares
private

Definition at line 1097 of file specctra.h.

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

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