KiCad PCB EDA Suite
DSN::NET_OUT Class Reference

NET_OUT corresponds to the <net_out_descriptor> of the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::NET_OUT:
DSN::ELEM

Public Member Functions

 NET_OUT (ELEM *aParent)
 
 ~NET_OUT ()
 
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 net_id
 
int net_number
 
RULErules
 
WIRES wires
 
WIRE_VIAS wire_vias
 
SUPPLY_PINS supply_pins
 

Friends

class SPECCTRA_DB
 

Detailed Description

NET_OUT corresponds to the <net_out_descriptor> of the specctra dsn spec.

Definition at line 3387 of file specctra.h.

Constructor & Destructor Documentation

◆ NET_OUT()

DSN::NET_OUT::NET_OUT ( ELEM aParent)
inline

Definition at line 3400 of file specctra.h.

3400  :
3401  ELEM( T_net_out, aParent )
3402  {
3403  rules = 0;
3404  net_number = -1;
3405  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3494
RULE * rules
Definition: specctra.h:3393
int net_number
Definition: specctra.h:3392

References net_number, and rules.

◆ ~NET_OUT()

DSN::NET_OUT::~NET_OUT ( )
inline

Definition at line 3406 of file specctra.h.

3407  {
3408  delete rules;
3409  }
RULE * rules
Definition: specctra.h:3393

References rules.

Member Function Documentation

◆ Format()

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

3412  {
3413  const char* quote = out->GetQuoteChar( net_id.c_str() );
3414 
3415  // cannot use Type() here, it is T_net_out and we need "(net "
3416  out->Print( nestLevel, "(net %s%s%s\n",
3417  quote, net_id.c_str(), quote );
3418 
3419  if( net_number>= 0 )
3420  out->Print( nestLevel+1, "(net_number %d)\n", net_number );
3421 
3422  if( rules )
3423  rules->Format( out, nestLevel+1 );
3424 
3425  for( WIRES::iterator i=wires.begin(); i!=wires.end(); ++i )
3426  i->Format( out, nestLevel+1 );
3427 
3428  for( WIRE_VIAS::iterator i=wire_vias.begin(); i!=wire_vias.end(); ++i )
3429  i->Format( out, nestLevel+1 );
3430 
3431  for( SUPPLY_PINS::iterator i=supply_pins.begin(); i!=supply_pins.end(); ++i )
3432  i->Format( out, nestLevel+1 );
3433 
3434  out->Print( nestLevel, ")\n" );
3435  }
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
WIRES wires
Definition: specctra.h:3394
RULE * rules
Definition: specctra.h:3393
SUPPLY_PINS supply_pins
Definition: specctra.h:3396
WIRE_VIAS wire_vias
Definition: specctra.h:3395
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 net_number
Definition: specctra.h:3392
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408
std::string net_id
Definition: specctra.h:3391

References DSN::RULE::Format(), OUTPUTFORMATTER::GetQuoteChar(), net_id, net_number, OUTPUTFORMATTER::Print(), rules, supply_pins, wire_vias, and wires.

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

Member Data Documentation

◆ net_id

std::string DSN::NET_OUT::net_id
private

Definition at line 3391 of file specctra.h.

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

◆ net_number

int DSN::NET_OUT::net_number
private

Definition at line 3392 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET_OUT(), Format(), and NET_OUT().

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 199 of file specctra.h.

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

◆ rules

RULE* DSN::NET_OUT::rules
private

Definition at line 3393 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doNET_OUT(), Format(), NET_OUT(), and ~NET_OUT().

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 221 of file specctra.h.

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

◆ supply_pins

SUPPLY_PINS DSN::NET_OUT::supply_pins
private

Definition at line 3396 of file specctra.h.

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

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

◆ wire_vias

WIRE_VIAS DSN::NET_OUT::wire_vias
private

Definition at line 3395 of file specctra.h.

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

◆ wires

WIRES DSN::NET_OUT::wires
private

Definition at line 3394 of file specctra.h.

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


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