DSN::WIRE_VIA Class Reference

A <wire_via_descriptor> in the specctra dsn spec. More...

#include <specctra.h>

Inheritance diagram for DSN::WIRE_VIA:

Public Member Functions
	WIRE_VIA (ELEM *aParent)
const std::string &	GetPadstackId ()
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
DSN_T	type
ELEM *	parent

Static Protected Attributes
static STRING_FORMATTER	sf

Private Attributes
std::string	padstack_id
POINTS	vertexes
std::string	net_id
int	via_number
DSN_T	via_type
DSN_T	attr
std::string	virtual_pin_name
STRINGS	contact_layers
bool	supply

Friends
class	SPECCTRA_DB

Detailed Description

A <wire_via_descriptor> in the specctra dsn spec.

Definition at line 2989 of file specctra.h.

Constructor & Destructor Documentation

WIRE_VIA()

DSN::WIRE_VIA::WIRE_VIA ( ELEM *  aParent )

inline

Definition at line 2992 of file specctra.h.

 :
 ELEM( T_via, aParent )
 {
 via_number = -1;
 via_type = T_NONE;
 attr = T_NONE;
 supply = false;
 }

References attr, supply, via_number, and via_type.

Member Function Documentation

Format()

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

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

 const int RIGHTMARGIN = 80;
 int perLine = out->Print( nestLevel, "(%s %s%s%s", Name(), quote, padstack_id.c_str(),
 quote );

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

 perLine += out->Print( 0, "%.6g %.6g", i->x, i->y );
 }

 if( net_id.size() || via_number!=-1 || via_type!=T_NONE || attr!=T_NONE || supply)
 out->Print( 0, " " );

 if( net_id.size() )
 {
 if( perLine > RIGHTMARGIN )
 {
 out->Print( 0, "\n" );
 perLine = out->Print( nestLevel+1, "%s", "" );
 }

 quote = out->GetQuoteChar( net_id.c_str() );
 perLine += out->Print( 0, "(net %s%s%s)", quote, net_id.c_str(), quote );
 }

 if( via_number != -1 )
 {
 if( perLine > RIGHTMARGIN )
 {
 out->Print( 0, "\n" );
 perLine = out->Print( nestLevel+1, "%s", "" );
 }

 perLine += out->Print( 0, "(via_number %d)", via_number );
 }

 if( via_type != T_NONE )
 {
 if( perLine > RIGHTMARGIN )
 {
 out->Print( 0, "\n" );
 perLine = out->Print( nestLevel+1, "%s", "" );
 }

 perLine += out->Print( 0, "(type %s)", GetTokenText( via_type ) );
 }

 if( attr != T_NONE )
 {
 if( perLine > RIGHTMARGIN )
 {
 out->Print( 0, "\n" );
 perLine = out->Print( nestLevel+1, "%s", "" );
 }

 if( attr == T_virtual_pin )
 {
 quote = out->GetQuoteChar( virtual_pin_name.c_str() );
 perLine += out->Print( 0, "(attr virtual_pin %s%s%s)", quote,
 virtual_pin_name.c_str(), quote );
 }
 else
 {
 perLine += out->Print( 0, "(attr %s)", GetTokenText( attr ) );
 }
 }

 if( supply )
 {
 if( perLine > RIGHTMARGIN )
 {
 out->Print( 0, "\n" );
 perLine = out->Print( nestLevel+1, "%s", "" );
 }

 perLine += out->Print( 0, "(supply)" );
 }

 if( contact_layers.size() )
 {
 out->Print( 0, "\n" );
 out->Print( nestLevel+1, "(contact\n" );

 for( STRINGS::iterator i = contact_layers.begin(); i != contact_layers.end(); ++i )
 {
 quote = out->GetQuoteChar( i->c_str() );
 out->Print( nestLevel+2, "%s%s%s\n", quote, i->c_str(), quote );
 }

 out->Print( nestLevel+1, "))\n" );
 }
 else
 {
 out->Print( 0, ")\n" );
 }
 }

References attr, contact_layers, OUTPUTFORMATTER::GetQuoteChar(), DSN::GetTokenText(), DSN::ELEM::Name(), net_id, padstack_id, OUTPUTFORMATTER::Print(), supply, vertexes, via_number, via_type, and virtual_pin_name.

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

GetPadstackId()

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

inline

Definition at line 3001 of file specctra.h.

 {
 return padstack_id;
 }

References padstack_id.

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

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(), DSN::NET::Format(), DSN::CLASS::Format(), DSN::WIRE::Format(), 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.

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

Member Data Documentation

attr

DSN_T DSN::WIRE_VIA::attr

private

Definition at line 3124 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRE_VIA(), Format(), and WIRE_VIA().

contact_layers

STRINGS DSN::WIRE_VIA::contact_layers

private

Definition at line 3126 of file specctra.h.

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

net_id

std::string DSN::WIRE_VIA::net_id

private

Definition at line 3121 of file specctra.h.

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

padstack_id

std::string DSN::WIRE_VIA::padstack_id

private

Definition at line 3119 of file specctra.h.

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

parent

ELEM* DSN::ELEM::parent

protectedinherited

Definition at line 276 of file specctra.h.

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

sf

STRING_FORMATTER DSN::ELEM::sf

staticprotectedinherited

Definition at line 273 of file specctra.h.

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

supply

bool DSN::WIRE_VIA::supply

private

Definition at line 3127 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRE_VIA(), Format(), and WIRE_VIA().

type

DSN_T DSN::ELEM::type

protectedinherited

Definition at line 275 of file specctra.h.

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

vertexes

POINTS DSN::WIRE_VIA::vertexes

private

Definition at line 3120 of file specctra.h.

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

via_number

int DSN::WIRE_VIA::via_number

private

Definition at line 3122 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRE_VIA(), Format(), and WIRE_VIA().

via_type

DSN_T DSN::WIRE_VIA::via_type

private

Definition at line 3123 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doWIRE_VIA(), Format(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::makeVIA(), and WIRE_VIA().

virtual_pin_name

std::string DSN::WIRE_VIA::virtual_pin_name

private

Definition at line 3125 of file specctra.h.

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

---

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

• specctra.h