PADSTACK holds either a via or a pad definition. More...

#include <specctra.h>

Inheritance diagram for DSN::PADSTACK:

Public Member Functions
	PADSTACK ()
	Constructor PADSTACK() cannot take ELEM* aParent because PADSTACKSET confuses this with a copy constructor and causes havoc. More...

	~PADSTACK ()

const std::string &	GetPadstackId ()

void	SetPadstackId (const char *aPadstackId)

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

void	FormatContents (OUTPUTFORMATTER *out, int nestLevel) override
	Function FormatContents writes the contents as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format. More...

UNIT_RES *	GetUnits () const override
	Function GetUnits returns the units for this section. More...

int	FindElem (DSN_T aType, int instanceNum=0)
	Function FindElem finds a particular instance number of a given type of ELEM. More...

int	Length () const
	Function Length returns the number of ELEMs in this ELEM. More...

void	Append (ELEM *aElem)

ELEM *	Replace (int aIndex, ELEM *aElem)

ELEM *	Remove (int aIndex)

void	Insert (int aIndex, ELEM *aElem)

ELEM *	At (int aIndex) const

ELEM *	operator[] (int aIndex) const

void	Delete (int aIndex)

DSN_T	Type () const

const char *	Name () const

void	SetParent (ELEM *aParent)

Static Public Member Functions
static int	Compare (PADSTACK lhs, PADSTACK rhs)
	Function Compare compares two objects of this type and returns <0, 0, or >0. More...

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	hash
	a hash string used by Compare(), not Format()ed/exported. More...

std::string	padstack_id

UNIT_RES *	unit

DSN_T	rotate

DSN_T	absolute

DSN_T	attach

std::string	via_id

RULE *	rules

Friends
class	SPECCTRA_DB

Detailed Description

PADSTACK holds either a via or a pad definition.

Definition at line 2114 of file specctra.h.

Constructor & Destructor Documentation

◆ PADSTACK()

DSN::PADSTACK::PADSTACK ( )

inline

Constructor PADSTACK() cannot take ELEM* aParent because PADSTACKSET confuses this with a copy constructor and causes havoc.

Instead set parent with LIBRARY::AddPadstack()

Definition at line 2140 of file specctra.h.

                :
         ELEM_HOLDER( T_padstack, NULL )
     {
         unit = 0;
         rotate = T_on;
         absolute = T_off;
         rules = 0;
         attach = T_off;
     }

References absolute, attach, rotate, rules, and unit.

◆ ~PADSTACK()

DSN::PADSTACK::~PADSTACK ( )

inline

Definition at line 2149 of file specctra.h.

     {
         delete unit;
         delete rules;
     }

References rules, and unit.

Member Function Documentation

◆ Append()

void DSN::ELEM_HOLDER::Append ( ELEM * aElem )

inlineinherited

Definition at line 320 of file specctra.h.

     {
         kids.push_back( aElem );
     }

References DSN::ELEM_HOLDER::kids.

Referenced by DSN::SPECCTRA_DB::doCLASS_CLASS(), DSN::SPECCTRA_DB::doCONTROL(), DSN::SPECCTRA_DB::doIMAGE(), DSN::SPECCTRA_DB::doPADSTACK(), DSN::SPECCTRA_DB::doREGION(), DSN::SPECCTRA_DB::doSTRUCTURE(), DSN::SPECCTRA_DB::makePADSTACK(), and DSN::SPECCTRA_DB::makeVia().

◆ At()

ELEM* DSN::ELEM_HOLDER::At ( int aIndex ) const

inlineinherited

Definition at line 342 of file specctra.h.

     {
         // we have varying sized objects and are using polymorphism, so we
         // must return a pointer not a reference.
         return (ELEM*) &kids[aIndex];
     }

References DSN::ELEM_HOLDER::kids.

Referenced by DSN::CONTROL::Format(), DSN::ELEM_HOLDER::FormatContents(), DSN::STRUCTURE::FormatContents(), and DSN::ELEM_HOLDER::operator[]().

◆ Compare()

int DSN::PADSTACK::Compare	(	PADSTACK *	lhs,
		PADSTACK *	rhs
	)

static

Function Compare compares two objects of this type and returns <0, 0, or >0.

Definition at line 3566 of file specctra.cpp.

 {
     if( !lhs->hash.size() )
         lhs->hash = lhs->makeHash();
 
     if( !rhs->hash.size() )
         rhs->hash = rhs->makeHash();
 
     int result = lhs->hash.compare( rhs->hash );
     if( result )
         return result;
 
     // Via names hold the drill diameters, so we have to include those to discern
     // between two vias with same copper size but with different drill sizes.
     result = lhs->padstack_id.compare( rhs->padstack_id );
 
     return result;
 }

References hash, DSN::ELEM::makeHash(), and padstack_id.

Referenced by DSN::LIBRARY::FindVia(), and DSN::operator<().

◆ Delete()

void DSN::ELEM_HOLDER::Delete ( int aIndex )

inlineinherited

Definition at line 354 of file specctra.h.

     {
         kids.erase( kids.begin()+aIndex );
     }

References DSN::ELEM_HOLDER::kids.

◆ FindElem()

int DSN::ELEM_HOLDER::FindElem	(	DSN_T	aType,
		int	instanceNum = `0`
	)

inherited

Function FindElem finds a particular instance number of a given type of ELEM.

Parameters

aType	The type of ELEM to find
instanceNum	The instance number of to find: 0 for first, 1 for second, etc.

Returns: int - The index into the kids array or -1 if not found.

Definition at line 3536 of file specctra.cpp.

 {
     int repeats=0;
 
     for( unsigned i = 0; i < kids.size(); ++i )
     {
         if( kids[i].Type() == aType )
         {
             if( repeats == instanceNum )
                 return i;
 
             ++repeats;
         }
     }
 
     return -1;
 }

References DSN::ELEM_HOLDER::kids, and DSN::ELEM::Type().

◆ Format()

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

     {
         const char* quote = out->GetQuoteChar( padstack_id.c_str() );
 
         out->Print( nestLevel, "(%s %s%s%s\n",
                                Name(),
                                quote, padstack_id.c_str(), quote );
 
         FormatContents( out, nestLevel+1 );
 
         out->Print( nestLevel, ")\n" );
     }

References FormatContents(), OUTPUTFORMATTER::GetQuoteChar(), DSN::ELEM::Name(), padstack_id, and OUTPUTFORMATTER::Print().

◆ FormatContents()

void DSN::PADSTACK::FormatContents	(	OUTPUTFORMATTER *	out,
		int	nestLevel
	)

inlineoverridevirtual

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 from DSN::ELEM_HOLDER.

Definition at line 2187 of file specctra.h.

     {
         if( unit )
             unit->Format( out, nestLevel );
 
         // format the kids, which in this class are the shapes
         ELEM_HOLDER::FormatContents( out, nestLevel );
 
         out->Print( nestLevel, "%s", "" );
 
         // spec for <attach_descriptor> says default is on, so
         // print the off condition to override this.
         if( attach == T_off )
         {
             out->Print( 0, "(attach off)" );
         }
         else if( attach == T_on )
         {
             const char* quote = out->GetQuoteChar( via_id.c_str() );
 
             out->Print( 0, "(attach on (use_via %s%s%s))",
                            quote, via_id.c_str(), quote );
         }
 
         if( rotate == T_off )   // print the non-default
             out->Print( 0, "(rotate %s)", GetTokenText( rotate ) );
 
         if( absolute == T_on )  // print the non-default
             out->Print( 0, "(absolute %s)", GetTokenText( absolute ) );
 
         out->Print( 0, "\n" );
 
         if( rules )
             rules->Format( out, nestLevel );
     }

References absolute, attach, DSN::UNIT_RES::Format(), DSN::RULE::Format(), DSN::ELEM_HOLDER::FormatContents(), OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), OUTPUTFORMATTER::Print(), rotate, rules, unit, and via_id.

Referenced by Format().

◆ GetPadstackId()

const std::string& DSN::PADSTACK::GetPadstackId ( )

inline

Definition at line 2155 of file specctra.h.

     {
         return padstack_id;
     }

References padstack_id.

Referenced by DSN::LIBRARY::FindPADSTACK().

◆ GetUnits()

UNIT_RES* DSN::PADSTACK::GetUnits ( ) const

inlineoverridevirtual

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 from DSN::ELEM.

Definition at line 2224 of file specctra.h.

     {
         if( unit )
             return unit;
 
         return ELEM::GetUnits();
     }

References DSN::ELEM::GetUnits(), and unit.

◆ Insert()

void DSN::ELEM_HOLDER::Insert	(	int	aIndex,
		ELEM *	aElem
	)

inlineinherited

Definition at line 337 of file specctra.h.

     {
         kids.insert( kids.begin()+aIndex, aElem );
     }

References DSN::ELEM_HOLDER::kids.

◆ Length()

int DSN::ELEM_HOLDER::Length ( ) const

inlineinherited

Function Length returns the number of ELEMs in this ELEM.

Returns: int - the count of children

Definition at line 315 of file specctra.h.

     {
         return kids.size();
     }

References DSN::ELEM_HOLDER::kids.

Referenced by DSN::CONTROL::Format(), DSN::ELEM_HOLDER::FormatContents(), DSN::STRUCTURE::FormatContents(), and DSN::SPECCTRA_DB::makeVIA().

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

◆ operator[]()

ELEM* DSN::ELEM_HOLDER::operator[] ( int aIndex ) const

inlineinherited

Definition at line 349 of file specctra.h.

     {
         return At( aIndex );
     }

References DSN::ELEM_HOLDER::At().

◆ Remove()

ELEM* DSN::ELEM_HOLDER::Remove ( int aIndex )

inlineinherited

Definition at line 331 of file specctra.h.

     {
         ELEM_ARRAY::auto_type ret = kids.release( kids.begin()+aIndex );
         return ret.release();
     }

References DSN::ELEM_HOLDER::kids.

◆ Replace()

ELEM* DSN::ELEM_HOLDER::Replace	(	int	aIndex,
		ELEM *	aElem
	)

inlineinherited

Definition at line 325 of file specctra.h.

     {
         ELEM_ARRAY::auto_type ret = kids.replace( aIndex, aElem );
         return ret.release();
     }

References DSN::ELEM_HOLDER::kids.

◆ SetPadstackId()

void DSN::PADSTACK::SetPadstackId ( const char * aPadstackId )

inline

Definition at line 2167 of file specctra.h.

     {
         padstack_id = aPadstackId;
     }

References padstack_id.

Referenced by DSN::SPECCTRA_DB::makePADSTACK(), and DSN::SPECCTRA_DB::makeVia().

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

230 { return type; }

DSN::ELEM::type

DSN_T type

Definition: specctra.h:198

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

Member Data Documentation

◆ absolute

DSN_T DSN::PADSTACK::absolute

private

Definition at line 2126 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPADSTACK(), FormatContents(), and PADSTACK().

◆ attach

DSN_T DSN::PADSTACK::attach

private

Definition at line 2127 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPADSTACK(), FormatContents(), and PADSTACK().

◆ hash

std::string DSN::PADSTACK::hash

private

a hash string used by Compare(), not Format()ed/exported.

Definition at line 2118 of file specctra.h.

Referenced by Compare().

◆ padstack_id

std::string DSN::PADSTACK::padstack_id

private

Definition at line 2120 of file specctra.h.

Referenced by Compare(), DSN::SPECCTRA_DB::doPADSTACK(), Format(), GetPadstackId(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makeVIA(), and SetPadstackId().

◆ parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 199 of file specctra.h.

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

◆ rotate

DSN_T DSN::PADSTACK::rotate

private

Definition at line 2125 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPADSTACK(), FormatContents(), and PADSTACK().

◆ rules

RULE* DSN::PADSTACK::rules

private

Definition at line 2130 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPADSTACK(), FormatContents(), PADSTACK(), and ~PADSTACK().

◆ sf

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 221 of file specctra.h.

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

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

◆ unit

UNIT_RES* DSN::PADSTACK::unit

private

Definition at line 2121 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPADSTACK(), FormatContents(), GetUnits(), PADSTACK(), and ~PADSTACK().

◆ via_id

std::string DSN::PADSTACK::via_id

private

Definition at line 2128 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doPADSTACK(), and FormatContents().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PADSTACK()

◆ ~PADSTACK()

Member Function Documentation

◆ Append()

◆ At()

◆ Compare()

◆ Delete()

◆ FindElem()

◆ Format()

◆ FormatContents()

◆ GetPadstackId()

◆ GetUnits()

◆ Insert()

◆ Length()

◆ makeHash()

◆ Name()

◆ operator[]()

◆ Remove()

◆ Replace()

◆ SetPadstackId()

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

Member Data Documentation

◆ absolute

◆ attach

◆ hash

◆ padstack_id

◆ parent

◆ rotate

◆ rules

◆ sf

◆ type

◆ unit

◆ via_id