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:

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

Static Protected Attributes
static STRING_FORMATTER	sf

Private Attributes
std::string	net_id
int	net_number
RULE *	rules
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

NET_OUT()

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

inline

Definition at line 3374 of file specctra.h.

                             :
        ELEM( T_net_out, aParent )
    {
        rules = 0;
        net_number = -1;
    }

References net_number, and rules.

~NET_OUT()

DSN::NET_OUT::~NET_OUT ( )

inline

Definition at line 3380 of file specctra.h.

    {
        delete rules;
    }

References rules.

Member Function Documentation

Format()

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

out	The formatter to write to.
nestLevel	A multiple of the number of spaces to preceed 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 3385 of file specctra.h.

    {
        const char* quote = out->GetQuoteChar( net_id.c_str() );

        // cannot use Type() here, it is T_net_out and we need "(net "
        out->Print( nestLevel, "(net %s%s%s\n",
                   quote, net_id.c_str(), quote );

        if( net_number>= 0 )
            out->Print( nestLevel+1, "(net_number %d)\n", net_number );

        if( rules )
            rules->Format( out, nestLevel+1 );

        for( WIRES::iterator i=wires.begin();  i!=wires.end();  ++i )
            i->Format( out, nestLevel+1 );

        for( WIRE_VIAS::iterator i=wire_vias.begin();  i!=wire_vias.end();  ++i )
            i->Format( out, nestLevel+1 );

        for( SUPPLY_PINS::iterator i=supply_pins.begin();  i!=supply_pins.end();  ++i )
            i->Format( out, nestLevel+1 );

        out->Print( nestLevel, ")\n" );
    }

References DSN::RULE::Format(), OUTPUTFORMATTER::GetQuoteChar(), i, net_id, net_number, OUTPUTFORMATTER::Print(), rules, supply_pins, wire_vias, and wires.

FormatContents()

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

out	The formatter to write to.
nestLevel	A multiple of the number of spaces to preceed 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 264 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

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.

{
    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

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.

    {
        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 3501 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(), DSN::NET::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 269 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 231 of file specctra.h.

{ return type; }

References DSN::ELEM::type.

Referenced by DSN::SPECCTRA_DB::doCLASS_CLASS(), DSN::ELEM_HOLDER::FindElem(), DSN::SPECCTRA_DB::FromBOARD(), 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 3363 of file specctra.h.

Member Data Documentation

net_id

std::string DSN::NET_OUT::net_id

private

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

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

parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 200 of file specctra.h.

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

rules

RULE* DSN::NET_OUT::rules

private

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

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

supply_pins

SUPPLY_PINS DSN::NET_OUT::supply_pins

private

Definition at line 3370 of file specctra.h.

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

type

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

WIRE_VIAS DSN::NET_OUT::wire_vias

private

Definition at line 3369 of file specctra.h.

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

wires

WIRES DSN::NET_OUT::wires

private

Definition at line 3368 of file specctra.h.

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

---

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

• specctra.h