KiCad PCB EDA Suite
DSN::WIRE_VIA Class Reference

WIRE_VIA corresponds to <wire_via_descriptor> in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::WIRE_VIA:
DSN::ELEM

Public Member Functions

 WIRE_VIA (ELEM *aParent)
 
const std::string & GetPadstackId ()
 
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 padstack_id
 
POINTS vertexes
 
std::string net_id
 
int via_number
 
DSN_T via_type
 
DSN_T attr
 
std::string virtual_pin_name
 
STRINGS contact_layers
 
bool supply
 

Friends

class SPECCTRA_DB
 

Detailed Description

WIRE_VIA corresponds to <wire_via_descriptor> in the specctra dsn spec.

Definition at line 2983 of file specctra.h.

Constructor & Destructor Documentation

◆ WIRE_VIA()

DSN::WIRE_VIA::WIRE_VIA ( ELEM aParent)
inline

Definition at line 2999 of file specctra.h.

2999  :
3000  ELEM( T_via, aParent )
3001  {
3002  via_number = -1;
3003  via_type = T_NONE;
3004  attr = T_NONE;
3005  supply = false;
3006  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
DSN_T via_type
Definition: specctra.h:2991

References attr, supply, via_number, and via_type.

Member Function Documentation

◆ Format()

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

3014  {
3015  const char* quote = out->GetQuoteChar( padstack_id.c_str() );
3016 
3017  const int RIGHTMARGIN = 80;
3018  int perLine = out->Print( nestLevel, "(%s %s%s%s",
3019  Name(),
3020  quote, padstack_id.c_str(), quote );
3021 
3022  for( POINTS::iterator i=vertexes.begin(); i!=vertexes.end(); ++i )
3023  {
3024  if( perLine > RIGHTMARGIN )
3025  {
3026  out->Print( 0, "\n" );
3027  perLine = out->Print( nestLevel+1, "%s", "" );
3028  }
3029  else
3030  perLine += out->Print( 0, " " );
3031 
3032  perLine += out->Print( 0, "%.6g %.6g", i->x, i->y );
3033  }
3034 
3035  if( net_id.size() || via_number!=-1 || via_type!=T_NONE || attr!=T_NONE || supply)
3036  out->Print( 0, " " );
3037 
3038  if( net_id.size() )
3039  {
3040  if( perLine > RIGHTMARGIN )
3041  {
3042  out->Print( 0, "\n" );
3043  perLine = out->Print( nestLevel+1, "%s", "" );
3044  }
3045  quote = out->GetQuoteChar( net_id.c_str() );
3046  perLine += out->Print( 0, "(net %s%s%s)", quote, net_id.c_str(), quote );
3047  }
3048 
3049  if( via_number != -1 )
3050  {
3051  if( perLine > RIGHTMARGIN )
3052  {
3053  out->Print( 0, "\n" );
3054  perLine = out->Print( nestLevel+1, "%s", "" );
3055  }
3056  perLine += out->Print( 0, "(via_number %d)", via_number );
3057  }
3058 
3059  if( via_type != T_NONE )
3060  {
3061  if( perLine > RIGHTMARGIN )
3062  {
3063  out->Print( 0, "\n" );
3064  perLine = out->Print( nestLevel+1, "%s", "" );
3065  }
3066  perLine += out->Print( 0, "(type %s)", GetTokenText( via_type ) );
3067  }
3068 
3069  if( attr != T_NONE )
3070  {
3071  if( perLine > RIGHTMARGIN )
3072  {
3073  out->Print( 0, "\n" );
3074  perLine = out->Print( nestLevel+1, "%s", "" );
3075  }
3076  if( attr == T_virtual_pin )
3077  {
3078  quote = out->GetQuoteChar( virtual_pin_name.c_str() );
3079  perLine += out->Print( 0, "(attr virtual_pin %s%s%s)",
3080  quote, virtual_pin_name.c_str(), quote );
3081  }
3082  else
3083  perLine += out->Print( 0, "(attr %s)", GetTokenText( attr ) );
3084  }
3085 
3086  if( supply )
3087  {
3088  if( perLine > RIGHTMARGIN )
3089  {
3090  out->Print( 0, "\n" );
3091  perLine = out->Print( nestLevel+1, "%s", "" );
3092  }
3093  perLine += out->Print( 0, "(supply)" );
3094  }
3095 
3096  if( contact_layers.size() )
3097  {
3098  out->Print( 0, "\n" );
3099  out->Print( nestLevel+1, "(contact\n" );
3100 
3101  for( STRINGS::iterator i=contact_layers.begin(); i!=contact_layers.end(); ++i )
3102  {
3103  quote = out->GetQuoteChar( i->c_str() );
3104  out->Print( nestLevel+2, "%s%s%s\n", quote, i->c_str(), quote );
3105  }
3106  out->Print( nestLevel+1, "))\n" );
3107  }
3108  else
3109  out->Print( 0, ")\n" );
3110  }
const char * Name() const
Definition: specctra.cpp:3505
POINTS vertexes
Definition: specctra.h:2988
std::string net_id
Definition: specctra.h:2989
DSN_T via_type
Definition: specctra.h:2991
std::string padstack_id
Definition: specctra.h:2987
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 contact_layers
Definition: specctra.h:2994
const char * GetTokenText(T aTok)
Function GetTokenText is in the DSN namespace and returns the C string representing a SPECCTRA_DB::ke...
Definition: specctra.cpp:69
std::string virtual_pin_name
Definition: specctra.h:2993
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408

References attr, contact_layers, OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), DSN::ELEM::Name(), net_id, padstack_id, OUTPUTFORMATTER::Print(), supply, vertexes, via_number, via_type, and virtual_pin_name.

◆ 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().

◆ GetPadstackId()

const std::string& DSN::WIRE_VIA::GetPadstackId ( )
inline

Definition at line 3008 of file specctra.h.

3009  {
3010  return padstack_id;
3011  }
std::string padstack_id
Definition: specctra.h:2987

References padstack_id.

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

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

Member Data Documentation

◆ attr

DSN_T DSN::WIRE_VIA::attr
private

Definition at line 2992 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRE_VIA(), Format(), and WIRE_VIA().

◆ contact_layers

STRINGS DSN::WIRE_VIA::contact_layers
private

Definition at line 2994 of file specctra.h.

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

◆ net_id

std::string DSN::WIRE_VIA::net_id
private

Definition at line 2989 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRE_VIA(), Format(), and DSN::SPECCTRA_DB::FromBOARD().

◆ padstack_id

std::string DSN::WIRE_VIA::padstack_id
private

◆ 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().

◆ supply

bool DSN::WIRE_VIA::supply
private

Definition at line 2995 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRE_VIA(), Format(), and WIRE_VIA().

◆ 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().

◆ vertexes

POINTS DSN::WIRE_VIA::vertexes
private

◆ via_number

int DSN::WIRE_VIA::via_number
private

Definition at line 2990 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRE_VIA(), Format(), and WIRE_VIA().

◆ via_type

DSN_T DSN::WIRE_VIA::via_type
private

◆ virtual_pin_name

std::string DSN::WIRE_VIA::virtual_pin_name
private

Definition at line 2993 of file specctra.h.

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


The documentation for this class was generated from the following file: