KiCad PCB EDA Suite
|
A <library_descriptor> in the specctra dsn specification. More...
#include <specctra.h>
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 |
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.
Definition at line 2260 of file specctra.h.
References unit.
|
inline |
|
inline |
Definition at line 2272 of file specctra.h.
References padstacks, and DSN::ELEM::SetParent().
Referenced by DSN::SPECCTRA_DB::doLIBRARY(), and DSN::SPECCTRA_DB::FromBOARD().
|
inline |
Add the image to the image list.
Definition at line 2321 of file specctra.h.
References images, and DSN::ELEM::SetParent().
Referenced by LookupIMAGE().
|
inline |
Add the padstack to the padstack container.
Definition at line 2375 of file specctra.h.
References padstacks, and DSN::ELEM::SetParent().
|
inline |
Add aVia to the internal via container.
Definition at line 2365 of file specctra.h.
References DSN::ELEM::SetParent(), and vias.
Referenced by DSN::SPECCTRA_DB::FromBOARD(), and LookupVia().
|
inline |
Search this LIBRARY for an image which matches the argument.
Definition at line 2294 of file specctra.h.
References DSN::IMAGE::Compare(), DSN::IMAGE::duplicated, DSN::IMAGE::image_id, and images.
Referenced by LookupIMAGE().
|
inline |
Search the padstack container by name.
Definition at line 2405 of file specctra.h.
References DSN::PADSTACK::GetPadstackId(), and padstacks.
|
inline |
Search this LIBRARY for a via which matches the argument.
Definition at line 2351 of file specctra.h.
References DSN::PADSTACK::Compare(), and vias.
Referenced by LookupVia().
|
virtualinherited |
Write this object as ASCII out to an OUTPUTFORMATTER according to the SPECCTRA DSN format.
out | The formatter to write to. |
nestLevel | A multiple of the number of spaces to precede the output with. |
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.
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().
|
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.
out | The formatter to write to. |
nestLevel | A multiple of the number of spaces to precede the output with. |
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.
References DSN::UNIT_RES::Format(), images, padstacks, unit, and vias.
|
inlineoverridevirtual |
Return the units for this section.
Derived classes may override this to check for section specific overrides.
Reimplemented from DSN::ELEM.
Definition at line 2433 of file specctra.h.
References DSN::ELEM::GetUnits(), and unit.
Add the image only if one exactly like it does not already exist in the image container.
Definition at line 2333 of file specctra.h.
References AppendIMAGE(), FindIMAGE(), and images.
Referenced by DSN::SPECCTRA_DB::FromBOARD().
Add the via only if one exactly like it does not already exist in the padstack container.
Definition at line 2387 of file specctra.h.
References AppendVia(), FindVia(), and vias.
Referenced by DSN::SPECCTRA_DB::FromBOARD().
|
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.
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().
|
inherited |
Definition at line 3760 of file specctra.cpp.
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().
|
inlineinherited |
Definition at line 247 of file specctra.h.
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().
|
inlineinherited |
Definition at line 210 of file specctra.h.
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().
|
friend |
Definition at line 2442 of file specctra.h.
|
private |
Definition at line 2445 of file specctra.h.
Referenced by AppendIMAGE(), DSN::SPECCTRA_DB::doLIBRARY(), FindIMAGE(), FormatContents(), and LookupIMAGE().
|
private |
all except vias, which are in 'vias'
Definition at line 2447 of file specctra.h.
Referenced by AddPadstack(), AppendPADSTACK(), FindPADSTACK(), and FormatContents().
|
protectedinherited |
Definition at line 276 of file specctra.h.
Referenced by DSN::ELEM::GetUnits(), and DSN::ELEM::SetParent().
|
staticprotectedinherited |
Definition at line 273 of file specctra.h.
Referenced by DSN::ELEM::makeHash().
|
protectedinherited |
Definition at line 275 of file specctra.h.
Referenced by DSN::UNIT_RES::Format(), DSN::ELEM::Name(), and DSN::ELEM::Type().
|
private |
Definition at line 2444 of file specctra.h.
Referenced by DSN::SPECCTRA_DB::doLIBRARY(), FormatContents(), GetUnits(), LIBRARY(), and ~LIBRARY().
|
private |
Definition at line 2448 of file specctra.h.
Referenced by AppendVia(), FindVia(), FormatContents(), DSN::SPECCTRA_DB::FromBOARD(), and LookupVia().