KiCad PCB EDA Suite
Loading...
Searching...
No Matches
DSN::NET_OUT Class Reference

A <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
 Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
 
DSN_T Type () const
 
const char * Name () const
 
virtual UNIT_RESGetUnits () const
 Return the units for this section.
 
virtual void FormatContents (OUTPUTFORMATTER *out, int nestLevel)
 Write the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
 
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.
 

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

A <net_out_descriptor> of the specctra dsn spec.

Definition at line 3403 of file specctra.h.

Constructor & Destructor Documentation

◆ NET_OUT()

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

Definition at line 3406 of file specctra.h.

References DSN::ELEM::ELEM(), net_number, and rules.

◆ ~NET_OUT()

DSN::NET_OUT::~NET_OUT ( )
inline

Definition at line 3413 of file specctra.h.

References rules.

Member Function Documentation

◆ Format()

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

References 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

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::CLASS_CLASS, DSN::CLASSES, DSN::COMPONENT, DSN::ELEM_HOLDER, DSN::HISTORY, DSN::IMAGE, DSN::LIBRARY, DSN::NETWORK, DSN::PADSTACK, DSN::PARSER, DSN::PLACEMENT, DSN::REGION, DSN::ROUTE, DSN::STRUCTURE, DSN::STRUCTURE_OUT, DSN::TOPOLOGY, DSN::WAS_IS, and DSN::WIRING.

Definition at line 247 of file specctra.h.

Referenced by Format(), and 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::IMAGE, DSN::LIBRARY, DSN::PADSTACK, DSN::PCB, DSN::PLACEMENT, DSN::ROUTE, DSN::STRUCTURE, and DSN::WIRING.

Definition at line 3773 of file specctra.cpp.

References DSN::UNIT_RES::Default, and parent.

Referenced by DSN::SPECCTRA_DB::FromSESSION(), DSN::IMAGE::GetUnits(), DSN::LIBRARY::GetUnits(), DSN::PADSTACK::GetUnits(), DSN::PCB::GetUnits(), DSN::PLACEMENT::GetUnits(), DSN::ROUTE::GetUnits(), DSN::STRUCTURE::GetUnits(), and DSN::WIRING::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 268 of file specctra.h.

References FormatContents(), and sf.

Referenced by DSN::IMAGE::Compare(), and DSN::PADSTACK::Compare().

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Symbol Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 3444 of file specctra.h.

References SPECCTRA_DB.

Referenced by SPECCTRA_DB.

Member Data Documentation

◆ net_id

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

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

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 281 of file specctra.h.

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

◆ rules

RULE* DSN::NET_OUT::rules
private

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

Referenced by makeHash().

◆ supply_pins

SUPPLY_PINS DSN::NET_OUT::supply_pins
private

Definition at line 3451 of file specctra.h.

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

◆ type

DSN_T DSN::ELEM::type
protectedinherited

Definition at line 280 of file specctra.h.

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

◆ wire_vias

WIRE_VIAS DSN::NET_OUT::wire_vias
private

Definition at line 3450 of file specctra.h.

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

◆ wires

WIRES DSN::NET_OUT::wires
private

Definition at line 3449 of file specctra.h.

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


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