KiCad PCB EDA Suite
DSN::NET Class Reference

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

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

A <net_descriptor> in the DSN spec.

Definition at line 2596 of file specctra.h.

Constructor & Destructor Documentation

◆ NET()

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

Definition at line 2599 of file specctra.h.

2599  :
2600  ELEM( T_net, aParent )
2601  {
2602  unassigned = false;
2603  net_number = T_NONE;
2604  pins_type = T_pins;
2605 
2606  type = T_NONE;
2607  supply = T_NONE;
2608 
2609  rules = 0;
2610  comp_order = 0;
2611  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3749
RULE * rules
Definition: specctra.h:2712
DSN_T type
T_fix | T_normal.
Definition: specctra.h:2708
COMP_ORDER * comp_order
Definition: specctra.h:2718
bool unassigned
Definition: specctra.h:2696
int net_number
Definition: specctra.h:2697
DSN_T supply
T_power | T_ground.
Definition: specctra.h:2710
DSN_T pins_type
T_pins | T_order, type of field 'pins' below.
Definition: specctra.h:2699

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

◆ ~NET()

DSN::NET::~NET ( )
inline

Definition at line 2613 of file specctra.h.

2614  {
2615  delete rules;
2616  delete comp_order;
2617  }
RULE * rules
Definition: specctra.h:2712
COMP_ORDER * comp_order
Definition: specctra.h:2718

References comp_order, and rules.

Member Function Documentation

◆ FindPIN_REF()

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

Definition at line 2619 of file specctra.h.

2620  {
2621  for( unsigned i = 0; i < pins.size(); ++i )
2622  {
2623  if( aComponent.compare( pins[i].component_id ) == 0 )
2624  return int(i);
2625  }
2626 
2627  return -1;
2628  }
PIN_REFS pins
Definition: specctra.h:2700

References pins.

◆ Format()

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

2631  {
2632  const char* quote = out->GetQuoteChar( net_id.c_str() );
2633  const char* space = " ";
2634 
2635  out->Print( nestLevel, "(%s %s%s%s", Name(), quote, net_id.c_str(), quote );
2636 
2637  if( unassigned )
2638  {
2639  out->Print( 0, "%s(unassigned)", space );
2640  space = ""; // only needed one space
2641  }
2642 
2643  if( net_number != T_NONE )
2644  {
2645  out->Print( 0, "%s(net_number %d)", space, net_number );
2646  // space = "";
2647  }
2648 
2649  out->Print( 0, "\n" );
2650 
2651  if( pins.size() )
2652  {
2653  const int RIGHTMARGIN = 80;
2654  int perLine = out->Print( nestLevel+1, "(%s", GetTokenText( pins_type ) );
2655 
2656  for( PIN_REFS::iterator i = pins.begin(); i != pins.end(); ++i )
2657  {
2658  if( perLine > RIGHTMARGIN )
2659  {
2660  out->Print( 0, "\n");
2661  perLine = out->Print( nestLevel+2, "%s", "" );
2662  }
2663  else
2664  {
2665  perLine += out->Print( 0, " " );
2666  }
2667 
2668  perLine += i->FormatIt( out, 0 );
2669  }
2670 
2671  out->Print( 0, ")\n" );
2672  }
2673 
2674  if( comp_order )
2675  comp_order->Format( out, nestLevel+1 );
2676 
2677  if( type != T_NONE )
2678  out->Print( nestLevel+1, "(type %s)\n", GetTokenText( type ) );
2679 
2680  if( rules )
2681  rules->Format( out, nestLevel+1 );
2682 
2683  for( LAYER_RULES::iterator i = layer_rules.begin(); i != layer_rules.end(); ++i )
2684  i->Format( out, nestLevel+1 );
2685 
2686  for( FROMTOS::iterator i = fromtos.begin(); i != fromtos.end(); ++i )
2687  i->Format( out, nestLevel+1 );
2688 
2689  out->Print( nestLevel, ")\n" );
2690  }
std::string net_id
Definition: specctra.h:2695
FROMTOS fromtos
Definition: specctra.h:2716
const char * Name() const
Definition: specctra.cpp:3760
void Format(OUTPUTFORMATTER *out, int nestLevel) override
Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:500
RULE * rules
Definition: specctra.h:2712
void Format(OUTPUTFORMATTER *out, int nestLevel) override
Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
Definition: specctra.h:2569
DSN_T type
T_fix | T_normal.
Definition: specctra.h:2708
COMP_ORDER * comp_order
Definition: specctra.h:2718
bool unassigned
Definition: specctra.h:2696
int net_number
Definition: specctra.h:2697
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
LAYER_RULES layer_rules
Definition: specctra.h:2714
const char * GetTokenText(T aTok)
The DSN namespace and returns the C string representing a SPECCTRA_DB::keyword.
Definition: specctra.cpp:70
PIN_REFS pins
Definition: specctra.h:2700
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426
DSN_T pins_type
T_pins | T_order, type of field 'pins' below.
Definition: specctra.h:2699

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

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

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 2693 of file specctra.h.

Member Data Documentation

◆ comp_order

COMP_ORDER* DSN::NET::comp_order
private

Definition at line 2718 of file specctra.h.

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

◆ expose

PIN_REFS DSN::NET::expose
private

Definition at line 2702 of file specctra.h.

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

◆ fromtos

FROMTOS DSN::NET::fromtos
private

Definition at line 2716 of file specctra.h.

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

◆ layer_rules

LAYER_RULES DSN::NET::layer_rules
private

Definition at line 2714 of file specctra.h.

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

◆ load

PIN_REFS DSN::NET::load
private

Definition at line 2705 of file specctra.h.

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

◆ net_id

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

Definition at line 2695 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 2697 of file specctra.h.

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

◆ noexpose

PIN_REFS DSN::NET::noexpose
private

Definition at line 2703 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 276 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 2699 of file specctra.h.

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

◆ rules

RULE* DSN::NET::rules
private

Definition at line 2712 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 273 of file specctra.h.

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

◆ source

PIN_REFS DSN::NET::source
private

Definition at line 2704 of file specctra.h.

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

◆ supply

DSN_T DSN::NET::supply
private

T_power | T_ground.

Definition at line 2710 of file specctra.h.

Referenced by NET().

◆ terminator

PIN_REFS DSN::NET::terminator
private

Definition at line 2706 of file specctra.h.

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

◆ type

DSN_T DSN::NET::type
private

T_fix | T_normal.

Definition at line 2708 of file specctra.h.

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

◆ unassigned

bool DSN::NET::unassigned
private

Definition at line 2696 of file specctra.h.

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


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