KiCad PCB EDA Suite
DSN::SUPPLY_PIN Class Reference

SUPPLY_PIN corresponds to the <supply_pin_descriptor> in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::SUPPLY_PIN:
DSN::ELEM

Public Member Functions

 SUPPLY_PIN (ELEM *aParent)
 
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

PIN_REFS pin_refs
 
std::string net_id
 

Friends

class SPECCTRA_DB
 

Detailed Description

SUPPLY_PIN corresponds to the <supply_pin_descriptor> in the specctra dsn spec.

Definition at line 3339 of file specctra.h.

Constructor & Destructor Documentation

◆ SUPPLY_PIN()

DSN::SUPPLY_PIN::SUPPLY_PIN ( ELEM aParent)
inline

Definition at line 3347 of file specctra.h.

3347  :
3348  ELEM( T_supply_pin, aParent )
3349  {
3350  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494

Member Function Documentation

◆ Format()

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

3353  {
3354  bool singleLine = pin_refs.size() <= 1;
3355  out->Print( nestLevel, "(%s", Name() );
3356 
3357  if( singleLine )
3358  {
3359  out->Print( 0, "%s", " " );
3360  pin_refs.begin()->Format( out, 0 );
3361  }
3362  else
3363  {
3364  for( PIN_REFS::iterator i=pin_refs.begin(); i!=pin_refs.end(); ++i )
3365  i->FormatIt( out, nestLevel+1 );
3366  }
3367 
3368  if( net_id.size() )
3369  {
3370  const char* newline = singleLine ? "" : "\n";
3371 
3372  const char* quote = out->GetQuoteChar( net_id.c_str() );
3373  out->Print( singleLine ? 0 : nestLevel+1,
3374  " (net %s%s%s)%s", quote, net_id.c_str(), quote, newline );
3375  }
3376 
3377  out->Print( singleLine ? 0 : nestLevel, ")\n");
3378  }
PIN_REFS pin_refs
Definition: specctra.h:3343
const char * Name() const
Definition: specctra.cpp:3505
std::string net_id
Definition: specctra.h:3344
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
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(), net_id, pin_refs, and OUTPUTFORMATTER::Print().

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

Member Data Documentation

◆ net_id

std::string DSN::SUPPLY_PIN::net_id
private

Definition at line 3344 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doSUPPLY_PIN(), 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().

◆ pin_refs

PIN_REFS DSN::SUPPLY_PIN::pin_refs
private

Definition at line 3343 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

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