A <net_descriptor> in the DSN spec. More...

#include <specctra.h>

Inheritance diagram for DSN::NET:

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

DSN_T	Type () const

const char *	Name () const

virtual UNIT_RES *	GetUnits () 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
ELEM *	parent

Static Protected Attributes
static STRING_FORMATTER	sf

Private Attributes
std::string	net_id

bool	unassigned

int	net_number

DSN_T	pins_type
	T_pins \| T_order, type of field 'pins' below. More...

PIN_REFS	pins

PIN_REFS	expose

PIN_REFS	noexpose

PIN_REFS	source

PIN_REFS	load

PIN_REFS	terminator

DSN_T	type
	T_fix \| T_normal. More...

DSN_T	supply
	T_power \| T_ground. More...

RULE *	rules

LAYER_RULES	layer_rules

FROMTOS	fromtos

COMP_ORDER *	comp_order

Friends
class	SPECCTRA_DB

Detailed Description

A <net_descriptor> in the DSN spec.

Definition at line 2596 of file specctra.h.

Constructor & Destructor Documentation

◆ NET()

DSN::NET::NET ( ELEM * aParent )

inline

Definition at line 2599 of file specctra.h.

                          :
         ELEM( T_net, aParent )
     {
         unassigned = false;
         net_number = T_NONE;
         pins_type = T_pins;
 
         type = T_NONE;
         supply = T_NONE;
 
         rules = 0;
         comp_order = 0;
     }

References comp_order, net_number, pins_type, rules, supply, type, and unassigned.

◆ ~NET()

DSN::NET::~NET ( )

inline

Definition at line 2613 of file specctra.h.

     {
         delete rules;
         delete comp_order;
     }

References comp_order, and rules.

Member Function Documentation

◆ FindPIN_REF()

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

inline

Definition at line 2619 of file specctra.h.

     {
         for( unsigned i = 0; i < pins.size(); ++i )
         {
             if( aComponent.compare( pins[i].component_id ) == 0 )
                 return int(i);
         }
 
         return -1;
     }

References 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

out	The formatter to write to.
nestLevel	A multiple of the number of spaces to precede the output with.

Exceptions

IO_ERROR if a system error writing the output, such as a full disk.

Reimplemented from DSN::ELEM.

Definition at line 2630 of file specctra.h.

     {
         const char* quote = out->GetQuoteChar( net_id.c_str() );
         const char* space = " ";
 
         out->Print( nestLevel, "(%s %s%s%s", Name(), quote, net_id.c_str(), quote );
 
         if( unassigned )
         {
             out->Print( 0, "%s(unassigned)", space );
             space = "";         // only needed one space
         }
 
         if( net_number != T_NONE )
         {
             out->Print( 0, "%s(net_number %d)", space, net_number );
             // space = "";
         }
 
         out->Print( 0, "\n" );
 
         if( pins.size() )
         {
             const int RIGHTMARGIN = 80;
             int perLine = out->Print( nestLevel+1, "(%s", GetTokenText( pins_type ) );
 
             for( PIN_REFS::iterator i = pins.begin(); i != pins.end(); ++i )
             {
                 if( perLine > RIGHTMARGIN )
                 {
                     out->Print( 0, "\n");
                     perLine = out->Print( nestLevel+2, "%s", "" );
                 }
                 else
                 {
                     perLine += out->Print( 0, " " );
                 }
 
                 perLine += i->FormatIt( out, 0 );
             }
 
             out->Print( 0, ")\n" );
         }
 
         if( comp_order )
             comp_order->Format( out, nestLevel+1 );
 
         if( type != T_NONE )
             out->Print( nestLevel+1, "(type %s)\n", GetTokenText( type ) );
 
         if( rules )
             rules->Format( out, nestLevel+1 );
 
         for( LAYER_RULES::iterator i = layer_rules.begin(); i != layer_rules.end(); ++i )
             i->Format( out, nestLevel+1 );
 
         for( FROMTOS::iterator i = fromtos.begin(); i != fromtos.end(); ++i )
             i->Format( out, nestLevel+1 );
 
         out->Print( nestLevel, ")\n" );
     }

References comp_order, DSN::RULE::Format(), DSN::COMP_ORDER::Format(), fromtos, OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), layer_rules, DSN::ELEM::Name(), net_id, net_number, pins, pins_type, OUTPUTFORMATTER::Print(), rules, type, and unassigned.

◆ 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

out	The formatter to write to.
nestLevel	A multiple of the number of spaces to precede the output with.

Exceptions

IO_ERROR if 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 242 of file specctra.h.

     {
         // overridden in ELEM_HOLDER
     }

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

Definition at line 3765 of file specctra.cpp.

 {
     if( parent )
         return parent->GetUnits();
 
     return &UNIT_RES::Default;
 }

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

     {
         sf.Clear();
         FormatContents( &sf, 0 );
         sf.StripUseless();
 
         return sf.GetString();
     }

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

const char * DSN::ELEM::Name ( ) const

inherited

Definition at line 3760 of file specctra.cpp.

 {
     return SPECCTRA_DB::TokenName( type );
 }

References DSN::ELEM::type.

Referenced by DSN::ELEM::Format(), DSN::UNIT_RES::Format(), DSN::RECTANGLE::Format(), DSN::RULE::Format(), DSN::LAYER_RULE::Format(), DSN::PATH::Format(), DSN::BOUNDARY::Format(), DSN::CIRCLE::Format(), DSN::QARC::Format(), DSN::WINDOW::Format(), DSN::KEEPOUT::Format(), DSN::VIA::Format(), DSN::CONTROL::Format(), DSN::LAYER::Format(), DSN::SPECCTRA_LAYER_PAIR::Format(), DSN::LAYER_NOISE_WEIGHT::Format(), DSN::TOKPROP::Format(), DSN::STRINGPROP::Format(), DSN::GRID::Format(), DSN::PLACE::Format(), DSN::COMPONENT::Format(), DSN::SHAPE::Format(), DSN::IMAGE::Format(), DSN::PADSTACK::Format(), DSN::FROMTO::Format(), DSN::COMP_ORDER::Format(), Format(), DSN::CLASS::Format(), DSN::WIRE::Format(), DSN::WIRE_VIA::Format(), DSN::PCB::Format(), DSN::ANCESTOR::Format(), DSN::SUPPLY_PIN::Format(), and DSN::SESSION::Format().

◆ SetParent()

void DSN::ELEM::SetParent ( ELEM * aParent )

inlineinherited

Definition at line 247 of file specctra.h.

     {
         parent = aParent;
     }

References DSN::ELEM::parent.

Referenced by DSN::LIBRARY::AddPadstack(), DSN::KEEPOUT::AddWindow(), DSN::LIBRARY::AppendIMAGE(), DSN::LIBRARY::AppendPADSTACK(), DSN::LIBRARY::AppendVia(), DSN::STRUCTURE::SetBOUNDARY(), DSN::STRUCTURE::SetPlaceBOUNDARY(), DSN::WINDOW::SetShape(), DSN::KEEPOUT::SetShape(), and DSN::WIRE::SetShape().

◆ Type()

DSN_T DSN::ELEM::Type ( ) const

inlineinherited

Definition at line 210 of file specctra.h.

210 { return type; }

DSN::ELEM::type

DSN_T type

Definition: specctra.h:275

References DSN::ELEM::type.

Referenced by DSN::SPECCTRA_DB::doCLASS_CLASS(), DSN::ELEM_HOLDER::FindElem(), DSN::SPECCTRA_DB::FromSESSION(), DSN::SPECCTRA_DB::makeVIA(), DSN::WINDOW::SetShape(), DSN::KEEPOUT::SetShape(), and DSN::WIRE::SetShape().

Friends And Related Function Documentation

◆ SPECCTRA_DB

friend class SPECCTRA_DB

friend

Definition at line 2693 of file specctra.h.

Member Data Documentation

◆ comp_order

COMP_ORDER* DSN::NET::comp_order

private

Definition at line 2718 of file specctra.h.

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

◆ expose

PIN_REFS DSN::NET::expose

private

Definition at line 2702 of file specctra.h.

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

◆ fromtos

FROMTOS DSN::NET::fromtos

private

Definition at line 2716 of file specctra.h.

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

◆ layer_rules

LAYER_RULES DSN::NET::layer_rules

private

Definition at line 2714 of file specctra.h.

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

◆ load

PIN_REFS DSN::NET::load

private

Definition at line 2705 of file specctra.h.

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

◆ net_id

std::string DSN::NET::net_id

private

Definition at line 2695 of file specctra.h.

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

◆ net_number

int DSN::NET::net_number

private

Definition at line 2697 of file specctra.h.

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

◆ noexpose

PIN_REFS DSN::NET::noexpose

private

Definition at line 2703 of file specctra.h.

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

◆ parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 276 of file specctra.h.

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

◆ pins

PIN_REFS DSN::NET::pins

private

Definition at line 2700 of file specctra.h.

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

◆ pins_type

DSN_T DSN::NET::pins_type

private

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

Definition at line 2699 of file specctra.h.

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

◆ rules

RULE* DSN::NET::rules

private

Definition at line 2712 of file specctra.h.

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

◆ sf

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 273 of file specctra.h.

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

◆ source

PIN_REFS DSN::NET::source

private

Definition at line 2704 of file specctra.h.

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

◆ supply

DSN_T DSN::NET::supply

private

T_power | T_ground.

Definition at line 2710 of file specctra.h.

Referenced by NET().

◆ terminator

PIN_REFS DSN::NET::terminator

private

Definition at line 2706 of file specctra.h.

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

◆ type

DSN_T DSN::NET::type

private

T_fix | T_normal.

Definition at line 2708 of file specctra.h.

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

◆ unassigned

bool DSN::NET::unassigned

private

Definition at line 2696 of file specctra.h.

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

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

specctra.h

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ NET()

◆ ~NET()

Member Function Documentation

◆ FindPIN_REF()

◆ Format()

◆ FormatContents()

◆ GetUnits()

◆ makeHash()

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

Member Data Documentation

◆ comp_order

◆ expose

◆ fromtos

◆ layer_rules

◆ load

◆ net_id

◆ net_number

◆ noexpose

◆ parent

◆ pins

◆ pins_type

◆ rules

◆ sf

◆ source

◆ supply

◆ terminator

◆ type

◆ unassigned