A <library_descriptor> in the specctra dsn specification. More...

#include <specctra.h>

Inheritance diagram for DSN::LIBRARY:

Public Member Functions
	LIBRARY (ELEM *aParent, DSN_T aType=T_library)

	~LIBRARY ()

void	AddPadstack (PADSTACK *aPadstack)

int	FindIMAGE (IMAGE *aImage)
	Search this LIBRARY for an image which matches the argument. More...

void	AppendIMAGE (IMAGE *aImage)
	Add the image to the image list. More...

IMAGE *	LookupIMAGE (IMAGE *aImage)
	Add the image only if one exactly like it does not already exist in the image container. More...

int	FindVia (PADSTACK *aVia)
	Search this LIBRARY for a via which matches the argument. More...

void	AppendVia (PADSTACK *aVia)
	Add aVia to the internal via container. More...

void	AppendPADSTACK (PADSTACK *aPadstack)
	Add the padstack to the padstack container. More...

PADSTACK *	LookupVia (PADSTACK *aVia)
	Add the via only if one exactly like it does not already exist in the padstack container. More...

PADSTACK *	FindPADSTACK (const std::string &aPadstackId)
	Search the padstack container by name. More...

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

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

DSN_T	Type () const

const char *	Name () const

virtual void	Format (OUTPUTFORMATTER *out, int nestLevel)
	Write this object 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
UNIT_RES *	unit

IMAGES	images

PADSTACKS	padstacks
	all except vias, which are in 'vias' More...

PADSTACKS	vias

Friends
class	SPECCTRA_DB

Detailed Description

A <library_descriptor> in the specctra dsn specification.

Only unit_descriptor, image_descriptors, and padstack_descriptors are included as children at this time.

Definition at line 2257 of file specctra.h.

Constructor & Destructor Documentation

◆ LIBRARY()

DSN::LIBRARY::LIBRARY	(	ELEM *	aParent,
		DSN_T	aType = `T_library`
	)

inline

Definition at line 2260 of file specctra.h.

 :
 ELEM( aType, aParent )
 {
 unit = 0;
// via_start_index = -1; // 0 or greater means there is at least one via
 }

References unit.

◆ ~LIBRARY()

DSN::LIBRARY::~LIBRARY ( )

inline

Definition at line 2267 of file specctra.h.

 {
 delete unit;
 }

References unit.

Member Function Documentation

◆ AddPadstack()

void DSN::LIBRARY::AddPadstack ( PADSTACK * aPadstack )

inline

Definition at line 2272 of file specctra.h.

 {
 aPadstack->SetParent( this );
 padstacks.push_back( aPadstack );
 }

References padstacks, and DSN::ELEM::SetParent().

Referenced by DSN::SPECCTRA_DB::doLIBRARY(), and DSN::SPECCTRA_DB::FromBOARD().

◆ AppendIMAGE()

void DSN::LIBRARY::AppendIMAGE ( IMAGE * aImage )

inline

Add the image to the image list.

Definition at line 2321 of file specctra.h.

 {
 aImage->SetParent( this );
 images.push_back( aImage );
 }

References images, and DSN::ELEM::SetParent().

Referenced by LookupIMAGE().

◆ AppendPADSTACK()

void DSN::LIBRARY::AppendPADSTACK ( PADSTACK * aPadstack )

inline

Add the padstack to the padstack container.

Definition at line 2375 of file specctra.h.

 {
 aPadstack->SetParent( this );
 padstacks.push_back( aPadstack );
 }

References padstacks, and DSN::ELEM::SetParent().

◆ AppendVia()

void DSN::LIBRARY::AppendVia ( PADSTACK * aVia )

inline

Add aVia to the internal via container.

Definition at line 2365 of file specctra.h.

 {
 aVia->SetParent( this );
 vias.push_back( aVia );
 }

References DSN::ELEM::SetParent(), and vias.

Referenced by DSN::SPECCTRA_DB::FromBOARD(), and LookupVia().

◆ FindIMAGE()

int DSN::LIBRARY::FindIMAGE ( IMAGE * aImage )

inline

Search this LIBRARY for an image which matches the argument.

Returns: index of image if found, else -1.

Definition at line 2294 of file specctra.h.

 {
 unsigned i;
 
 for( i=0; i<images.size(); ++i )
 {
 if( 0 == IMAGE::Compare( aImage, &images[i] ) )
 return (int) i;
 }
 
 // There is no match to the IMAGE contents, but now generate a unique
 // name for it.
 int dups = 1;
 
 for( i=0; i<images.size(); ++i )
 {
 if( 0 == aImage->image_id.compare( images[i].image_id ) )
 aImage->duplicated = dups++;
 }
 
 return -1;
 }

References DSN::IMAGE::Compare(), DSN::IMAGE::duplicated, DSN::IMAGE::image_id, and images.

Referenced by LookupIMAGE().

◆ FindPADSTACK()

PADSTACK * DSN::LIBRARY::FindPADSTACK ( const std::string & aPadstackId )

inline

Search the padstack container by name.

Returns: The PADSTACK with a matching name if it exists, else nullptr.

Definition at line 2405 of file specctra.h.

 {
 for( unsigned i = 0; i < padstacks.size(); ++i )
 {
 PADSTACK* ps = &padstacks[i];
 
 if( ps->GetPadstackId().compare( aPadstackId ) == 0 )
 return ps;
 }
 
 return nullptr;
 }

References DSN::PADSTACK::GetPadstackId(), and padstacks.

◆ FindVia()

int DSN::LIBRARY::FindVia ( PADSTACK * aVia )

inline

Search this LIBRARY for a via which matches the argument.

Returns: the index found in the padstack list, else -1.

Definition at line 2351 of file specctra.h.

 {
 for( unsigned i = 0; i < vias.size(); ++i )
 {
 if( 0 == PADSTACK::Compare( aVia, &vias[i] ) )
 return int( i );
 }
 
 return -1;
 }

References DSN::PADSTACK::Compare(), and vias.

Referenced by LookupVia().

◆ Format()

void DSN::ELEM::Format	(	OUTPUTFORMATTER *	out,
		int	nestLevel
	)

virtualinherited

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 in DSN::UNIT_RES, DSN::RECTANGLE, DSN::RULE, DSN::LAYER_RULE, DSN::PATH, DSN::BOUNDARY, DSN::CIRCLE, DSN::QARC, DSN::WINDOW, DSN::KEEPOUT, DSN::VIA, DSN::CONTROL, DSN::LAYER, DSN::SPECCTRA_LAYER_PAIR, DSN::LAYER_NOISE_WEIGHT, DSN::TOKPROP, DSN::STRINGPROP, DSN::GRID, DSN::PLACE, DSN::COMPONENT, DSN::SHAPE, DSN::PIN, DSN::IMAGE, DSN::PADSTACK, DSN::FROMTO, DSN::COMP_ORDER, DSN::NET, DSN::CLASS, DSN::WIRE, DSN::WIRE_VIA, DSN::PCB, DSN::ANCESTOR, DSN::SUPPLY_PIN, DSN::NET_OUT, and DSN::SESSION.

Definition at line 3774 of file specctra.cpp.

{
 out->Print( nestLevel, "(%s\n", Name() );
 
 FormatContents( out, nestLevel+1 );
 
 out->Print( nestLevel, ")\n" );
}

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

Referenced by DSN::WINDOW::Format(), DSN::KEEPOUT::Format(), DSN::CONTROL::Format(), DSN::PLACE::Format(), DSN::SHAPE::Format(), DSN::CLASS::Format(), DSN::WIRE::Format(), DSN::PCB::Format(), DSN::SESSION::Format(), DSN::ELEM_HOLDER::FormatContents(), DSN::CLASS_CLASS::FormatContents(), DSN::STRUCTURE::FormatContents(), and DSN::ROUTE::FormatContents().

◆ FormatContents()

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

inlineoverridevirtual

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

Definition at line 2418 of file specctra.h.

 {
 if( unit )
 unit->Format( out, nestLevel );
 
 for( IMAGES::iterator i = images.begin(); i != images.end(); ++i )
 i->Format( out, nestLevel );
 
 for( PADSTACKS::iterator i = padstacks.begin(); i != padstacks.end(); ++i )
 i->Format( out, nestLevel );
 
 for( PADSTACKS::iterator i = vias.begin(); i != vias.end(); ++i )
 i->Format( out, nestLevel );
 }

References DSN::UNIT_RES::Format(), images, padstacks, unit, and vias.

◆ GetUnits()

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

inlineoverridevirtual

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

Definition at line 2433 of file specctra.h.

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

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

◆ LookupIMAGE()

IMAGE * DSN::LIBRARY::LookupIMAGE ( IMAGE * aImage )

inline

Add the image only if one exactly like it does not already exist in the image container.

Returns: the IMAGE which is registered in the LIBRARY that matches the argument, and it will be either the argument or a previous image which is a duplicate.

Definition at line 2333 of file specctra.h.

 {
 int ndx = FindIMAGE( aImage );
 
 if( ndx == -1 )
 {
 AppendIMAGE( aImage );
 return aImage;
 }
 
 return &images[ndx];
 }

References AppendIMAGE(), FindIMAGE(), and images.

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

◆ LookupVia()

PADSTACK * DSN::LIBRARY::LookupVia ( PADSTACK * aVia )

inline

Add the via only if one exactly like it does not already exist in the padstack container.

Returns: the PADSTACK which is registered in the LIBRARY that matches the argument, and it will be either the argument or a previous padstack which is a duplicate.

Definition at line 2387 of file specctra.h.

 {
 int ndx = FindVia( aVia );
 
 if( ndx == -1 )
 {
 AppendVia( aVia );
 return aVia;
 }
 
 return &vias[ndx];
 }

References AppendVia(), FindVia(), and vias.

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

◆ 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(), 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 AddPadstack(), DSN::KEEPOUT::AddWindow(), AppendIMAGE(), AppendPADSTACK(), 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; }

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

Member Data Documentation

◆ images

IMAGES DSN::LIBRARY::images

private

Definition at line 2445 of file specctra.h.

Referenced by AppendIMAGE(), DSN::SPECCTRA_DB::doLIBRARY(), FindIMAGE(), FormatContents(), and LookupIMAGE().

◆ padstacks

PADSTACKS DSN::LIBRARY::padstacks

private

all except vias, which are in 'vias'

Definition at line 2447 of file specctra.h.

Referenced by AddPadstack(), AppendPADSTACK(), FindPADSTACK(), and FormatContents().

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

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

◆ unit

UNIT_RES* DSN::LIBRARY::unit

private

Definition at line 2444 of file specctra.h.

Referenced by DSN::SPECCTRA_DB::doLIBRARY(), FormatContents(), GetUnits(), LIBRARY(), and ~LIBRARY().

◆ vias

PADSTACKS DSN::LIBRARY::vias

private

Definition at line 2448 of file specctra.h.

Referenced by AppendVia(), FindVia(), FormatContents(), DSN::SPECCTRA_DB::FromBOARD(), and LookupVia().

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

◆ LIBRARY()

◆ ~LIBRARY()

Member Function Documentation

◆ AddPadstack()

◆ AppendIMAGE()

◆ AppendPADSTACK()

◆ AppendVia()

◆ FindIMAGE()

◆ FindPADSTACK()

◆ FindVia()

◆ Format()

◆ FormatContents()

◆ GetUnits()

◆ LookupIMAGE()

◆ LookupVia()

◆ makeHash()

◆ Name()

◆ SetParent()

◆ Type()

Friends And Related Function Documentation

◆ SPECCTRA_DB

Member Data Documentation

◆ images

◆ padstacks

◆ parent

◆ sf

◆ type

◆ unit

◆ vias