KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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.
 
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 m_net_id
 
bool m_unassigned
 
int m_net_number
 
DSN_T m_pins_type
 T_pins | T_order, type of field 'pins' below.
 
PIN_REFS m_pins
 
PIN_REFS m_expose
 
PIN_REFS m_noexpose
 
PIN_REFS m_source
 
PIN_REFS m_load
 
PIN_REFS m_terminator
 
DSN_T m_type
 T_fix | T_normal.
 
DSN_T m_supply
 T_power | T_ground.
 
RULEm_rules
 
LAYER_RULES m_layer_rules
 
FROMTOS m_fromtos
 
COMP_ORDERm_comp_order
 

Friends

class SPECCTRA_DB
 

Detailed Description

A <net_descriptor> in the DSN spec.

Definition at line 2589 of file specctra.h.

Constructor & Destructor Documentation

◆ NET()

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

Definition at line 2592 of file specctra.h.

References m_comp_order, m_net_number, m_pins_type, m_rules, m_supply, m_type, and m_unassigned.

◆ ~NET()

DSN::NET::~NET ( )
inline

Definition at line 2606 of file specctra.h.

References m_comp_order, and m_rules.

Member Function Documentation

◆ FindPIN_REF()

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

Definition at line 2612 of file specctra.h.

References m_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 2623 of file specctra.h.

References DSN::RULE::Format(), DSN::COMP_ORDER::Format(), OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), m_comp_order, m_fromtos, m_layer_rules, m_net_id, m_net_number, m_pins, m_pins_type, m_rules, m_type, m_unassigned, DSN::ELEM::Name(), and OUTPUTFORMATTER::Print().

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

Member Data Documentation

◆ m_comp_order

COMP_ORDER* DSN::NET::m_comp_order
private

Definition at line 2711 of file specctra.h.

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

◆ m_expose

PIN_REFS DSN::NET::m_expose
private

Definition at line 2695 of file specctra.h.

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

◆ m_fromtos

FROMTOS DSN::NET::m_fromtos
private

Definition at line 2709 of file specctra.h.

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

◆ m_layer_rules

LAYER_RULES DSN::NET::m_layer_rules
private

Definition at line 2707 of file specctra.h.

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

◆ m_load

PIN_REFS DSN::NET::m_load
private

Definition at line 2698 of file specctra.h.

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

◆ m_net_id

std::string DSN::NET::m_net_id
private

Definition at line 2688 of file specctra.h.

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

◆ m_net_number

int DSN::NET::m_net_number
private

Definition at line 2690 of file specctra.h.

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

◆ m_noexpose

PIN_REFS DSN::NET::m_noexpose
private

Definition at line 2696 of file specctra.h.

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

◆ m_pins

PIN_REFS DSN::NET::m_pins
private

◆ m_pins_type

DSN_T DSN::NET::m_pins_type
private

T_pins | T_order, type of field 'pins' below.

Definition at line 2692 of file specctra.h.

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

◆ m_rules

RULE* DSN::NET::m_rules
private

Definition at line 2705 of file specctra.h.

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

◆ m_source

PIN_REFS DSN::NET::m_source
private

Definition at line 2697 of file specctra.h.

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

◆ m_supply

DSN_T DSN::NET::m_supply
private

T_power | T_ground.

Definition at line 2703 of file specctra.h.

Referenced by NET().

◆ m_terminator

PIN_REFS DSN::NET::m_terminator
private

Definition at line 2699 of file specctra.h.

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

◆ m_type

DSN_T DSN::NET::m_type
private

T_fix | T_normal.

Definition at line 2701 of file specctra.h.

Referenced by Format(), and NET().

◆ m_unassigned

bool DSN::NET::m_unassigned
private

Definition at line 2689 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent
protectedinherited

Definition at line 275 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf
staticprotectedinherited

Definition at line 272 of file specctra.h.

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

◆ type

DSN_T DSN::ELEM::type
protectedinherited

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