KiCad PCB EDA Suite
DSN::WIRE_VIA Class Reference

Class 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 throw ( IO_ERROR )
 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) throw ( IO_ERROR )
 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

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

Definition at line 2954 of file specctra.h.

Constructor & Destructor Documentation

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

Definition at line 2970 of file specctra.h.

References DSN::T_NONE.

2970  :
2971  ELEM( T_via, aParent )
2972  {
2973  via_number = -1;
2974  via_type = T_NONE;
2975  attr = T_NONE;
2976  supply = false;
2977  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3486
DSN_T via_type
Definition: specctra.h:2962

Member Function Documentation

void DSN::WIRE_VIA::Format ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
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 2984 of file specctra.h.

References DSN::GetTokenText(), DSN::ELEM::Name(), supply, DSN::T_NONE, and DSN::T_virtual_pin.

2985  {
2986  const char* quote = out->GetQuoteChar( padstack_id.c_str() );
2987 
2988  const int RIGHTMARGIN = 80;
2989  int perLine = out->Print( nestLevel, "(%s %s%s%s",
2990  Name(),
2991  quote, padstack_id.c_str(), quote );
2992 
2993  for( POINTS::iterator i=vertexes.begin(); i!=vertexes.end(); ++i )
2994  {
2995  if( perLine > RIGHTMARGIN )
2996  {
2997  out->Print( 0, "\n" );
2998  perLine = out->Print( nestLevel+1, "%s", "" );
2999  }
3000  else
3001  perLine += out->Print( 0, " " );
3002 
3003  perLine += out->Print( 0, "%.6g %.6g", i->x, i->y );
3004  }
3005 
3006  if( net_id.size() || via_number!=-1 || via_type!=T_NONE || attr!=T_NONE || supply)
3007  out->Print( 0, " " );
3008 
3009  if( net_id.size() )
3010  {
3011  if( perLine > RIGHTMARGIN )
3012  {
3013  out->Print( 0, "\n" );
3014  perLine = out->Print( nestLevel+1, "%s", "" );
3015  }
3016  quote = out->GetQuoteChar( net_id.c_str() );
3017  perLine += out->Print( 0, "(net %s%s%s)", quote, net_id.c_str(), quote );
3018  }
3019 
3020  if( via_number != -1 )
3021  {
3022  if( perLine > RIGHTMARGIN )
3023  {
3024  out->Print( 0, "\n" );
3025  perLine = out->Print( nestLevel+1, "%s", "" );
3026  }
3027  perLine += out->Print( 0, "(via_number %d)", via_number );
3028  }
3029 
3030  if( via_type != T_NONE )
3031  {
3032  if( perLine > RIGHTMARGIN )
3033  {
3034  out->Print( 0, "\n" );
3035  perLine = out->Print( nestLevel+1, "%s", "" );
3036  }
3037  perLine += out->Print( 0, "(type %s)", GetTokenText( via_type ) );
3038  }
3039 
3040  if( attr != T_NONE )
3041  {
3042  if( perLine > RIGHTMARGIN )
3043  {
3044  out->Print( 0, "\n" );
3045  perLine = out->Print( nestLevel+1, "%s", "" );
3046  }
3047  if( attr == T_virtual_pin )
3048  {
3049  quote = out->GetQuoteChar( virtual_pin_name.c_str() );
3050  perLine += out->Print( 0, "(attr virtual_pin %s%s%s)",
3051  quote, virtual_pin_name.c_str(), quote );
3052  }
3053  else
3054  perLine += out->Print( 0, "(attr %s)", GetTokenText( attr ) );
3055  }
3056 
3057  if( supply )
3058  {
3059  if( perLine > RIGHTMARGIN )
3060  {
3061  out->Print( 0, "\n" );
3062  perLine = out->Print( nestLevel+1, "%s", "" );
3063  }
3064  perLine += out->Print( 0, "(supply)" );
3065  }
3066 
3067  if( contact_layers.size() )
3068  {
3069  out->Print( 0, "\n" );
3070  out->Print( nestLevel+1, "(contact\n" );
3071 
3072  for( STRINGS::iterator i=contact_layers.begin(); i!=contact_layers.end(); ++i )
3073  {
3074  quote = out->GetQuoteChar( i->c_str() );
3075  out->Print( nestLevel+2, "%s%s%s\n", quote, i->c_str(), quote );
3076  }
3077  out->Print( nestLevel+1, "))\n" );
3078  }
3079  else
3080  out->Print( 0, ")\n" );
3081  }
POINTS vertexes
Definition: specctra.h:2959
std::string net_id
Definition: specctra.h:2960
DSN_T via_type
Definition: specctra.h:2962
const char * Name() const
Definition: specctra.cpp:3497
std::string padstack_id
Definition: specctra.h:2958
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:331
STRINGS contact_layers
Definition: specctra.h:2965
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:2964
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
virtual void DSN::ELEM::FormatContents ( OUTPUTFORMATTER out,
int  nestLevel 
)
throw (IO_ERROR
)
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::makeHash().

265  {
266  // overridden in ELEM_HOLDER
267  }
const std::string& DSN::WIRE_VIA::GetPadstackId ( )
inline

Definition at line 2979 of file specctra.h.

References padstack_id.

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

2980  {
2981  return padstack_id;
2982  }
std::string padstack_id
Definition: specctra.h:2958
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 3502 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().

3503 {
3504  if( parent )
3505  return parent->GetUnits();
3506 
3507  return &UNIT_RES::Default;
3508 }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3502
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:504
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 2956 of file specctra.h.

Member Data Documentation

DSN_T DSN::WIRE_VIA::attr
private

Definition at line 2963 of file specctra.h.

STRINGS DSN::WIRE_VIA::contact_layers
private

Definition at line 2965 of file specctra.h.

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

Definition at line 2960 of file specctra.h.

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

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

Definition at line 2958 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::FromBOARD(), and GetPadstackId().

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

bool DSN::WIRE_VIA::supply
private

Definition at line 2966 of file specctra.h.

Referenced by Format().

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 199 of file specctra.h.

Referenced by DSN::ELEM::Name(), and DSN::ELEM::Type().

POINTS DSN::WIRE_VIA::vertexes
private

Definition at line 2959 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::FromBOARD(), and DSN::SPECCTRA_DB::FromSESSION().

int DSN::WIRE_VIA::via_number
private

Definition at line 2961 of file specctra.h.

DSN_T DSN::WIRE_VIA::via_type
private

Definition at line 2962 of file specctra.h.

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

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

Definition at line 2964 of file specctra.h.


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