KiCad PCB EDA Suite
DSN::NET Class Reference

NET corresponds to a <net_descriptor> in the DSN spec. More...

#include <specctra.h>

Inheritance diagram for DSN::NET:
DSN::ELEM

Public Member Functions

 NET (ELEM *aParent)
 
 ~NET ()
 
int FindPIN_REF (const std::string &aComponent)
 
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

ELEMparent
 

Static Protected Attributes

static STRING_FORMATTER sf
 

Private Attributes

std::string net_id
 
bool unassigned
 
int net_number
 
DSN_T pins_type
 T_pins | T_order, type of field 'pins' below. More...
 
PIN_REFS pins
 
PIN_REFS expose
 
PIN_REFS noexpose
 
PIN_REFS source
 
PIN_REFS load
 
PIN_REFS terminator
 
DSN_T type
 T_fix | T_normal. More...
 
DSN_T supply
 T_power | T_ground. More...
 
RULErules
 
LAYER_RULES layer_rules
 
FROMTOS fromtos
 
COMP_ORDERcomp_order
 

Friends

class SPECCTRA_DB
 

Detailed Description

NET corresponds to a <net_descriptor> in the DSN spec.

Definition at line 2591 of file specctra.h.

Constructor & Destructor Documentation

◆ NET()

DSN::NET::NET ( ELEM aParent)
inline

Definition at line 2622 of file specctra.h.

2622  :
2623  ELEM( T_net, aParent )
2624  {
2625  unassigned = false;
2626  net_number = T_NONE;
2627  pins_type = T_pins;
2628 
2629  type = T_NONE;
2630  supply = T_NONE;
2631 
2632  rules = 0;
2633  comp_order = 0;
2634  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
RULE * rules
Definition: specctra.h:2612
DSN_T type
T_fix | T_normal.
Definition: specctra.h:2608
COMP_ORDER * comp_order
Definition: specctra.h:2618
bool unassigned
Definition: specctra.h:2596
int net_number
Definition: specctra.h:2597
DSN_T supply
T_power | T_ground.
Definition: specctra.h:2610
DSN_T pins_type
T_pins | T_order, type of field 'pins' below.
Definition: specctra.h:2599

References comp_order, net_number, pins_type, rules, supply, type, and unassigned.

◆ ~NET()

DSN::NET::~NET ( )
inline

Definition at line 2636 of file specctra.h.

2637  {
2638  delete rules;
2639  delete comp_order;
2640  }
RULE * rules
Definition: specctra.h:2612
COMP_ORDER * comp_order
Definition: specctra.h:2618

References comp_order, and rules.

Member Function Documentation

◆ FindPIN_REF()

int DSN::NET::FindPIN_REF ( const std::string &  aComponent)
inline

Definition at line 2642 of file specctra.h.

2643  {
2644  for( unsigned i = 0; i < pins.size(); ++i )
2645  {
2646  if( aComponent.compare( pins[i].component_id ) == 0 )
2647  return int(i);
2648  }
2649  return -1;
2650  }
PIN_REFS pins
Definition: specctra.h:2600

References pins.

◆ Format()

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

2653  {
2654  const char* quote = out->GetQuoteChar( net_id.c_str() );
2655  const char* space = " ";
2656 
2657  out->Print( nestLevel, "(%s %s%s%s",
2658  Name(),
2659  quote, net_id.c_str(), quote );
2660 
2661  if( unassigned )
2662  {
2663  out->Print( 0, "%s(unassigned)", space );
2664  space = ""; // only needed one space
2665  }
2666 
2667  if( net_number != T_NONE )
2668  {
2669  out->Print( 0, "%s(net_number %d)", space, net_number );
2670  // space = "";
2671  }
2672 
2673  out->Print( 0, "\n" );
2674 
2675  if( pins.size() )
2676  {
2677  const int RIGHTMARGIN = 80;
2678  int perLine = out->Print( nestLevel+1, "(%s", GetTokenText( pins_type ) );
2679 
2680  for( PIN_REFS::iterator i=pins.begin(); i!=pins.end(); ++i )
2681  {
2682  if( perLine > RIGHTMARGIN )
2683  {
2684  out->Print( 0, "\n");
2685  perLine = out->Print( nestLevel+2, "%s", "" );
2686  }
2687  else
2688  {
2689  perLine += out->Print( 0, " " );
2690  }
2691 
2692  perLine += i->FormatIt( out, 0 );
2693  }
2694  out->Print( 0, ")\n" );
2695  }
2696 
2697  if( comp_order )
2698  comp_order->Format( out, nestLevel+1 );
2699 
2700  if( type != T_NONE )
2701  out->Print( nestLevel+1, "(type %s)\n", GetTokenText( type ) );
2702 
2703  if( rules )
2704  rules->Format( out, nestLevel+1 );
2705 
2706  for( LAYER_RULES::iterator i = layer_rules.begin(); i != layer_rules.end(); ++i )
2707  i->Format( out, nestLevel+1 );
2708 
2709  for( FROMTOS::iterator i = fromtos.begin(); i != fromtos.end(); ++i )
2710  i->Format( out, nestLevel+1 );
2711 
2712  out->Print( nestLevel, ")\n" );
2713  }
std::string net_id
Definition: specctra.h:2595
FROMTOS fromtos
Definition: specctra.h:2616
const char * Name() const
Definition: specctra.cpp:3505
void Format(OUTPUTFORMATTER *out, int nestLevel) override
Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN f...
Definition: specctra.h:501
RULE * rules
Definition: specctra.h:2612
void Format(OUTPUTFORMATTER *out, int nestLevel) override
Function Format writes this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN f...
Definition: specctra.h:2568
DSN_T type
T_fix | T_normal.
Definition: specctra.h:2608
COMP_ORDER * comp_order
Definition: specctra.h:2618
bool unassigned
Definition: specctra.h:2596
int net_number
Definition: specctra.h:2597
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
LAYER_RULES layer_rules
Definition: specctra.h:2614
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
PIN_REFS pins
Definition: specctra.h:2600
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408
DSN_T pins_type
T_pins | T_order, type of field 'pins' below.
Definition: specctra.h:2599

References comp_order, DSN::RULE::Format(), DSN::COMP_ORDER::Format(), fromtos, OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), layer_rules, DSN::ELEM::Name(), net_id, net_number, pins, pins_type, OUTPUTFORMATTER::Print(), rules, type, and unassigned.

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

Member Data Documentation

◆ comp_order

COMP_ORDER* DSN::NET::comp_order
private

Definition at line 2618 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), Format(), NET(), and ~NET().

◆ expose

PIN_REFS DSN::NET::expose
private

Definition at line 2602 of file specctra.h.

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

◆ fromtos

FROMTOS DSN::NET::fromtos
private

Definition at line 2616 of file specctra.h.

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

◆ layer_rules

LAYER_RULES DSN::NET::layer_rules
private

Definition at line 2614 of file specctra.h.

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

◆ load

PIN_REFS DSN::NET::load
private

Definition at line 2605 of file specctra.h.

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

◆ net_id

std::string DSN::NET::net_id
private

Definition at line 2595 of file specctra.h.

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

◆ net_number

int DSN::NET::net_number
private

Definition at line 2597 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), Format(), and NET().

◆ noexpose

PIN_REFS DSN::NET::noexpose
private

Definition at line 2603 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

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

◆ pins

PIN_REFS DSN::NET::pins
private

◆ pins_type

DSN_T DSN::NET::pins_type
private

T_pins | T_order, type of field 'pins' below.

Definition at line 2599 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), Format(), and NET().

◆ rules

RULE* DSN::NET::rules
private

Definition at line 2612 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), Format(), NET(), and ~NET().

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

◆ source

PIN_REFS DSN::NET::source
private

Definition at line 2604 of file specctra.h.

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

◆ supply

DSN_T DSN::NET::supply
private

T_power | T_ground.

Definition at line 2610 of file specctra.h.

Referenced by NET().

◆ terminator

PIN_REFS DSN::NET::terminator
private

Definition at line 2606 of file specctra.h.

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

◆ type

DSN_T DSN::NET::type
private

T_fix | T_normal.

Definition at line 2608 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), Format(), and NET().

◆ unassigned

bool DSN::NET::unassigned
private

Definition at line 2596 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET(), Format(), and NET().


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