DSN::VIA Class Reference

VIA corresponds to the <via_descriptor> in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::VIA:

Public Member Functions
	VIA (ELEM *aParent)
void	AppendVia (const char *aViaName)
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
STRINGS	padstacks
STRINGS	spares

Friends
class	SPECCTRA_DB

Detailed Description

VIA corresponds to the <via_descriptor> in the specctra dsn spec.

Definition at line 1024 of file specctra.h.

Constructor & Destructor Documentation

VIA()

DSN::VIA::VIA ( ELEM *  aParent )

inline

Definition at line 1033 of file specctra.h.

                         :
        ELEM( T_via, aParent )
    {
    }

Member Function Documentation

AppendVia()

void DSN::VIA::AppendVia ( const char *  aViaName )

inline

Definition at line 1038 of file specctra.h.

    {
        padstacks.push_back( aViaName );
    }

References padstacks.

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

Format()

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

    {
        const int RIGHTMARGIN = 80;
        int perLine = out->Print( nestLevel, "(%s", Name() );

        for( STRINGS::iterator i = padstacks.begin(); i != padstacks.end(); ++i )
        {
            if( perLine > RIGHTMARGIN )
            {
                out->Print( 0, "\n" );
                perLine = out->Print( nestLevel+1, "%s", "");
            }

            const char* quote = out->GetQuoteChar( i->c_str() );
            perLine += out->Print( 0, " %s%s%s", quote, i->c_str(), quote );
        }

        if( spares.size() )
        {
            out->Print( 0, "\n" );

            perLine = out->Print( nestLevel+1, "(spare" );

            for( STRINGS::iterator i = spares.begin(); i != spares.end(); ++i )
            {
                if( perLine > RIGHTMARGIN )
                {
                    out->Print( 0, "\n" );
                    perLine = out->Print( nestLevel+2, "%s", "");
                }

                const char* quote = out->GetQuoteChar( i->c_str() );
                perLine += out->Print( 0, " %s%s%s", quote, i->c_str(), quote );
            }

            out->Print( 0, ")" );
        }

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

References OUTPUTFORMATTER::GetQuoteChar(), DSN::ELEM::Name(), padstacks, OUTPUTFORMATTER::Print(), and spares.

Referenced by DSN::STRUCTURE::FormatContents().

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 263 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 3510 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 211 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 3505 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(), 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 268 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 230 of file specctra.h.

{ return type; }

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

Member Data Documentation

padstacks

STRINGS DSN::VIA::padstacks

private

Definition at line 1028 of file specctra.h.

Referenced by AppendVia(), DSN::SPECCTRA_DB::doVIA(), and Format().

parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 199 of file specctra.h.

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

sf

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 221 of file specctra.h.

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

spares

STRINGS DSN::VIA::spares

private

Definition at line 1029 of file specctra.h.

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

type

DSN_T DSN::ELEM::type

protectedinherited

Definition at line 198 of file specctra.h.

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

---

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

• specctra.h