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. 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

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

Constructor & Destructor Documentation

◆ NET_OUT()

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

Definition at line 3396 of file specctra.h.

References net_number, and rules.

◆ ~NET_OUT()

DSN::NET_OUT::~NET_OUT ( )
inline

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

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

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

Definition at line 241 of file specctra.h.

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

Definition at line 3764 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().

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

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB
friend

Definition at line 3434 of file specctra.h.

Member Data Documentation

◆ net_id

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

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

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 275 of file specctra.h.

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

◆ rules

RULE* DSN::NET_OUT::rules
private

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

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

◆ supply_pins

SUPPLY_PINS DSN::NET_OUT::supply_pins
private

Definition at line 3441 of file specctra.h.

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

◆ type

DSN_T DSN::ELEM::type
protectedinherited

◆ wire_vias

WIRE_VIAS DSN::NET_OUT::wire_vias
private

Definition at line 3440 of file specctra.h.

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

◆ wires

WIRES DSN::NET_OUT::wires
private

Definition at line 3439 of file specctra.h.

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


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