KiCad PCB EDA Suite
DSN::NET_OUT Class Reference

Class 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

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

Definition at line 3361 of file specctra.h.

Constructor & Destructor Documentation

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

Definition at line 3374 of file specctra.h.

3374  :
3375  ELEM( T_net_out, aParent )
3376  {
3377  rules = 0;
3378  net_number = -1;
3379  }
ELEM(DSN_T aType, ELEM *aParent=0)
Definition: specctra.cpp:3490
RULE * rules
Definition: specctra.h:3367
int net_number
Definition: specctra.h:3366
DSN::NET_OUT::~NET_OUT ( )
inline

Definition at line 3380 of file specctra.h.

References rules.

3381  {
3382  delete rules;
3383  }
RULE * rules
Definition: specctra.h:3367

Member Function Documentation

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

References DSN::RULE::Format(), OUTPUTFORMATTER::GetQuoteChar(), and OUTPUTFORMATTER::Print().

3386  {
3387  const char* quote = out->GetQuoteChar( net_id.c_str() );
3388 
3389  // cannot use Type() here, it is T_net_out and we need "(net "
3390  out->Print( nestLevel, "(net %s%s%s\n",
3391  quote, net_id.c_str(), quote );
3392 
3393  if( net_number>= 0 )
3394  out->Print( nestLevel+1, "(net_number %d)\n", net_number );
3395 
3396  if( rules )
3397  rules->Format( out, nestLevel+1 );
3398 
3399  for( WIRES::iterator i=wires.begin(); i!=wires.end(); ++i )
3400  i->Format( out, nestLevel+1 );
3401 
3402  for( WIRE_VIAS::iterator i=wire_vias.begin(); i!=wire_vias.end(); ++i )
3403  i->Format( out, nestLevel+1 );
3404 
3405  for( SUPPLY_PINS::iterator i=supply_pins.begin(); i!=supply_pins.end(); ++i )
3406  i->Format( out, nestLevel+1 );
3407 
3408  out->Print( nestLevel, ")\n" );
3409  }
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:505
WIRES wires
Definition: specctra.h:3368
RULE * rules
Definition: specctra.h:3367
SUPPLY_PINS supply_pins
Definition: specctra.h:3370
WIRE_VIAS wire_vias
Definition: specctra.h:3369
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:327
int net_number
Definition: specctra.h:3366
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
std::string net_id
Definition: specctra.h:3365
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 264 of file specctra.h.

Referenced by DSN::ELEM::Format(), and DSN::ELEM::makeHash().

265  {
266  // overridden in ELEM_HOLDER
267  }
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 3506 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().

3507 {
3508  if( parent )
3509  return parent->GetUnits();
3510 
3511  return &UNIT_RES::Default;
3512 }
virtual UNIT_RES * GetUnits() const
Function GetUnits returns the units for this section.
Definition: specctra.cpp:3506
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:500
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 3363 of file specctra.h.

Member Data Documentation

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

Definition at line 3365 of file specctra.h.

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

int DSN::NET_OUT::net_number
private

Definition at line 3366 of file specctra.h.

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

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 200 of file specctra.h.

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

RULE* DSN::NET_OUT::rules
private

Definition at line 3367 of file specctra.h.

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

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 222 of file specctra.h.

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

SUPPLY_PINS DSN::NET_OUT::supply_pins
private

Definition at line 3370 of file specctra.h.

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

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 199 of file specctra.h.

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

WIRE_VIAS DSN::NET_OUT::wire_vias
private

Definition at line 3369 of file specctra.h.

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

WIRES DSN::NET_OUT::wires
private

Definition at line 3368 of file specctra.h.

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


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